Navigator

This property tells whether the Navigator is navigating or not. Set this property to true to start the navigation. Set it to false to stop an active navigation session.

This property tells whether the Navigator should automatically recalculate the route when the position from positionSource ends too far from the route. The operation performed in such case is equivalent to calling recalculateRoutes. The default value is true.

These read-only properties are part of the directions property group. This property group holds the navigation progress information that can be used to access the route data and to extract directions.

• The nextManeuverIcon property holds the next turn icon.
• The distanceToNextManeuver property holds the distance to the next maneuver, in meters.
• The remainingTravelDistance property holds the remaining travel distance, in meters.
• The remainingTravelDistanceToNextWaypoint property holds the remaining travel distance to the next waypoint, in meters.
• The traveledDistance property holds the traveled distance, in meters.
• The timeToNextManeuver property holds the time to the next maneuver, in milliseconds.
• The remainingTravelTime property holds the remaining travel time, in milliseconds.
• The remainingTravelTimeToNextWaypoint property holds the remaining travel time to the next waypoint, in milliseconds.
• The traveledTime property holds the traveled time, in milliseconds.
• The currentRoute property holds the current route the navigator is following. This can be the same as route, or can be different, if the navigator cannot follow the user-specified route. For example, if the position coming from positionSource is considerably off route, the navigation engine may recalculate and start to follow a new route.
• The currentRouteLeg property holds the current route leg the navigator is following. This is always a part of currentRoute, so the overallRoute property of currentRouteLeg holds the same route as currentRoute.
• The currentSegment property holds the index of the current RouteSegment in the currentRoute.
• The alternativeRoutes property holds the list of alternative routes provided by the engine. If no alternative routes are present, the model will be empty.

See also directions.waypointReached(), directions.destinationReached(), Route, RouteLeg, RouteSegment, and Waypoint.

This read-only property holds the latest error value of the geocoding request.

While the Navigator is in active tracking mode, this property tells whether the position from positionSource is on the route or not.

This property holds the Map that the navigator is in charge of controlling.

This is a write-once property. Once the Navigator has a Map associated with it, any attempted modifications of the map property will be ignored.

See also Map.

This read-only property tells whether the navigator is ready to start the navigation or not. A Navigator becomes ready once the plugin is attached and a navigation engine has been instantiated, and the other required properties are set to valid values.

This property holds the plugin which provides the navigation functionality.

This is a write-once property. Once the Navigator has a plugin associated with it, any attempted modifications of the plugin property will be ignored.

See also Plugin.

This property holds the PositionSource that the navigator will receive position updates from to perform the navigation.

This is a write-once property. Once the Navigator has a PositionSource associated with it, any attempted modifications of the positionSource property will be ignored.

See also PositionSource.

This property holds the Route that the navigator is using to perform the navigation.

See also Route.

This property tells whether the Navigator should control the Map camera to keep track of position source updates. This property is enabled (true) by default, and setting it to false is useful in cases where e.g. the user starts gesturing over the map area.

Navigator plugins can also control this property directly e.g. user map interaction could trigger the property change. Honoring the user-specified value of this property is plugin dependent.

This signal is emitted when the last waypoint of the route, the destination, has been reached.

Note: The corresponding handler is directions.onDestinationReached.

See also directions and directions.waypointReached().

This signal is emitted when a waypoint has been reached.

Note: The corresponding handler is directions.onWaypointReached.

See also directions and directions.destinationReached().

Calling this method forces the backend to trigger a routes recalculation.

See also automaticReroutingEnabled.