RouteTracker QML Type

Returns the current status of the enableRerouting method (read-only).

See also Enums.TaskStatus.

Returns the voice guidance notification (read-only).

The most recent voice guidance based on the last trackLocation. It can be used to repeat last/latest voice guidance.

Return VoiceGuidance when newVoiceGuidanceResultChanged signal emits (read-only).

Return TrackingStatus when rerouteCompletedResultChanged signal emits (read-only).

Return error when rerouteFailedErrorChanged signal emits (read-only).

Returns whether routes are automatically regenerated when tracking status is off-route (read-only).

The index of Route in RouteResult to track.

The specified Route must contain Stops and Directions. This property can be set only during instantiation.

The route result that will be used for tracking. It must contain at least one route.

The property should be set before any other operations. By default route number is 0.

Note: Only one RouteResult can be set per-instance of RouteTracker. A new instance of RouteTracker must be created for each new RouteResult.

Returns if multiple stops in a row at the same location should treated as one stop. When true, if there are multiple stops in a row, at the same network location, the new voice guidance event will fire a single time. Calling switchToNextDestination will skip over the other coincident stops, setting the state to the next relevant direction maneuver. If the value is false, each stop will be treated as a unique destination. The default value for this property is true. If your route does not have coincident stops, the value of this property will have no effect.

This property can be set only during instantiation.

This property was introduced in Esri.ArcGISRuntime 100.9.

Sets a callback function to be called to determine if the text-to-speech engine is ready.

The function is called by RouteTracker internally before providing newVoiceGuidanceResult to check if the text-to-speech engine is busy. If it is busy it will postpone raising the voice guidance event until next time trackLocation is called.

This will be called internally by RouteTracker on a background thread.

Setting this is optional, and if this is not set RouteTracker assumes the speech engine is always ready so that no voice guidance messages are skipped.

The function provided must be callable and return true if the engine is ready, false otherwise.

This can be set or unset at any time.

Here is an example of usage.

RouteTracker {
    speechEngineReadyCallback: function() {
        return ttsEngine.textToSpeechEngineReady();
    }
}

Here is an example of unsetting this if you no longer want it to be used.

RouteTracker {
    speechEngineReadyCallback: undefined
}

By default no function is set.

This property was introduced in Esri.ArcGISRuntime 100.12.

Returns the current status of the switchToNextDestination method (read-only).

See also Enums.TaskStatus.

Returns the current status of the trackLocation method (read-only).

See also Enums.TaskStatus.

Returns the tracking status for the current location on the route (read-only).

Return TrackingStatus when trackingStatusResultChanged signal emits (read-only).

The unit system used in voice guidance commands.

Default value is Enums.UnitSystemMetric.

See also Enums.UnitSystem.

Emitted when the enableReroutingStatus property changes.

Note: The corresponding handler is onEnableReroutingStatusChanged.

Emitted when the newVoiceGuidanceResult property changes.

Note: The corresponding handler is onNewVoiceGuidanceResultChanged.

Emitted when the rerouteCompletedResult property changes.

Note: The corresponding handler is onRerouteCompletedResultChanged.

Emitted when the rerouteFailedError property changes.

Note: The corresponding handler is onRerouteFailedErrorChanged.

Emitted when background rerouting started.

Note: The corresponding handler is onRerouteStarted.

Emitted when the reroutingEnabled property changes.

Note: The corresponding handler is onReroutingEnabledChanged.

Emitted when the routeIndex property changes.

Note: The corresponding handler is onRouteIndexChanged.

Emitted when the routeResult property changes.

Note: The corresponding handler is onRouteResultChanged.

Emitted when the skipCoincidentStops property changes.

Note: The corresponding handler is onSkipCoincidentStopsChanged.

This signal was introduced in Esri.ArcGISRuntime 100.9.

Emitted when the speechEngineReadyCallback property changes.

Note: The corresponding handler is onSpeechEngineReadyCallbackChanged.

This signal was introduced in Esri.ArcGISRuntime 100.12.

Emitted when the switchToNextDestination property changes.

Note: The corresponding handler is onSwitchToNextDestinationStatusChanged.

Emitted when the trackLocationStatus property changes.

Note: The corresponding handler is onTrackLocationStatusChanged.

Emitted when the trackingStatusResult property changes.

Note: The corresponding handler is onTrackingStatusResultChanged.

Emitted when the voiceGuidanceUnitSystem property changes.

Note: The corresponding handler is onVoiceGuidanceUnitSystemChanged.

Cancels a running reroute task.

If rerouting is started this method will interrupt the rerouting background process.

Cancel the task with the ID taskId.

Returns false if the task cannot be canceled or there is no task with the specified id taskId.

See also Cancelable.

Disables automatic rerouting.

When disabled, the tracker will not automatically recalculate a route when the tracking status is off-route.

Enables automatic rerouting when the tracker detects an off-route status.

• parameters - A ReroutingParameters allow customizing background rerouting.

Rerouting only occurs when the current location is off-route, but on or near the transportation network edges. For example if an off-route state is detected, but the tracked location is in a parking lot, away from any transportation network edges, rerouting will not occur, and will occur only when a subsequent tracked location is on or near the transportation network edges.

Returns a string representing the task ID of the asynchronous task.

This method was introduced in Esri.ArcGISRuntime 100.11.

Starts tracking progress to the next destination in the Route.

Use switchToNextDestination when the tracker reports a Enums.DestinationStatusReached status. Before calling switchToNextDestination make sure that TrackingStatus.remainingDestinationCount > 1. A value of 1 means navigation is proceeding to last destination. This method can also be called after Enums.DestinationStatusApproaching in cases where the location cannot get near enough to the destination point for Enums.DestinationStatusReached (such as the center of a park or shopping center, for example).

The switchToNextDestinationStatusChanged signal is emitted when this operation is complete.

RouteTracker::trackLocation needs to be called at least once before calling this method; otherwise an error will be emitted. RouteTracker::trackLocation is needed for getting TrackingStatus and for handling visitFirstStopOnStart.

Provides route tracking status relative to the provided location.

The location generally comes from a GPS but may also be a simulated or manually entered location. It must have valid values for X and Y coordinates, speed (in meters per second), course (in degrees), and a timestamp. Events fired for RouteTracker and TrackingStatus returned when completed.

Method should be called each time a new position is received from the location source (usually once per second).

The trackLocationStatusChanged signal will emit when the operation is complete.

Provides route tracking status relative to the provided location.

The location generally comes from a GPS but may also be a simulated or manually entered Location. It must have valid values for X and Y coordinates, velocity (in meters per second), heading (in degrees), and a timestamp. When a new location is tracked the trackingStatusResultChanged signal will be emmited.

This method should be called each time a new position is received from the location source (usually once per second).

The trackLocationStatusChanged signal will emit when the operation is complete.

This method was introduced in Esri.ArcGISRuntime 100.8.