solveRoute

Function

import { solveRoute } from '@esri/arcgis-rest-routing';
//
solveRoute({
  stops: [
    [-117.195677, 34.056383],
    [-117.918976, 33.812092],
   ],
   authentication
})
  .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}

Used to find the best way to get from one location to another or to visit several locations. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required ISolveRouteRequestOptions

Options to pass through to the routing service.

Available requestOptions

Property Type Notes
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

endpoint Optional Inherited string

Any ArcGIS Routing service (example: https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route/ ) to use for the routing service request.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited

Additional Headers to pass into the request.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

stops Array<IPoint | ILocation | [number, number] | [number, number, number]>

Specify two or more locations between which the route is to be found.

Returns

Promise<ISolveRouteResponse> - A Promise that will resolve with routes and directions for the request.

Property Type Notes
checksum string
directions Optional Array<{
features:
IFeature[]
routeId:
number
routeName:
string
summary:
object
}>
messages string[]
routes {
features:
IFeature[]
fieldAliases:
object
geometryType:
string
spatialReference:
ISpatialReference
}

Function defined in packages/arcgis-rest-routing/src/solveRoute.ts:61