Route tracking status. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.6 |
| Inherits: |
Properties
- approachingFinalDestination : bool
- currentManeuverIndex : int
- destinationProgress : TrackingProgress
- destinationStatus : Enums.DestinationStatus
- displayLocation : Location
- locationOnRoute : Location
- maneuverProgress : TrackingProgress
- onRoute : bool
- remainingDestinationCount : int
- routeCalculating : bool
- routeProgress : TrackingProgress
- routeResult : RouteResult
- stopIndexesAtNextDestination : list<int>
Detailed Description
Used with the RouteTracker, this type contains a report of tracking status. It is returned from several tracking-related methods and signals to report the current tracking status.
Note: You cannot declare or create a component of this type in QML code.
Property Documentation
Returns true if the next Stop (or stops) are the final destination in the route (read-only).
If there are coincident stops at the end of the route, RouteTracker::skipCoincidentStops value determines if they are treated as single destination or not.
This property was introduced in Esri.ArcGISRuntime 100.9.
Returns the current maneuver index (read-only).
The index of current maneuver in Route.directionManeuvers.
destinationProgress : TrackingProgress |
Returns the tracking progress until next destination (stop) (read-only).
displayLocation : Location |
Returns the display location with position and bearing adjusted based on the route (read-only).
This is an adjusted location intended for displaying current location and bearing during navigation.
locationOnRoute : Location |
Returns the location on route (read-only).
This is the snapped-to-route location of the last GPS location passed in to RouteTracker.trackLocation.
- If onRoute is
true, this is the same as displayLocation. - If onRoute is
false, this is the last location that was on the route.
maneuverProgress : TrackingProgress |
Returns the tracking progress along current maneuver (read-only).
Returns the remaining destination count (read-only).
The number of stops yet to be visited. Uses count of stops that involved in route (ignoring not located stops and waypoints). Calling RouteTracker.switchToNextDestination will decrease value.
routeProgress : TrackingProgress |
Returns the tracking progress along entire route (read-only).
routeResult : RouteResult |
Returns the route result presently being used by route tracker (read-only).
If rerouting happened during tracking, this RouteResult can be different than the RouteResult originally set in the RouteTracker.
The Route::stops index values relating to the upcoming destination/arrival (read-only).
If there are coincident stops and the RouteTracker::skipCoincidentStops = true this will return a list with multiple index values. If there are no coincident stops or RouteTracker::skipCoincidentStops = false, this will return a list with a single index value. This list can be used to relate a destination/arrival to the stops in the Route::stops list.
This property was introduced in Esri.ArcGISRuntime 100.9.