RouteTrackerLocationDataSource QML Type

  • Esri.ArcGISRuntime
  • RouteTrackerLocationDataSource
  • A location data source that uses a route tracker and a generic location data source to output locations snapped to a route. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.9




    Detailed Description

    Setting the RouteTrackerLocationDataSource is optional when desiring to have the location display symbol navigate along a route. Using this object provides the benefit of having the current location snapped to the route polyline during navigation. If the RouteTrackerLocationDataSource is not used, you may notice that the actual GPS location tends to wander off the route polyline due to the accuracy provided by the GPS unit.

    No distance tolerance needs to be specified to enable the snapping effect of having the location display symbol follow along the route polyline. An internal algorithm is used by the RouteTrackerLocationDataSource to determine if location is 'on route' or 'off route'. If the location is seen as 'on route' then snapping will occur, otherwise the output location will be the original input GPS location. If it is determined that the tracking along the route is no longer needed the RouteTrackerLocationDataSource's stop method can be called or the LocationDisplay can be reset to a different data source.

    To provide some insight on how the RouteTrackerLocationDataSource works, the data source will pass the locations from the this data source's locationChanged locationChanged event to the RouteTracker::trackLocation. The TrackingStatus::displayLocation will then be returned in this data source's locationChanged event.

    To control the orientation of the location display symbol as it navigates along a route refer to the MapView::locationDisplay class.

    See also AbstractLocationDataSource.

    Property Documentation

    locationDataSource : AbstractLocationDataSource

    An AbstractLocationDataSource object.

    If no data source is provided, the platform's default source will be used

    Note: this property can only be set during instantiation.

    routeTracker : RouteTracker

    A RouteTracker object.

    Note: this property can only be set during instantiation.

    Signal Documentation


    Emitted when the locationDataSource property changes.

    Note: The corresponding handler is onLocationDataSourceChanged.


    Emitted when the routeTracker property changes.

    Note: The corresponding handler is onRouteTrackerChanged.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.