Class is used to interact with the view. More...

Inherits Finalizable.

Public Member Functions
void	setSublocationId (int id)
	Method is used to switch location view between sublocations (floors).

Point	screenPositionToMeters (math.Point< double > point)
	Method is used to convert screen (pixels) coordinates to metrics coordinates.

CircleMapObject	addCircleMapObject ()
	Method is used to create and add circle map object to the location view.

bool	removeCircleMapObject (CircleMapObject circleMapObject)
	Method is used to remove circle map object from the location view.

IconMapObject	addIconMapObject ()
	Method is used to create and add icon map object to the location view.

bool	removeIconMapObject (IconMapObject iconMapObject)
	Method is used to remove icon map object from the location view.

FlatIconMapObject	addFlatIconMapObject ()
	Method is used to create and add flat icon map object to the location view.

bool	removeFlatIconMapObject (FlatIconMapObject flatIconMapObject)
	Method is used to remove flat icon map object from the location view.

PolygonMapObject	addPolygonMapObject ()
	Method is used to create and add polygon map object to the location view.

bool	removePolygonMapObject (PolygonMapObject polygonMapObject)
	Method is used to remove polygon map object from the location view.

PolylineMapObject	addPolylineMapObject ()
	Method is used to create and add polyline map object to the location view.

bool	removePolylineMapObject (PolylineMapObject polylineMapObject)
	Method is used to remove polyline map object from the location view.

void	removeAllMapObjects ()
	Method is used to remove all object from the location view.

void	pickMapObjectAt (math.Point< double > point)
	Method is used to select a visible map object marked as `interactive` MapObject. The result will be delivered to the `PickListener` by `onMapObjectPickComplete` PickListener.

void	pickMapFeatureAt (math.Point< double > point)
	Method is used to select a visible map features, such as venues etc. The result will be delivered to the `PickListener` by `onMapFeaturePickComplete` PickListener.

void	addPickListener (PickListener listener)
	Method is used to add PickListener class element which will notify all picking results events.

void	removePickListener (PickListener listener)
	Method is used for removing previously added PickListener class element.

void	addInputListener (InputListener listener)
	Method is used to add InputListener class element which will notify input events.

void	removeInputListener (InputListener listener)
	Method is used for removing previously added InputListener class element.

void	addCameraListener (CameraListener listener)
	Method is used to add CameraListener class element which will notify camera movements events.

void	removeCameraListener (CameraListener listener)
	Method is used for removing previously added CameraListener class element.

void	flyTo (Camera camera, int duration, CameraCallback callback)
	Move the map camera to a new position with an easing animation.

bool	selectMapFeature (String featureId)
	Selects a map feature with the specified featureId.

bool	deselectMapFeature (String featureId)
	Deselects a map feature with the specified featureId.

void	deselectAllMapFeatures ()
	Resets the currently selected map features.

void	moveTo (Camera camera, int duration, AnimationType animationType, CameraCallback callback)
	Move the map camera to a new position with an animation that pans and zooms in a smooth arc.

Public Attributes
double get	zoomFactor
	Parameter is used to change location view zoom. Value indicates count of pixels in 1 meter (default: approx 100m in screen width).

double get	minZoomFactor
	Minimum zoomFactor value (ZoomFactor parameter).

double get	maxZoomFactor
	Maximum zoomFactor value (ZoomFactor parameter).

bool get	stickToBorder
	Parameter is used to enable/disable sublocation content sticking to screen borders. If true image sticking to screen bounds, if false sticking to center of screen (Default: true).

Camera get	camera
	Current camera position in meters.

bool get	rotateGestureEnabled
	Parameter is used to enable/disable rotation gestures, such as rotation with two fingers.

bool get	tiltGesturesEnabled
	Parameter is used to enable/disable tilt gestures, such as parallel pan with two fingers.

bool get	scrollGesturesEnabled
	Parameter is used to enable/disable scroll gestures, such as the pan gesture.

bool get	zoomGesturesEnabled
	Parameter is used to enable/disable zoom gestures, such as the pinch with two fingers.

double get	pickRadius
	Radius to use when picking features on the map. The default radius is 0.5 dp (density-independent pixels).

List< String > get	selectedMapFeatures
	List of currently selected map features.

Detailed Description

Class is used to interact with the view.

Referenced from: LocationView,

Definition at line 36 of file location_window.dart.

Member Function Documentation

◆ addCameraListener()

void LocationWindow.addCameraListener ( CameraListener listener )

Method is used to add CameraListener class element which will notify camera movements events.

Note: Do not forget to remove listener if it is no longer needed!

Parameters

listener Сorresponding CameraListener listener class.

◆ addCircleMapObject()

CircleMapObject LocationWindow.addCircleMapObject ( )

Method is used to create and add circle map object to the location view.

