LocationWindow class abstract

Interface for interacting with the location view. Referenced from LocationView.

Implemented types
Implementers

Constructors

LocationWindow()

Properties

camera Camera
Current camera position in meters. Camera.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
maxZoomFactor double
Maximum zoom level for the location view (pixels per meter).
getter/setter pair
minZoomFactor double
Minimum zoom level for the location view (pixels per meter).
getter/setter pair
pickRadius double
Radius for picking features on the map, in density-independent pixels. Default: 0.5 dp.
getter/setter pair
rotateGestureEnabled bool
Specifies whether rotation gestures (e.g., two-finger rotation) are enabled.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollGesturesEnabled bool
Specifies whether scroll gestures (e.g., pan gesture) are enabled.
getter/setter pair
selectedMapFeatures List<String>
List of currently selected map feature IDs.
no setter
stickToBorder bool
Specifies whether sublocation content sticks to screen borders. If true, content sticks to screen bounds; if false, content is centered. Default: true.
getter/setter pair
tiltGesturesEnabled bool
Specifies whether tilt gestures (e.g., two-finger parallel pan) are enabled.
getter/setter pair
zoomFactor double
Specifies the zoom level of the location view, in pixels per meter. Default: approximately 100 meters across the screen width.
getter/setter pair
zoomGesturesEnabled bool
Specifies whether zoom gestures (e.g., two-finger pinch) are enabled.
getter/setter pair

Methods

