Using the routing service
Your routing app can do things like:
- Calculate point-to-point and multi- stop
A stop is a single point along a route: it can be the origin, an intermediate stop, or destination. routesA route is a polyline that defines the best path between two or more points in a street network. - Optimize the results to find the shortest or the fastest route
- Find the best sequence between stops
A stop is a single point along a route: it can be the origin, an intermediate stop, or destination. - Create routes based on the travel mode
A travel mode is the means of transportation, such as walking or driving, that defines how you can travel in a street network. (driving, cycling, walking, and so on) - Avoid restricted areas and maneuvers
- Specify time windows of arrival and departure for each stop
A stop is a single point along a route: it can be the origin, an intermediate stop, or destination. - Generate driving directions in multiple languages
What is routing?
Routing is the process of finding the best path between two or more stops
In addition to the routing described above, functionality is provided to analyze street networks. This includes the ability to create service areas
Directions
If requested, directions are returned for each route
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
If supported by the service
Navigation
The navigation API allows you to further enhance the routing experience using the current device location
The route tracker object provides the following functionality using the current device location
- Progress information relative to the next stop
A stop is a single point along a route: it can be the origin, an intermediate stop, or destination. , 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
A route is a polyline that defines the best path between two or more points in a street network. if the device locationA location is a position or region (point, line, or polygon) on the earth's surface. 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
Network Analyst services
You can create a transportation network using ArcGIS Pro.mmpk), a mobile scene package.mspk), or a mobile geodatabase
If you’d like a ready-to-use and regularly updated network dataset (and locator
Route task
A route task is a network analysis task that is executed asynchronously
The RouteTask refers to the local transportation network dataset or online service. If solves a Route using the configured RouteParameters and reports the RouteResult.
/// Initializes the route task with the online routing service. let routeTask = RouteTask(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
To initially create RouteParameters, call RouteTask.makeDefaultParameters() to retrieve the default routing parameters defined for the service. You can then change individual route parameters as needed before executing the RouteTask. The service’s default parameters typically support the most common use case anticipated for that service. Different services can have different defaults.
// Retrieves the default route parameters from the service. let parameters = try await routeTask.makeDefaultParameters()
// Sets relevant parameters. For example, returns driving directions in Spanish. parameters.returnsDirections = true parameters.directionsLanguage = "es"
// Adds stops. parameters.setStops(stops)Route results
The results returned from finding a route
// Solves the route using the given parameters. let routeResult = try await routeTask.solveRoute(using: parameters) guard let route = routeResult.routes.first else { return } // Creates a route symbol to display on the route graphics overlay. let routeSymbol = SimpleLineSymbol(style: .solid, color: .yellow, width: 5) // Shows the resulting route on the map. let routeGraphic = Graphic(geometry: route.geometry, symbol: routeSymbol) routeGraphicsOverlay.addGraphic(routeGraphic)
// Displays the driving directions route.directionManeuvers.forEach { maneuver in print(maneuver.text, separator: "\n") }Examples
Find a route and directions
Use the routing service
To find a route, you need to define at least two stops to visit. The default travel mode
The result contains a set of ordered stops
75 collapsed lines
import ArcGISimport SwiftUI
private class Model: ObservableObject { let map: Map = { let map = Map(basemapStyle: .arcGISNavigation) map.initialViewpoint = Viewpoint( latitude: 45.526201, longitude: -122.65, scale: 144447.638572 ) return map }()
/// A graphic to symbolize the start point of the route. let originGraphic: Graphic = { let symbol = SimpleMarkerSymbol(style: .circle, color: .white, size: 12) symbol.outline = SimpleLineSymbol(style: .solid, color: .black, width: 2) let graphic = Graphic(geometry: nil, symbol: symbol) return graphic }()
/// A graphic to symbolize a midway stop of the route. let stopGraphic: Graphic = { let symbol = SimpleMarkerSymbol(style: .circle, color: .white, size: 8) symbol.outline = SimpleLineSymbol(style: .solid, color: .black, width: 2) let graphic = Graphic(geometry: nil, symbol: symbol) return graphic }()
/// A graphic to symbolize the end point of the route. let destinationGraphic: Graphic = { let symbol = SimpleMarkerSymbol(style: .circle, color: .black, size: 12) symbol.outline = SimpleLineSymbol(style: .solid, color: .white, width: 2) let graphic = Graphic(geometry: nil, symbol: symbol) return graphic }()
/// A graphic to symbolize the route polyline. let routeGraphic: Graphic = { let symbol = SimpleLineSymbol(style: .solid, color: .systemBlue, width: 4) let graphic = Graphic(geometry: nil, symbol: symbol) return graphic }()
/// A graphics overlay to display the route. let routeGraphicsOverlay = GraphicsOverlay()
/// The route task to solve the route between stops, using the online routing service. let routeTask = RouteTask(url: URL(string: "https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World")!)
/// Stops to demo route solving. let demoStops = [ Stop(point: Point(x: -122.690176, y: 45.522054, spatialReference: .wgs84)), // origin Stop(point: Point(x: -122.614995, y: 45.526201, spatialReference: .wgs84)), // stop Stop(point: Point(x: -122.68782, y: 45.51238, spatialReference: .wgs84)) // destination ]
/// Sets the geometries and adds graphics to the graphics overlay. func makeGraphics() { originGraphic.geometry = demoStops[0].geometry stopGraphic.geometry = demoStops[1].geometry destinationGraphic.geometry = demoStops[2].geometry // Adds the graphic to the graphics overlay. routeGraphicsOverlay.addGraphics([ originGraphic, stopGraphic, destinationGraphic, routeGraphic ]) }
func solveRoute(stops: [Stop]) async throws {
let parameters = try await routeTask.makeDefaultParameters() // Sets up additional route parameters. parameters.setStops(stops) parameters.returnsDirections = true parameters.directionsLanguage = "es" // Solves the route. let routeResult = try await routeTask.solveRoute(using: parameters) // Displays route and print directions. guard let solvedRoute = routeResult.routes.first else { return } routeGraphic.geometry = solvedRoute.geometry print(solvedRoute.directionManeuvers.map { $0.text }.joined(separator: "\n"))21 collapsed lines
}}
struct RouteExampleView: View { // Creates a `StateObject` of the `Model` class. @StateObject private var model = Model()
var body: some View { // Creates a map view with the model's map and graphics overlay. MapView(map: model.map, graphicsOverlays: [model.routeGraphicsOverlay]) .task { model.makeGraphics() do { try await model.solveRoute(stops: model.demoStops) } catch { print(error) } } }}