Returns: CircleMapObject instance CircleMapObject if success, null otherwise.

◆ addFlatIconMapObject()

FlatIconMapObject LocationWindow.addFlatIconMapObject ( )

Method is used to create and add flat icon map object to the location view.

Returns: FlatIconMapObject instance FlatIconMapObject if success, null otherwise.

◆ addIconMapObject()

IconMapObject LocationWindow.addIconMapObject ( )

Method is used to create and add icon map object to the location view.

Returns: IconMapObject instance IconMapObject if success, null otherwise.

◆ addInputListener()

void LocationWindow.addInputListener ( InputListener listener )

Method is used to add InputListener class element which will notify input events.

Note: Do not forget to remove listener if it is no longer needed!

Parameters

listener Сorresponding InputListener listener class.

◆ addPickListener()

void LocationWindow.addPickListener ( PickListener listener )

Method is used to add PickListener class element which will notify all picking results events.

Note: Do not forget to remove listener if it is no longer needed!

Parameters

listener Сorresponding PickListener listener class.

◆ addPolygonMapObject()

PolygonMapObject LocationWindow.addPolygonMapObject ( )

Method is used to create and add polygon map object to the location view.

Returns: PolygonMapObject instance PolygonMapObject if success, null otherwise.

◆ addPolylineMapObject()

PolylineMapObject LocationWindow.addPolylineMapObject ( )

Method is used to create and add polyline map object to the location view.

Returns: PolylineMapObject instance PolylineMapObject if success, null otherwise.

◆ deselectAllMapFeatures()

void LocationWindow.deselectAllMapFeatures ( )

Resets the currently selected map features.

◆ deselectMapFeature()

bool LocationWindow.deselectMapFeature ( String featureId )

Deselects a map feature with the specified featureId.

Parameters

featureId featureId can be extracted from the mapFeaturePickResult container by using onMapFeaturePickComplete callback of PickListener.

Returns: true if success, false otherwise.

◆ flyTo()

void LocationWindow.flyTo	(	Camera	camera,
		int	duration,
		CameraCallback	callback )

Move the map camera to a new position with an easing animation.

Parameters

camera	The new camera position
duration	The animation duration in milliseconds
callback	completion callback to execute when the animation completes

◆ moveTo()

void LocationWindow.moveTo	(	Camera	camera,
		int	duration,
		AnimationType	animationType,
		CameraCallback	callback )

Move the map camera to a new position with an animation that pans and zooms in a smooth arc.

Note: The animation duration is calculated based on the distance to the new camera position and the specified speed

Parameters

camera	The new camera position
duration	Duration of the animation in milliseconds (-1 for default duration)
animationType	The type of easing animation
callback	A callback to execute when the animation completes

◆ pickMapFeatureAt()

void LocationWindow.pickMapFeatureAt ( math.Point< double > point )

Method is used to select a visible map features, such as venues etc. The result will be delivered to the PickListener by onMapFeaturePickComplete PickListener.

Parameters

point position in the view to pick from, in pixels.

◆ pickMapObjectAt()

void LocationWindow.pickMapObjectAt ( math.Point< double > point )

Method is used to select a visible map object marked as interactive MapObject. The result will be delivered to the PickListener by onMapObjectPickComplete PickListener.

Parameters

point position in the view to pick from, in pixels.

◆ removeAllMapObjects()

void LocationWindow.removeAllMapObjects ( )

Method is used to remove all object from the location view.

◆ removeCameraListener()

void LocationWindow.removeCameraListener ( CameraListener listener )

Method is used for removing previously added CameraListener class element.

Parameters

listener Сorresponding CameraListener class to remove.

◆ removeCircleMapObject()

bool LocationWindow.removeCircleMapObject ( CircleMapObject circleMapObject )

Method is used to remove circle map object from the location view.

Parameters

circleMapObject circle map object instance CircleMapObject.

Returns: true if success, false otherwise.

◆ removeFlatIconMapObject()

bool LocationWindow.removeFlatIconMapObject ( FlatIconMapObject flatIconMapObject )

Method is used to remove flat icon map object from the location view.

Parameters

flatIconMapObject flat icon map object instance FlatIconMapObject.

Returns: true if success, false otherwise.

◆ removeIconMapObject()

bool LocationWindow.removeIconMapObject ( IconMapObject iconMapObject )

Method is used to remove icon map object from the location view.

Parameters

iconMapObject icon map object instance IconMapObject.

Returns: true if success, false otherwise.

◆ removeInputListener()

void LocationWindow.removeInputListener ( InputListener listener )

Method is used for removing previously added InputListener class element.

Parameters

listener Сorresponding InputListener class to remove.

◆ removePickListener()

void LocationWindow.removePickListener ( PickListener listener )

Method is used for removing previously added PickListener class element.

Parameters

