Hide Table of Contents
esri
arcgis
dijit
geometry
layers
renderer
symbols
tasks
Class: RouteTask
[ AMD Module Require | Legacy Module Require ]
Module Require
require(["esri/tasks/RouteTask", ... ], function(RouteTask, ... ){ ... });
Description
Class added 1.4
Solves a route on a route layer resource in a Network Analyst service exposed by the ArcGIS Server REST API. For more information on using RouteTask, see An overview of routing with the ArcGIS JavaScript API and Working with the RouteTask.
Solves a route on a route layer resource in a Network Analyst service exposed by the ArcGIS Server REST API. For more information on using RouteTask, see An overview of routing with the ArcGIS JavaScript API and Working with the RouteTask.
Samples
Search for samples that use this class.Class hierarchy
esri.tasks.RouteTask
Constructors
| Constructor | Description |
|---|---|
| new RouteTask(url) | Creates a new RouteTask object. |
Properties
| Property | Type | Description |
|---|---|---|
| url | String | URL to the ArcGIS Server REST resource that represents a network analysis service. To obtain the URL, use Services Directory. |
Methods
| Method | Return Value | Description |
|---|---|---|
| solve(params,callback?,errback?) | dojo.Deferred | Solves the route against the route layer with the route parameters. |
Events
[ On Style Events | Connect Style Events ]
All On Style event listeners receive a single event object. The event properties listed below are accessed from this event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
| On Event | Event Properties | Description |
|---|---|---|
| error | <Error> error | Fires when an error occurs when executing the task. Should be used in favor of onError. |
| solve-complete | <Object> result | Fires when RouteTask.solve() has completed. Should be used in favor of onSolveComplete |
Constructor Details
Creates a new RouteTask object.
Parameters:
| <String> url | Required | URL to the ArcGIS Server REST resource that represents a network analysis service. To obtain the URL, use Services Directory. |
Code Snippet:
require([
"esri/tasks/RouteTask", ...
], function(RouteTask, ... ) {
var routeTask = new RouteTask("http://tasks.arcgisonline.com/ArcGIS/rest/services/NetworkAnalysis/ESRI_Route_NA/NAServer/Route");
...
});
Property Details
URL to the ArcGIS Server REST resource that represents a network analysis service. To obtain the URL, use Services Directory.
Method Details
Solves the route against the route layer with the route parameters.
Return Value: dojo.Deferred
Input Parameters:
| <RouteParameters> params | Required | Route parameters used as input to generate the route. |
| <Function> callback | Optional | The function to call when the method has completed. The arguments in the function are the same as the onSolveComplete event. |
| <Function> errback | Optional | An error object is returned if an error occurs during task execution. |
Code Snippet:
require([
"esri/tasks/RouteParameters", "esri/tasks/FeatureSet", "esri/SpatialReference",
"esri/units", "dojo/_base/connect", ...
], function(RouteParameters, FeatureSet, SpatialReference, Units, connect, ... ) {
var routeParams = new RouteParameters();
routeParams.stops = new FeatureSet();
routeParams.returnRoutes = false;
routeParams.returnDirections = true;
routeParams.directionsLengthUnits = Units.MILES;
routeParams.outSpatialReference = new SpatialReference({ wkid:102100 });
connect.connect(routeTask, "onSolveComplete", showRoute);
...
});
See Also: onSolveComplete
Event Details
[ On Style Events | Connect Style Events ]
Fires when an error occurs when executing the task. Should be used in favor of onError. (Added at v3.5)
Event Properties:
| <Error> error | Error message returned in a JavaScript error object. |
Fires when RouteTask.solve() has completed. Should be used in favor of onSolveComplete (Added at v3.5)
Event Properties:
| <Object> result | At version 2.0 the signature changed to return an anonymous solveResult object. The solveResult object contains the following properties:
|
Code Snippet:
function showRoute(evt) {
var solveResult = evt.result;
var routeResults = solveResult.routeResults;
var barriers = solveResult.barriers;
var polygonBarriers = solveResult.polygonBarriers;
var polylineBarriers = solveResult.polylineBarriers;
var messages = solveResult.messages;
…
}