LocationWindow class abstract

@ingroup navigine_dart_classes @ingroup navigine_dart_location_view

@brief Interface for interacting with the location view.

Referenced from @see LocationView "LocationView".

Implemented types
Implementers

Constructors

LocationWindow()

Properties

camera ↔ Camera
@brief Current camera position in meters. @see Camera "Camera".
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
maxZoomFactor ↔ double
@brief Maximum zoom level for the location view (pixels per meter).
getter/setter pair
minZoomFactor ↔ double
@brief Minimum zoom level for the location view (pixels per meter).
getter/setter pair
pickRadius ↔ double
@brief Radius for picking features on the map, in density-independent pixels. Default: 0.5 dp.
getter/setter pair
rotateGestureEnabled ↔ bool
@brief 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
@brief Specifies whether scroll gestures (e.g., pan gesture) are enabled.
getter/setter pair
selectedMapFeatures → List<String>
@brief List of currently selected map feature IDs.
no setter
stickToBorder ↔ bool
@brief 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
@brief Specifies whether tilt gestures (e.g., two-finger parallel pan) are enabled.
getter/setter pair
zoomFactor ↔ double
@brief 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
@brief Specifies whether zoom gestures (e.g., two-finger pinch) are enabled.
getter/setter pair

Methods

addCameraListener(CameraListener listener) → void
@brief Adds a CameraListener to receive camera movement events. @param listener The CameraListener instance @see CameraListener "CameraListener". @note Remove the listener when no longer needed.
addCircleMapObject() → CircleMapObject
@brief Creates and adds a circle map object to the location view. @return A CircleMapObject instance @see CircleMapObject "CircleMapObject" if successful, null otherwise.
addDottedPolylineMapObject() → DottedPolylineMapObject
@brief Creates and adds a polyline points map object to the location view. @return A DottedPolylineMapObject instance @see DottedPolylineMapObject "DottedPolylineMapObject" if successful, null otherwise.
addIconMapObject() → IconMapObject
@brief Creates and adds an icon map object to the location view. @return An IconMapObject instance @see IconMapObject "IconMapObject" if successful, null otherwise.
addInputListener(InputListener listener) → void
@brief Adds an InputListener to receive input events. @param listener The InputListener instance @see InputListener "InputListener". @note Remove the listener when no longer needed.
addPickListener(PickListener listener) → void
@brief Adds a PickListener to receive picking result events. @param listener The PickListener instance @see PickListener "PickListener". @note Remove the listener when no longer needed.
addPolygonMapObject() → PolygonMapObject
@brief Creates and adds a polygon map object to the location view. @return A PolygonMapObject instance @see PolygonMapObject "PolygonMapObject" if successful, null otherwise.
addPolylineMapObject() → PolylineMapObject
@brief Creates and adds a polyline map object to the location view. @return A PolylineMapObject instance @see PolylineMapObject "PolylineMapObject" if successful, null otherwise.
addSublocationChangeListener(SublocationChangeListener listener) → void
@brief Adds listener for sublocation change events. @param listener Sublocation change listener @see SublocationChangeListener "SublocationChangeListener".
applyFilter(String filter, String layer) → void
@brief Applies a filter to a specific map layer. @param filter The filter stringю @param layer The map layer to apply the filter to.
deselectAllMapFeatures() → void
@brief Deselects all currently selected map features.
deselectMapFeature(String featureId) → bool
@brief Deselects a map feature by its feature ID. @param featureId The feature ID from the mapFeaturePickResult @see PickListener "PickListener". @return true if the operation is successful, false otherwise.
flyTo(Camera camera, int duration, CameraCallback callback) → void
@brief Moves the map camera to a new position with an easing animation. @param camera The new camera position @see Camera "Camera". @param duration Animation duration in milliseconds. @param callback Callback to execute when the animation completes @see CameraCallback "CameraCallback".
getEnclosingCamera(BoundingBox boundingBox) → Camera
@brief Calculates camera that fits provided bounding box. @param boundingBox Metrics bounding box to enclose.
getSublocationId() → int?
@brief Returns current sublocation ID if set, otherwise null.
metersToScreenPosition(Point point, bool clipToViewport) → Point<double>
@brief Converts metrics coordinates (meters) to screen coordinates (pixels). @param point (x,y) coordinates in meters @see Point "Point". @param clipToViewport If true, coordinates outside the viewport are clipped to the viewport edge. @return (x,y) coordinates in screen pixels.
moveTo(Camera camera, int duration, AnimationType animationType, CameraCallback callback) → void
@brief Moves the map camera to a new position with a smooth pan-and-zoom animation. @param camera The new camera position @see Camera "Camera". @param duration Animation duration in milliseconds (-1 for default duration). @param animationType The type of easing animation @see AnimationType "AnimationType". @param callback Callback to execute when the animation completes @see CameraCallback "CameraCallback".
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pickMapFeatureAt(Point<double> point) → void
@brief Selects visible map features (e.g., venues) at the specified screen position. @param point Position in screen pixels to pick from. Results are delivered to the PickListener via onMapFeaturePickComplete @see PickListener "PickListener".
pickMapObjectAt(Point<double> point) → void
@brief Selects a visible, interactive map object at the specified screen position. @param point Position in screen pixels to pick from. Results are delivered to the PickListener via onMapObjectPickComplete @see PickListener "PickListener".
removeAllMapObjects() → void
@brief Removes all map objects from the location view.
removeCameraListener(CameraListener listener) → void
@brief Removes a previously added CameraListener. @param listener The CameraListener instance to remove @see CameraListener "CameraListener".
removeCircleMapObject(CircleMapObject circleMapObject) → bool
@brief Removes a circle map object from the location view. @param circleMapObject The circle map object instance @see CircleMapObject "CircleMapObject". @return true if the operation is successful, false otherwise.
removeDottedPolylineMapObject(DottedPolylineMapObject dottedPolylineMapObject) → bool
@brief Removes a polyline points map object from the location view. @param dottedPolylineMapObject The polyline points map object instance @see DottedPolylineMapObject "DottedPolylineMapObject". @return true if the operation is successful, false otherwise.
removeIconMapObject(IconMapObject iconMapObject) → bool
@brief Removes an icon map object from the location view. @param iconMapObject The icon map object instance @see IconMapObject "IconMapObject". @return true if the operation is successful, false otherwise.
removeInputListener(InputListener listener) → void
@brief Removes a previously added InputListener. @param listener The InputListener instance to remove @see InputListener "InputListener".
removePickListener(PickListener listener) → void
@brief Removes a previously added PickListener. @param listener The PickListener instance to remove @see PickListener "PickListener".
removePolygonMapObject(PolygonMapObject polygonMapObject) → bool
@brief Removes a polygon map object from the location view. @param polygonMapObject The polygon map object instance @see PolygonMapObject "PolygonMapObject". @return true if the operation is successful, false otherwise.
removePolylineMapObject(PolylineMapObject polylineMapObject) → bool
@brief Removes a polyline map object from the location view. @param polylineMapObject The polyline map object instance @see PolylineMapObject "PolylineMapObject". @return true if the operation is successful, false otherwise.
removeSublocationChangeListener(SublocationChangeListener listener) → void
@brief Removes previously added sublocation change listener. @param listener Listener instance to remove @see SublocationChangeListener "SublocationChangeListener".
screenPositionToMeters(Point<double> point) → Point
@brief Converts screen coordinates (pixels) to metrics coordinates (meters). @param point (x,y) coordinates in screen pixels. @return (x,y) coordinates in meters @see Point "Point".
selectMapFeature(String featureId) → bool
@brief Selects a map feature by its feature ID. @param featureId The feature ID from the mapFeaturePickResult @see PickListener "PickListener". @return true if the operation is successful, false otherwise.
setSublocationId(int id) → void
@brief Method is used to switch the location view between sublocations (e.g., floors). @param id Sublocation unique identifier @see Sublocation "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
@brief Gets the state of a debug flag. @param flag The debug flag to query @see DebugFlag "DebugFlag". @return true if the debug flag is enabled, false otherwise.
setDebugFlag(DebugFlag flag, bool on) → void
@brief Sets the state of a debug flag. @param flag The debug flag to set @see DebugFlag "DebugFlag". @param on Specifies whether the debug flag is enabled (true) or disabled (false).