Tracking
Defines route tracking current status data. Contains information about route tracker status. Subscribe to RouteTrackerTrackingStatusChangedEvent for getting all updates in the event model.
Since
200.1.0
Properties
The current maneuver index. The index of current maneuver in Route.directionManeuvers.
The tracking progress until next destination (Stop).
The destination status.
The display location. If current location isOnRoute = true then this will be an adjusted location (snapped to route) and bearing (smoothed). If current location isOnRoute = false then this will be the passed in GPS location, but with an adjusted bearing (smoothed). This location should be used for displaying current position on a map.
The tracking progress until next event of current maneuver. This exposes the information about the progress towards the next event, such as remaining distance.
Returns true if the next Stop (or stops) are the final destination in the route. If there are coincident stops at the end the RouteTracker.skipCoincidentStops value determines if they are treated as single destination or not.
Boolean indicating whether the route is currently being calculated. For getting event about route calculating start subscribe to RouteTrackerRerouteStartedEvent.
The location on route. Snapped to route location of last GPS location passed in to RouteTracker.trackLocation. If current status is isOnRoute = true this will be the same as the TrackingStatus.displayLocation. If current status is isOnRoute = false this value is not updated and last location that was on the route will be returned.
The tracking progress along current maneuver.
The index of the next event of the current maneuver. The index of the next event in DirectionManeuver.directionEvents of the current maneuver. If there are no upcoming events to be voiced the value will be -1.
The index of the next event in DirectionManeuver.directionEvents of the current maneuver, or null if there are no upcoming events to be voiced.
The remaining destination count. The number of (routed) stops yet to be visited. This value does not include waypoints, unlocated/unrouted locations. Calling RouteTracker.switchToNextDestination will decrease value. The invalid value for remaining destination count is -1.
The remaining destination count, or null if the remaining count is invalid.
The tracking progress along entire route.
The route result presently being used by route tracker. If rerouting happened during tracking, this RouteResult can be different than the RouteResult originally set in the RouteTracker. For getting new route result from callback subscribe to RouteTrackerRerouteCompletedEvent.
The Route.stops index values relating to the upcoming destination/arrival. If there are coincident stops and the RouteTracker.skipCoincidentStops = true this will return a list with multiple index values. When there are no coincident stops or the RouteTracker.skipCoincidentStops = false this will return a list with just a single index value. This list can be used to relate a destination/arrival to the stops in the Route.stops array.