Navigate a route

ArcGIS Runtime SDK can be used to provide a route and directions between two or more locations across a transportation network. The route result can include estimated travel time and distance, as well as driving directions for traversing the route. The navigation API allows you to further enhance the routing experience using the current device location to track progress and provide navigation instructions (maneuvers) as the user travels the route. You can integrate driving directions with your device's text-to-speech capability and automatically recalculate a new route when the user leaves the current one.

The AGSRouteTracker object provides the following functionality using the current device location and an appropriate route result:

  • Progress information relative to the next stop, to the next maneuver, or along the entire route
  • Guidance for navigation as it's needed (when approaching a maneuver, for example)
  • Automatic recalculation of a route if the device location goes off the route

The route result used for navigation must include stops and directions. To enable route recalculation while navigating, you must also provide the route task and routing parameters used to generate the route.

Track progress along a route

After a route has been calculated that includes at least two stops (a start location and one or more destinations) and driving directions, you can use the route tracker to track progress as the user traverses the route. To track the current device location, you must listen for location change events on the map view location display. As the device moves, pass the new location to the route tracker to update things such as the estimated remaining travel time and distance.

  1. Create a route and directions between specified locations. Generally, the route starts at the user's current location. When defining the route parameters be sure to include stops and driving directions in the results.

    Use dark colors for code blocksCopy
                                                                                                                                                     
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    
    // Get the default route parameters.
    self?.routeTask.defaultRouteParameters(completion: { [weak self] (params, error) -> Void in
     if let error = error {
      print(error)
      return
     }
     guard let params = params else {return}
     // Make sure to return stops and directions in the results.
     params.returnStops = true
     params.returnRoutes = true
     params.outputSpatialReference = self?.map.spatialReference
     self?.routeParameters = params
    })
    // Create the route using these parameters ...
    
  2. To show progress along a route, display two polylines: one to represent the portion of the route that has been traveled (from the start to the current location) and another to show the portion that remains (from the current location to the destination). Add these geometries to the map view as graphics (using distinct symbols) and update them from the AGSRouteTracker as the route changes.

    Use dark colors for code blocksCopy
                                                                                                                                                     
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    // Create a graphic to represent the route that remains to be traveled (initially the entire route).
    let routeAheadSymbol = AGSSimpleLineSymbol(style: .dash, color: .blue, width: 5)
    let routeAheadGraphic = AGSGraphic(geometry: routeGeometry, symbol: routeAheadSymbol, attributes: nil)
    
    // Create a graphic to represent the route that's been traveled (initially empty).
    let routeRemainsSymbol = AGSSimpleLineSymbol(style: .solid, color: .green, width: 3)
    let routeTraveledGraphic = AGSGraphic(geometry: nil, symbol: routeRemainsSymbol, attributes: nil)
    
  3. Create an AGSRouteTracker and pass in a route to travel. Handle the tracking status changed event to provide information such as the distance or time remaining to the destination. To update driving instructions when they are needed, handle the new voice guidance event.

    Use dark colors for code blocksCopy
                                                                                                                                                     
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    // Pass the route result to a new route tracker along with the index of the route to navigate.
    guard let routeTracker = AGSRouteTracker(routeResult: self.routeResult, routeIndex: 0) else {}
    
    //Adopt the AGSRouteTrackerDelegate protocol and ...
    
    // Implement the AGSRouteTrackerDelegate method didUpdate:
    // to be notified of changes to the tracking status
    func routeTracker(_ routeTracker: AGSRouteTracker, didUpdate trackingStatus: AGSTrackingStatus) {
     //Examine the routeTracker.trackingStatus
    }
    
    // Implement the AGSRouteTrackerDelegate method didGenerateNewVoiceGuidance:
    // to be notified of new voice guidance
    func routeTracker(_ routeTracker: AGSRouteTracker, didGenerateNewVoiceGuidance voiceGuidance: AGSVoiceGuidance) {
     guard !voiceGuidance.text.isEmpty else { return }
     //...
    }
    
  4. To enable rerouting, you must verify that the route task supports it. You must then provide the route task and parameters that were used to create the original route.

    Use dark colors for code blocksCopy
                                                                                                                                                     
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    // See if the route task supports rerouting when a user goes off-route.
    if routeTask.routeTaskInfo().supportsRerouting {
     // If supported, enable rerouting by passing in the route task and parameters, a routing strategy, and whether new routes should visit first stop.
     routeTracker.enableRerouting(with: self.routeTask, routeParameters: self.routeParameters, strategy: AGSReroutingStrategy.toNextWaypoint, visitFirstStopOnStart: false) { (error) in
      if let error = error {
       print(error)
       return
      }
      //rerouting enabled
     }
    }
    
    // Implement the AGSRouteTrackerDelegate method rerouteDidCompleteWith:
    // to be notified when a reroute has completed
    func routeTracker(_ routeTracker: AGSRouteTracker, rerouteDidCompleteWith trackingStatus: AGSTrackingStatus?, error: Error?) {
     if let error = error {
      print(error)
      return
     }
     //Display updated route graphic and report new status
    }
    
  5. Enable location display on the map view and handle device location updates by passing the new location to the AGSRouteTracker. The tracker will update the status when it gets a new location, including whether the user is off the route.

    Use dark colors for code blocksCopy
                                                                                                                                                     
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    // Enable location display to start receiving location events.
    self.mapView.locationDisplay.start { (error) in
    if let error = error {
     print(error)
     return
     }
    }
    
     // Implement the location changed handler for the map view location display.
     self.mapView.locationDisplay.locationChangedHandler = { [weak self] (change) in
    
      guard let position = change.position else {return}
    
      if self?.mapView.locationDisplay.autoPanMode != AGSLocationDisplayAutoPanMode.navigation {
      self?.mapView.setViewpoint(AGSViewpoint(center: position, scale: 5000))
      self?.mapView.locationDisplay.autoPanMode = AGSLocationDisplayAutoPanMode.navigation
     }
    
     // Use navigation tracker to update navigation status with the current location
     self?.routeTracker.trackLocation(change, completion: { (error) in
      if let error = error {
       print(error)
       return
      }
      //...
     })
    }
    
  6. In the tracking status changed event handler, create a status update for the user. This might be UI updates that include the travel time or distance remaining for the route or until the next maneuver (for example, a turn). You can also warn the user if they are off the route (especially if rerouting is not enabled). See the Report progress for more information about the types of progress provided by the route tracker.

    Use dark colors for code blocksCopy
                                                                                                                                                     
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
     // Implement the AGSRouteTrackerDelegate method didUpdate:
     // to be notified when the tracking status has changed
     func routeTracker(_ routeTracker: AGSRouteTracker, didUpdate trackingStatus: AGSTrackingStatus) {
    
      // Get the tracking status passed into the handler.
      let status = trackingStatus
    
      if (status.isOnRoute) {
    
       // Get the lines representing the route ahead and the route already traveled.
       let lineToTravel = status.routeProgress.remainingGeometry
       let lineTraveled = status.routeProgress.traversedGeometry
    
       // Update the route graphics.
       self.routeAheadGraphic.geometry = lineToTravel
       self.routeTraveledGraphic.geometry = lineTraveled
    
       //Print the remaining distance and time
       print("Distance remaining: \(status.routeProgress.remainingDistance.displayText) \(status.routeProgress.remainingDistance.displayTextUnits)")
       print("Time remaining: \(status.routeProgress.remainingTime)")
    
       } else {
      print("Off Route")
      }
     }
    
  7. Use the new voice guidance event handler to give driving instructions to the user. The voice guidance object that's passed into the event contains text that you can pass to a text-to-speech engine or use to update instructions shown in the UI.

    The following code handles the new voice guidance event to show instructions for the next maneuver.

    Use dark colors for code blocksCopy
                                                                                                                                                     
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
     // Implement the AGSRouteTrackerDelegate method didGenerateNewVoiceGuidance:
     // to be notified of new voice guidance
     func routeTracker(_ routeTracker: AGSRouteTracker, didGenerateNewVoiceGuidance voiceGuidance: AGSVoiceGuidance) {
     guard !voiceGuidance.text.isEmpty else { return }
     self.maneuverText = voiceGuidance.text
    }
    

    Example of an instruction for an approaching maneuver.

  8. If route recalculation is enabled, you can handle the route tracker's reroute completed event to update the route (a graphic, for example) displayed in the map view. See Handle rerouting for more information.

    Use dark colors for code blocksCopy
                                                                                                                                                     
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
     // Implement the AGSRouteTrackerDelegate method rerouteDidCompleteWith:
     // to be notified when a reroute has completed
     func routeTracker(_ routeTracker: AGSRouteTracker, rerouteDidCompleteWith trackingStatus: AGSTrackingStatus?, error: Error?) {
      if let error = error {
       print(error)
       return
      }
      // Get the geometry (polyline) for the recalculated route.
      let newRoutePolyline = trackingStatus?.routeResult.routes[0].routeGeometry
      // Update the "route ahead" graphic with the new line.
      routeAheadGraphic.geometry = newRoutePolyline
        }
    

