Interface for interacting with the location view. More...

Inherits Finalizable.

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

Point	screenPositionToMeters (math.Point< double > point)
	Converts screen coordinates (pixels) to metrics coordinates (meters).

CircleMapObject	addCircleMapObject ()
	Creates and adds a circle map object to the location view.

bool	removeCircleMapObject (CircleMapObject circleMapObject)
	Removes a circle map object from the location view.

IconMapObject	addIconMapObject ()
	Creates and adds an icon map object to the location view.

bool	removeIconMapObject (IconMapObject iconMapObject)
	Removes an icon map object from the location view.

PolygonMapObject	addPolygonMapObject ()
	Creates and adds a polygon map object to the location view.

bool	removePolygonMapObject (PolygonMapObject polygonMapObject)
	Removes a polygon map object from the location view.

PolylineMapObject	addPolylineMapObject ()
	Creates and adds a polyline map object to the location view.

bool	removePolylineMapObject (PolylineMapObject polylineMapObject)
	Removes a polyline map object from the location view.

DottedPolylineMapObject	addDottedPolylineMapObject ()
	Creates and adds a polyline points map object to the location view.

bool	removeDottedPolylineMapObject (DottedPolylineMapObject dottedPolylineMapObject)
	Removes a polyline points map object from the location view.

void	removeAllMapObjects ()
	Removes all map objects from the location view.

void	pickMapObjectAt (math.Point< double > point)
	Selects a visible, interactive map object at the specified screen position.

void	pickMapFeatureAt (math.Point< double > point)
	Selects visible map features (e.g., venues) at the specified screen position.

void	addPickListener (PickListener listener)
	Adds a PickListener to receive picking result events.

void	removePickListener (PickListener listener)
	Removes a previously added PickListener.

void	addInputListener (InputListener listener)
	Adds an InputListener to receive input events.

void	removeInputListener (InputListener listener)
	Removes a previously added InputListener.

void	addCameraListener (CameraListener listener)
	Adds a CameraListener to receive camera movement events.

void	removeCameraListener (CameraListener listener)
	Removes a previously added CameraListener.

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

bool	selectMapFeature (String featureId)
	Selects a map feature by its feature ID.

bool	deselectMapFeature (String featureId)
	Deselects a map feature by its feature ID.

void	deselectAllMapFeatures ()
	Deselects all currently selected map features.

void	applyFilter (String filter, String layer)
	Applies a filter to a specific map layer.

void	moveTo (Camera camera, int duration, AnimationType animationType, CameraCallback callback)
	Moves the map camera to a new position with a smooth pan-and-zoom animation.

Static Public Member Functions
static void	setDebugFlag (DebugFlag flag, bool on)
	Sets the state of a debug flag.

static bool	getDebugFlag (DebugFlag flag)
	Gets the state of a debug flag.

Public Attributes
double get	zoomFactor
	Specifies the zoom level of the location view, in pixels per meter. Default: approximately 100 meters across the screen width.

double get	minZoomFactor
	Minimum zoom level for the location view (pixels per meter).

double get	maxZoomFactor
	Maximum zoom level for the location view (pixels per meter).

bool get	stickToBorder
	Specifies whether sublocation content sticks to screen borders. If true, content sticks to screen bounds; if false, content is centered. Default: true.

Camera get	camera
	Current camera position in meters. Camera.

bool get	rotateGestureEnabled
	Specifies whether rotation gestures (e.g., two-finger rotation) are enabled.

bool get	tiltGesturesEnabled
	Specifies whether tilt gestures (e.g., two-finger parallel pan) are enabled.

bool get	scrollGesturesEnabled
	Specifies whether scroll gestures (e.g., pan gesture) are enabled.

bool get	zoomGesturesEnabled
	Specifies whether zoom gestures (e.g., two-finger pinch) are enabled.

double get	pickRadius
	Radius for picking features on the map, in density-independent pixels. Default: 0.5 dp.

List< String > get	selectedMapFeatures
	List of currently selected map feature IDs.

Detailed Description

Interface for interacting with the location view.

Referenced from LocationView.

Definition at line 36 of file location_window.dart.

Member Function Documentation

◆ addCameraListener()

void LocationWindow.addCameraListener ( CameraListener listener )

Adds a CameraListener to receive camera movement events.

Parameters

listener The CameraListener instance CameraListener.

Note: Remove the listener when no longer needed.

◆ addCircleMapObject()

CircleMapObject LocationWindow.addCircleMapObject ( )

Creates and adds a circle map object to the location view.

Returns: A CircleMapObject instance CircleMapObject if successful, null otherwise.

◆ addDottedPolylineMapObject()

DottedPolylineMapObject LocationWindow.addDottedPolylineMapObject ( )

Creates and adds a polyline points map object to the location view.