addBuildingListener(BuildingListener listener) → void
Adds listener for outdoor scenario: when camera focuses on a building or leaves it. listener Indoor building listener BuildingListener.
addCameraListener(CameraListener listener) → void
Adds a CameraListener to receive camera movement events. Note: Remove the listener when no longer needed. listener The CameraListener instance CameraListener.
addCircleMapObject() CircleMapObject
Creates and adds a circle map object to the location view. Returns A CircleMapObject instance CircleMapObject if successful, null otherwise.
addDottedPolylineMapObject() DottedPolylineMapObject
Creates and adds a polyline points map object to the location view. Returns A DottedPolylineMapObject instance DottedPolylineMapObject if successful, null otherwise.
addIconMapObject() IconMapObject
Creates and adds an icon map object to the location view. Returns An IconMapObject instance IconMapObject if successful, null otherwise.
addInputListener(InputListener listener) → void
Adds an InputListener to receive input events. Note: Remove the listener when no longer needed. listener The InputListener instance InputListener.
addModelMapObject() ModelMapObject
Creates and adds a 3D model map object (Wavefront OBJ + texture via ModelProvider). Returns A ModelMapObject instance ModelMapObject if successful, null otherwise.
addPickListener(PickListener listener) → void
Adds a PickListener to receive picking result events. Note: Remove the listener when no longer needed. listener The PickListener instance PickListener.
addPolygonMapObject() PolygonMapObject
Creates and adds a polygon map object to the location view. Returns A PolygonMapObject instance PolygonMapObject if successful, null otherwise.
addPolylineMapObject() PolylineMapObject
Creates and adds a polyline map object to the location view. Returns A PolylineMapObject instance PolylineMapObject if successful, null otherwise.
addSublocationChangeListener(SublocationChangeListener listener) → void
Adds listener for sublocation change events. listener Sublocation change listener SublocationChangeListener.
applyLayerFilter(String layer, List<MapFilterCondition> conditions) → void
Applies a typed filter to a specific map layer. layer The map layer to apply the filter to. conditions List of conditions (property + allowed values). Empty list resets the filter (show all).
deselectAllMapFeatures() → void
Deselects all currently selected map features.
deselectMapFeature(String featureId) bool
Deselects a map feature by its feature ID. featureId The feature ID from the mapFeaturePickResult PickListener. Returns true if the operation is successful, false otherwise.
flyTo(Camera camera, int duration, CameraCallback callback) → void
Moves the map camera to a new position with an easing animation. camera The new camera position Camera. duration Animation duration in milliseconds. callback Callback to execute when the animation completes CameraCallback.
getEnclosingCamera(BoundingBox boundingBox) Camera
Calculates camera that fits provided bounding box. boundingBox Metrics bounding box to enclose.
getSublocationId() int?
Returns current sublocation ID if set, otherwise null.
metersToScreenPosition(Point point, bool clipToViewport) Point<double>
Converts metrics coordinates (meters) to screen coordinates (pixels). point (x,y) coordinates in meters Point. clipToViewport If true, coordinates outside the viewport are clipped to the viewport edge. Returns (x,y) coordinates in screen pixels.
moveTo(Camera camera, int duration, AnimationType animationType, CameraCallback callback) → void
Moves the map camera to a new position with a smooth pan-and-zoom animation. 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.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pickMapFeatureAt(Point<double> point) → void
Selects visible map features (e.g., venues) at the specified screen position. Results are delivered to the PickListener via onMapFeaturePickComplete PickListener. point Position in screen pixels to pick from.
pickMapObjectAt(Point<double> point) → void
Selects a visible, interactive map object at the specified screen position. Results are delivered to the PickListener via onMapObjectPickComplete PickListener. point Position in screen pixels to pick from.
removeAllMapObjects() → void
Removes all map objects from the location view.
removeBuildingListener(BuildingListener listener) → void
Removes previously added indoor building listener. listener Listener instance to remove BuildingListener.
removeCameraListener(CameraListener listener) → void
Removes a previously added CameraListener. listener The CameraListener instance to remove CameraListener.
removeCircleMapObject(CircleMapObject circleMapObject) bool
Removes a circle map object from the location view. circleMapObject The circle map object instance CircleMapObject. Returns true if the operation is successful, false otherwise.
removeDottedPolylineMapObject(DottedPolylineMapObject dottedPolylineMapObject) bool
Removes a polyline points map object from the location view. dottedPolylineMapObject The polyline points map object instance DottedPolylineMapObject. Returns true if the operation is successful, false otherwise.
removeIconMapObject(IconMapObject iconMapObject) bool
Removes an icon map object from the location view. iconMapObject The icon map object instance IconMapObject. Returns true if the operation is successful, false otherwise.
removeInputListener(InputListener listener) → void
Removes a previously added InputListener. listener The InputListener instance to remove InputListener.
removeModelMapObject(ModelMapObject modelMapObject) bool
Removes a model map object from the location view. modelMapObject The model instance to remove ModelMapObject. Returns true if the operation is successful, false otherwise.
removePickListener(PickListener listener) → void
Removes a previously added PickListener. listener The PickListener instance to remove PickListener.
removePolygonMapObject(PolygonMapObject polygonMapObject) bool
Removes a polygon map object from the location view. polygonMapObject The polygon map object instance PolygonMapObject. Returns true if the operation is successful, false otherwise.
removePolylineMapObject(PolylineMapObject polylineMapObject) bool
Removes a polyline map object from the location view. polylineMapObject The polyline map object instance PolylineMapObject. Returns true if the operation is successful, false otherwise.
removeSublocationChangeListener(SublocationChangeListener listener) → void
Removes previously added sublocation change listener. listener Listener instance to remove SublocationChangeListener.
screenPositionToMeters(Point<double> point) Point
Converts screen coordinates (pixels) to metrics coordinates (meters). point (x,y) coordinates in screen pixels. Returns (x,y) coordinates in meters Point.
selectMapFeature(String featureId) bool
Selects a map feature by its feature ID. featureId The feature ID from the mapFeaturePickResult PickListener. Returns true if the operation is successful, false otherwise.
setSublocationId(int id) → void
Method is used to switch the location view between sublocations (e.g., floors). id Sublocation unique identifier Sublocation.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

getDebugFlag(DebugFlag flag) bool
Gets the state of a debug flag. flag The debug flag to query DebugFlag. Returns true if the debug flag is enabled, false otherwise.
setDebugFlag(DebugFlag flag, bool on) → void
Sets the state of a debug flag. flag The debug flag to set DebugFlag. on Specifies whether the debug flag is enabled (true) or disabled (false).