listener Сorresponding PickListener class to remove.

◆ removePolygonMapObject()

bool LocationWindow.removePolygonMapObject ( PolygonMapObject polygonMapObject )

Method is used to remove polygon map object from the location view.

Parameters

polygonMapObject polygon map object instance PolygonMapObject.

Returns: true if success, false otherwise.

◆ removePolylineMapObject()

bool LocationWindow.removePolylineMapObject ( PolylineMapObject polylineMapObject )

Method is used to remove polyline map object from the location view.

Parameters

polylineMapObject polyline map object instance PolylineMapObject.

Returns: true if success, false otherwise.

◆ screenPositionToMeters()

Point LocationWindow.screenPositionToMeters ( math.Point< double > point )

Method is used to convert screen (pixels) coordinates to metrics coordinates.

Parameters

point (x,y) point in screen pixels.

Returns: (x,y) point in meters coordinates Point.

◆ selectMapFeature()

bool LocationWindow.selectMapFeature ( String featureId )

Selects a map feature with the specified featureId.

Parameters

featureId featureId can be extracted from the mapFeaturePickResult container by using onMapFeaturePickComplete callback of PickListener.

Returns: true if success, false otherwise.

◆ setSublocationId()

void LocationWindow.setSublocationId ( int id )

Method is used to switch location view between sublocations (floors).

Parameters

id	sublocation unique identifier Sublocation.

Member Data Documentation

◆ camera

Camera get LocationWindow.camera

Current camera position in meters.

Definition at line 328 of file location_window.dart.

◆ maxZoomFactor

double get LocationWindow.maxZoomFactor

Maximum zoomFactor value (ZoomFactor parameter).

Definition at line 313 of file location_window.dart.

◆ minZoomFactor

double get LocationWindow.minZoomFactor

Minimum zoomFactor value (ZoomFactor parameter).

Definition at line 306 of file location_window.dart.

◆ pickRadius

double get LocationWindow.pickRadius

Radius to use when picking features on the map. The default radius is 0.5 dp (density-independent pixels).

Definition at line 363 of file location_window.dart.

◆ rotateGestureEnabled

bool get LocationWindow.rotateGestureEnabled

Parameter is used to enable/disable rotation gestures, such as rotation with two fingers.

Definition at line 335 of file location_window.dart.

◆ scrollGesturesEnabled

bool get LocationWindow.scrollGesturesEnabled

Parameter is used to enable/disable scroll gestures, such as the pan gesture.

Definition at line 349 of file location_window.dart.

◆ selectedMapFeatures

List<String> get LocationWindow.selectedMapFeatures

List of currently selected map features.

Definition at line 370 of file location_window.dart.

◆ stickToBorder

bool get LocationWindow.stickToBorder

Parameter is used to enable/disable sublocation content sticking to screen borders. If true image sticking to screen bounds, if false sticking to center of screen (Default: true).

Definition at line 321 of file location_window.dart.

◆ tiltGesturesEnabled

bool get LocationWindow.tiltGesturesEnabled

Parameter is used to enable/disable tilt gestures, such as parallel pan with two fingers.

Definition at line 342 of file location_window.dart.

◆ zoomFactor

double get LocationWindow.zoomFactor

Parameter is used to change location view zoom. Value indicates count of pixels in 1 meter (default: approx 100m in screen width).

Definition at line 299 of file location_window.dart.

◆ zoomGesturesEnabled

bool get LocationWindow.zoomGesturesEnabled

Parameter is used to enable/disable zoom gestures, such as the pinch with two fingers.

Definition at line 356 of file location_window.dart.

The documentation for this class was generated from the following file:

location_window.dart

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addCameraListener()

◆ addCircleMapObject()

◆ addFlatIconMapObject()

◆ addIconMapObject()

◆ addInputListener()

◆ addPickListener()

◆ addPolygonMapObject()

◆ addPolylineMapObject()

◆ deselectAllMapFeatures()

◆ deselectMapFeature()

◆ flyTo()

◆ moveTo()

◆ pickMapFeatureAt()

◆ pickMapObjectAt()

◆ removeAllMapObjects()

◆ removeCameraListener()

◆ removeCircleMapObject()

◆ removeFlatIconMapObject()

◆ removeIconMapObject()

◆ removeInputListener()

◆ removePickListener()

◆ removePolygonMapObject()

◆ removePolylineMapObject()

◆ screenPositionToMeters()

◆ selectMapFeature()

◆ setSublocationId()

Member Data Documentation

◆ camera

◆ maxZoomFactor

◆ minZoomFactor

◆ pickRadius

◆ rotateGestureEnabled

◆ scrollGesturesEnabled

◆ selectedMapFeatures

◆ stickToBorder

◆ tiltGesturesEnabled

◆ zoomFactor

◆ zoomGesturesEnabled