Report progress

The route tracker's AGSTrackingStatus object provides values that you can use to report progress as the user traverses a route. This object is available from the AGSRouteTracker directly or when the tracking status changes, allowing you to evaluate route progress any time it changes. The basic status it provides is whether the user is still traveling the route. If rerouting is enabled for the tracker, a new route will be created whenever this value is false (if the current location is on the network).

The tracking status object also provides progress relative to the following parts of the route.

  • Destination — Describes progress to the next stop in the route
  • Maneuver — Describes progress to the next maneuver (driving instruction, for example)
  • Route — Describes progress along the entire route

Each of these types of progress is represented by the AGSTrackingProgress object with the following information:

  • Remaining distance — The distance remaining to the relevant location (next stop, next maneuver, or route end)
  • Remaining geometry — A polyline representing the portion of the route between the current location and the relevant location (next stop, next maneuver, or route end)
  • Remaining time — The time remaining to the relevant location (next stop, next maneuver, or route end)
  • Traversed geometry — A polyline representing the portion of the route between the start of the route and the current location

The tracking status also allows you access to the route that's being traversed. Using the current maneuver index, you can find the current maneuver from the route's list of directions.

Use dark colors for code blocksCopy
                                                                                                                                                 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 // Get the route object from the tracking status.
 var thisRoute = trackingStatus.routeResult.routes[0]

 // Get the current maneuver.
 var thisManeuver = thisRoute.directionManeuvers[trackingStatus.currentManeuverIndex]

