arcgis-maps-kotlin/com.arcgismaps.navigation/TrackingStatus

TrackingStatus

Defines route tracking current status data Contains information about route tracker status. Subscribe to RouteTrackerTrackingStatusChangedEvent for getting all updates in the event model.

Properties

approachingFinalDestination

val approachingFinalDestination: Boolean

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.getSkipCoincidentStops() value determines if they are treated as single destination or not.

currentManeuverIndex

val currentManeuverIndex: Int

The current maneuver index. The index of current maneuver in Route.getDirectionManeuvers().

destinationProgress

val destinationProgress: TrackingProgress

destinationStatus

val destinationStatus: DestinationStatus

The destination status.

displayLocation

val displayLocation: Location

isOnRoute

val isOnRoute: Boolean

Boolean indicating whether or not the current location is on the route.

isRouteCalculating

val isRouteCalculating: Boolean

Boolean indicating whether the route is currently being calculated. For getting event about route calculating start subscribe to RouteTrackerRerouteStartedEvent.

locationOnRoute

val locationOnRoute: Location

maneuverProgress

val maneuverProgress: TrackingProgress

remainingDestinationCount

val remainingDestinationCount: Int

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.

routeProgress

val routeProgress: TrackingProgress

routeResult

val routeResult: RouteResult

stopIndexesAtNextDestination

val stopIndexesAtNextDestination: List<Int>

The Route.getStops() index values relating to the upcoming destination/arrival. If there are coincident stops and the RouteTracker.getSkipCoincidentStops() = true this will return a list with multiple index values. When there are no coincident stops or the RouteTracker.getSkipCoincidentStops() = 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.getStops() array.