Returns: A DottedPolylineMapObject instance DottedPolylineMapObject if successful, null otherwise.

◆ addIconMapObject()

IconMapObject LocationWindow.addIconMapObject ( )

Creates and adds an icon map object to the location view.

Returns: An IconMapObject instance IconMapObject if successful, null otherwise.

◆ addInputListener()

void LocationWindow.addInputListener ( InputListener listener )

Adds an InputListener to receive input events.

Parameters

listener The InputListener instance InputListener.

Note: Remove the listener when no longer needed.

◆ addPickListener()

void LocationWindow.addPickListener ( PickListener listener )

Adds a PickListener to receive picking result events.

Parameters

listener The PickListener instance PickListener.

Note: Remove the listener when no longer needed.

◆ addPolygonMapObject()

PolygonMapObject LocationWindow.addPolygonMapObject ( )

Creates and adds a polygon map object to the location view.

Returns: A PolygonMapObject instance PolygonMapObject if successful, null otherwise.

◆ addPolylineMapObject()

PolylineMapObject LocationWindow.addPolylineMapObject ( )

Creates and adds a polyline map object to the location view.

Returns: A PolylineMapObject instance PolylineMapObject if successful, null otherwise.

◆ applyFilter()

void LocationWindow.applyFilter	(	String	filter,
		String	layer )

Applies a filter to a specific map layer.

Parameters

filter	The filter stringю
layer	The map layer to apply the filter to.

Returns: true if the operation is successful, false otherwise.

◆ deselectAllMapFeatures()

void LocationWindow.deselectAllMapFeatures ( )

Deselects all currently selected map features.

◆ deselectMapFeature()

bool LocationWindow.deselectMapFeature ( String featureId )

Deselects a map feature by its feature ID.

Parameters

featureId The feature ID from the mapFeaturePickResult PickListener.

Returns: true if the operation is successful, false otherwise.

◆ flyTo()

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

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

Parameters

camera	The new camera position Camera.
duration	Animation duration in milliseconds.
callback	Callback to execute when the animation completes CameraCallback.

◆ getDebugFlag()

static bool LocationWindow.getDebugFlag ( DebugFlag flag )

static

Gets the state of a debug flag.

Parameters

flag	The debug flag to query DebugFlag.

Returns: true if the debug flag is enabled, false otherwise.

◆ moveTo()

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

Moves the map camera to a new position with a smooth pan-and-zoom animation.

Parameters

camera	The new camera position Camera.
duration	Animation duration in milliseconds (-1 for default duration).
animationType	The type of easing animation AnimationType.
callback	Callback to execute when the animation completes CameraCallback.

◆ pickMapFeatureAt()

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

Selects visible map features (e.g., venues) at the specified screen position.

Parameters

point Position in screen pixels to pick from ScreenPoint. Results are delivered to the PickListener via onMapFeaturePickComplete PickListener.

◆ pickMapObjectAt()

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

Selects a visible, interactive map object at the specified screen position.

Parameters

point Position in screen pixels to pick from ScreenPoint. Results are delivered to the PickListener via onMapObjectPickComplete PickListener.

◆ removeAllMapObjects()

void LocationWindow.removeAllMapObjects ( )

Removes all map objects from the location view.

◆ removeCameraListener()

void LocationWindow.removeCameraListener ( CameraListener listener )

Removes a previously added CameraListener.

Parameters

listener The CameraListener instance to remove CameraListener.

◆ removeCircleMapObject()

bool LocationWindow.removeCircleMapObject ( CircleMapObject circleMapObject )

Removes a circle map object from the location view.

Parameters

circleMapObject The circle map object instance CircleMapObject.

Returns: true if the operation is successful, false otherwise.

◆ removeDottedPolylineMapObject()

bool LocationWindow.removeDottedPolylineMapObject ( DottedPolylineMapObject dottedPolylineMapObject )

Removes a polyline points map object from the location view.

Parameters

dottedPolylineMapObject The polyline points map object instance DottedPolylineMapObject.

Returns: true if the operation is successful, false otherwise.

◆ removeIconMapObject()

bool LocationWindow.removeIconMapObject ( IconMapObject iconMapObject )

Removes an icon map object from the location view.

Parameters

iconMapObject The icon map object instance IconMapObject.

Returns: true if the operation is successful, false otherwise.

◆ removeInputListener()

void LocationWindow.removeInputListener ( InputListener listener )

Removes a previously added InputListener.

Parameters

listener The InputListener instance to remove InputListener.

◆ removePickListener()

void LocationWindow.removePickListener ( PickListener listener )

Removes a previously added PickListener.

Parameters

listener The PickListener instance to remove PickListener.

◆ removePolygonMapObject()

bool LocationWindow.removePolygonMapObject ( PolygonMapObject polygonMapObject )

Removes a polygon map object from the location view.

