require(["esri/tasks/RouteTask"], function(RouteTask) { /* code goes here */ });
Class: esri/tasks/RouteTask
Inheritance: RouteTask Task Accessor
Since: ArcGIS API for JavaScript 4.0

Find routes between two or more locations and optionally get driving directions. The RouteTask uses ArcGIS Server network analysis services to calculate routes. Network analysis services allow you to solve simple routing problems as well as complex ones that take into account multiple stops, barriers, and time windows.

To work directly with the RouteTask, the basic pattern is:

  1. Create the task
  2. Configure the parameters
  3. Solve the route and then specify what to do with its results and handle any errors that may be returned.
See also:

Constructors

new RouteTask(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Object

The options to be used for data requests.

more details
more detailsTask
String

URL to the ArcGIS Server REST resource that represents a network analysis service.

more details
more detailsRouteTask

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

requestOptionsObject inherited

The options to be used for data requests. These options can also be controlled through the requestOptions method parameter.

URL to the ArcGIS Server REST resource that represents a network analysis service.

Method Overview

NameReturn TypeSummaryClass
Promise<RouteResult>

Solves the route against the route layer with the route parameters.

more details
more detailsRouteTask

Method Details

solve(params, requestOptions){Promise<RouteResult>}

Solves the route against the route layer with the route parameters.

Parameters:

Route parameters used as input to generate the route.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< RouteResult>When resolved, returns an instance of RouteResult.

API Reference search results

NameTypeModule

There were no match results from your search criteria.