Route and directions

Using the routing service, your own route services, or a route dataset stored on the device, you can find routes, directions, and perform advanced analyses on street networks. You can solve network problems such as finding the closest emergency vehicle or facility, identifying a service area around a location, or servicing a set of orders with a fleet of vehicles.

Your ArcGIS Runtime routing app can do things like:

• Calculate point-to-point and multi-stop routes
• Optimize the results to find the shortest or the fastest route
• Find the best sequence between stops
• Create routes based on the travel mode (driving, cycling, walking, and so on)
• Avoid restricted areas and maneuvers
• Specify time windows of arrival and departure for each stop
• Generate driving directions in multiple languages

What is routing?

Routing is the process of finding the best path between two or more stops in a street network. A common use case is to find a route between two stops, from an origin to a destination. Routing takes into consideration many different attributes in the street network such as speed limit, number of lanes, and time of day. Routing can also incorporate real-time data such as road conditions, accidents, street closures, and other restrictions to travel.

In addition to the routing described above, ArcGIS Runtime provides additional functionality for analyses with a streets network. This includes the ability to do things like create service areas (to find customers within a certain drive time, for example) or locate a closest facility (nearest hospital to an accident, for example).

Directions

If requested, directions are returned for each route in the results. Directions provide specific instructions for traveling the route. These are often referred to as "driving directions", but depending on the travel mode, could describe walking or cycling to the destination. Depending on the services configuration, directions can be returned in more than one language. Supported languages for a service are available in the service metadata.

Directions are composed of maneuvers. Each maneuver contains properties such as the direction text, which contains instructions that describe travel through a section of a route. A direction maneuver is further broken down into maneuver messages that give details about a specific maneuver.

If supported by the service, direction maneuver’s can include from level and to level values to define things like floor levels inside a building. For example, a user may want to see just one level of a walking route that spans multiple floors.

Navigation

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 route tracker 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 route

How routing works

Online and local routing both rely on a transportation network to model travel. These networks are created from features (lines and points) that represent roads, bridges, tunnels, bike paths, train tracks, and other entities in the network. The geometric intersections of features help to define connectivity between the network entities they represent. The connectivity of the transportation network, along with resistance to travel (speed limit, for example) and other network properties, is analyzed to solve routing problems.

Network Analyst services are hosted in ArcGIS or can be published on your own ArcGIS servers. These services provide a REST API for clients such as mobile and Web applications. For more information about publishing routing services with ArcGIS Enterprise, see Publish routing services.

You can create a transportation network using ArcGIS Pro and deploy it to your device using either a mobile map package file (.mmpk), a mobile scene package file (.mspk), or a mobile geodatabase file. The code to work with a local transportation network (stored directly on the device) is identical to the code for using a routing service.

If you'd like a ready-to-use and regularly updated network dataset (and locator) for your area of interest, you can license StreetMap Premium data (in mobile map package format). For details, see Add StreetMap Premium data.

Route task

A route task is a network analysis task that is executed asynchronously. It returns results with details about a route that visits two or more stops (locations) within a transportation network. This operation is sometimes referred to as solving a route.

The AGSRouteTask refers to the local transportation network dataset or online service. If solves a AGSRoute using the configured AGSRouteParameters and reports the AGSRouteResult .

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
    // Initialize route task
    self.routeTask = AGSRouteTask(url: URL(string: "https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World")!)

Route parameters

Route task parameters specify how a route should be found. There are many parameters that let you customize how the route is determined. Parameters include stops and barriers. Other parameters include travel mode, whether stops map be reordered to find an optimized route, the units to be used in the turn-by-turn directions (miles or kilometers, for example), and so on.

To initially create AGSRouteParameters , call AGSRouteTask.defaultRouteParametersWithCompletion:() to retrieve the default routing parameters defined for the service. You can then change individual route parameters as needed before executing the AGSRouteTask . The service's default parameters typically support the most common use case anticipated for that service. Different services can have different defaults.

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
    //Retrieve the default route parameters from the service
    self.routeTask.defaultRouteParameters { [weak self] (params: AGSRouteParameters?, error: Error?) in
      if let error = error {
        print(error.localizedDescription)
        return
      } else {
        guard let params = params else { return }

        // Set relevant parameters. For example,
        // return driving directions in Spanish
        params.returnDirections = true
        params.directionsLanguage = "es"

        // Add stops
        var stops = [AGSStop]()
        for graphic in self?.stopsGraphicsOverlay.graphics as! [AGSGraphic] {
          let stop = AGSStop(point: graphic.geometry as! AGSPoint)
          stops.append(stop)
        }
        params.setStops(stops)

Route results

The results returned from finding a route contain a collection of routes. Each route is represented by a polyline geometry and has information such as its total length and travel time. Depending on how you configured your route parameters, the results may also contain barriers, stops, and driving directions. Typically, the route, stops, and barriers are displayed as graphics in the map. Directions can be shown in a list or other UI element in the app.

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
    // Solve the route using the given parameters
    self.routeTask.solveRoute(with: params) {[weak self] (routeResult: AGSRouteResult?, error: Error?) in

      if let error = error {
        print(error.localizedDescription)
      } else {
        guard let route = routeResult?.routes.first else { return }

        // Show the resulting route on the map
        let routeGraphic = AGSGraphic(geometry: route.routeGeometry, symbol: self?.routeSymbol, attributes: nil)
        self?.routeGraphicsOverlay.graphics.add(routeGraphic)

        // Display the driving directions
        for maneuver in route.directionManeuvers {
          print("\r\n \(maneuver.directionText)")
        }
      }
    }

Examples

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
    func solveRoute(stops: [AGSStop]) {
        routeTask.defaultRouteParameters { [weak self] defaultParameters, error in
            guard let self = self else { return }
            if let params = defaultParameters {
                // Set up additional route parameters.
                params.setStops(stops)
                params.returnDirections = true
                params.directionsLanguage = "es"

                // Solve the route.
                self.routeTask.solveRoute(with: params) { routeResult, error in
                    if let solvedRoute = routeResult?.routes.first {
                        // Display route and print directions.
                        self.routeGraphic.geometry = solvedRoute.routeGeometry
                        print(solvedRoute.directionManeuvers.map { $0.directionText }.joined(separator: "\n"))
                    } else if let error = error {
                        print(error.localizedDescription)
                    }
                }
            } else if let error = error {
                print(error.localizedDescription)
            }
        }
    }

Use API key access tokens

An access token, provided by an API Key credential, can be used to authorize access to ArcGIS Online services and resources from your app, as well as to monitor access to those services. You can use a single access token for all requests made by your app, or assign individual access tokens for any classes that implements

Tutorials

Find a route and directions

Samples

Find route

Offline routing

Route around barriers

Display device location with autopan modes

Mobile map (search and route)

Find service area

Navigate route

Services

Next steps

• Try a tutorial

  Step-by-step code examples

• Visit the samples

  Learn what is possible

• Explore the API

  Read more about classes