Parameters

polygonMapObject The polygon map object instance PolygonMapObject.

Returns: true if the operation is successful, false otherwise.

◆ removePolylineMapObject()

bool LocationWindow.removePolylineMapObject ( PolylineMapObject polylineMapObject )

Removes a polyline map object from the location view.

Parameters

polylineMapObject The polyline map object instance PolylineMapObject.

Returns: true if the operation is successful, false otherwise.

◆ screenPositionToMeters()

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

Converts screen coordinates (pixels) to metrics coordinates (meters).

Parameters

point (x,y) coordinates in screen pixels ScreenPoint.

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

◆ selectMapFeature()

bool LocationWindow.selectMapFeature ( String featureId )

Selects a map feature by its feature ID.

Parameters

featureId The feature ID from the mapFeaturePickResult PickListener.

Returns: true if the operation is successful, false otherwise.

◆ setDebugFlag()

static void LocationWindow.setDebugFlag	(	DebugFlag	flag,
		bool	on )

static

Sets the state of a debug flag.

Parameters

flag	The debug flag to set DebugFlag.
on	Specifies whether the debug flag is enabled (true) or disabled (false).

◆ setSublocationId()

void LocationWindow.setSublocationId ( int id )

Method is used to switch the location view between sublocations (e.g., floors).

Parameters

id	Sublocation unique identifier Sublocation.

Member Data Documentation

◆ camera

Camera get LocationWindow.camera

Current camera position in meters. Camera.

Definition at line 336 of file location_window.dart.

◆ maxZoomFactor

double get LocationWindow.maxZoomFactor

Maximum zoom level for the location view (pixels per meter).

Definition at line 320 of file location_window.dart.

◆ minZoomFactor

double get LocationWindow.minZoomFactor

Minimum zoom level for the location view (pixels per meter).

Definition at line 313 of file location_window.dart.

◆ pickRadius

double get LocationWindow.pickRadius

Radius for picking features on the map, in density-independent pixels. Default: 0.5 dp.

Definition at line 372 of file location_window.dart.

◆ rotateGestureEnabled

bool get LocationWindow.rotateGestureEnabled

Specifies whether rotation gestures (e.g., two-finger rotation) are enabled.

Definition at line 343 of file location_window.dart.

◆ scrollGesturesEnabled

bool get LocationWindow.scrollGesturesEnabled

Specifies whether scroll gestures (e.g., pan gesture) are enabled.

Definition at line 357 of file location_window.dart.

◆ selectedMapFeatures

List<String> get LocationWindow.selectedMapFeatures

List of currently selected map feature IDs.

Definition at line 379 of file location_window.dart.

◆ stickToBorder

bool get LocationWindow.stickToBorder

Specifies whether sublocation content sticks to screen borders. If true, content sticks to screen bounds; if false, content is centered. Default: true.

Definition at line 328 of file location_window.dart.

◆ tiltGesturesEnabled

bool get LocationWindow.tiltGesturesEnabled

Specifies whether tilt gestures (e.g., two-finger parallel pan) are enabled.

Definition at line 350 of file location_window.dart.

◆ zoomFactor

double get LocationWindow.zoomFactor

Specifies the zoom level of the location view, in pixels per meter. Default: approximately 100 meters across the screen width.

Definition at line 306 of file location_window.dart.

◆ zoomGesturesEnabled

bool get LocationWindow.zoomGesturesEnabled

Specifies whether zoom gestures (e.g., two-finger pinch) are enabled.

Definition at line 364 of file location_window.dart.

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

location_window.dart

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addCameraListener()

◆ addCircleMapObject()

◆ addDottedPolylineMapObject()

◆ addIconMapObject()

◆ addInputListener()

◆ addPickListener()

◆ addPolygonMapObject()

◆ addPolylineMapObject()

◆ applyFilter()

◆ deselectAllMapFeatures()

◆ deselectMapFeature()

◆ flyTo()

◆ getDebugFlag()

◆ moveTo()

◆ pickMapFeatureAt()

◆ pickMapObjectAt()

◆ removeAllMapObjects()

◆ removeCameraListener()

◆ removeCircleMapObject()

◆ removeDottedPolylineMapObject()

◆ removeIconMapObject()

◆ removeInputListener()

◆ removePickListener()

◆ removePolygonMapObject()

◆ removePolylineMapObject()

◆ screenPositionToMeters()

◆ selectMapFeature()

◆ setDebugFlag()

◆ setSublocationId()

Member Data Documentation

◆ camera

◆ maxZoomFactor

◆ minZoomFactor

◆ pickRadius

◆ rotateGestureEnabled

◆ scrollGesturesEnabled

◆ selectedMapFeatures

◆ stickToBorder

◆ tiltGesturesEnabled

◆ zoomFactor

◆ zoomGesturesEnabled