Voice guidance

To give instructions to the user as they are approaching a maneuver, you can handle the new voice guidance event. Voice guidance notifications are generated at the time they are needed while traveling the route. You can use the text provided by the voice guidance to play the instruction (using an available text-to-speech engine), or to update driving instructions text in the UI.

The current speed, distance to the next maneuver, and the time required to enunciate an instruction are all considered when generating text for voice guidance. The driving directions text from the route and the distance to the maneuver can be used in the guidance, such as "in 300 meters, turn right on VENICE BLVD". Voice guidance text can be categorized as one of the following types of notifications:

  • Long — Occurring immediately after a maneuver starts to describe the next one, it is formatted using the full directions text. "Go straight along Main Street, and in one mile turn right on First Street", for example.
  • Moderate — Occurring 20 to 30 seconds before the maneuver, it is formatted using a parsed down form of the direction text. "In half a mile, turn right on First Street", for example.
  • Short — Occurring approximately 10 seconds before the maneuver, it is formatted using a terse form of the direction text. "Turn right on First Street", for example.
  • Combined — Two consecutive short maneuvers can be combined into a single voice guidance. "Turn right on First Street, then left", for example.

For any particular maneuver, one or more of these types of notifications can be generated. Abbreviations in directions text can be expanded when the voice guidance is created. "W Carolina destination is ahead" can be generated as "West Carolina destination is ahead", for example. Characters that are used it text directions, such as slashes, dashes, and so on, can be dropped from the voice guidance text.

Handle Rerouting

You can enable rerouting for a route tracker only if the underlying route data (online service or local dataset) supports rerouting. Currently, rerouting is only supported for routes created from a local network dataset. You can check the route task information to verify that rerouting is supported. If it is, you can enable rerouting on the route tracker. To enable rerouting, you need the following:

  • The original route task that was used to calculate the route used by the tracker

  • The original route task parameters used to calculate the tracker route

  • One of the following rerouting strategy values to use for the creation of new routes

    • Re-sequence stops only — Optimize the new route for the remaining stops.
    • To next stop — Reroute to the next unvisited stop in the original order.
    • To next waypoint — Reroute to the next unvisited waypoint, rest break, or stop.
  • Knowledge of whether the first stop in the route must be visited when creating the new route

You can cancel rerouting while a new route is being calculated and disable rerouting to turn that functionality off. Route tracker events allow you to respond when calculation of a new route begins and when it completes. You can use the completion event to display the new route in the map view.

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