Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: RouteResult

require(["esri/tasks/RouteResult"], function(RouteResult) { /* code goes here */ });

Description

(Added at v1.4)
The result from the Route Task. The RouteResult properties are dependent on the RouteParameter inputs. For example, directions are only returned if RouteParameters.returnDirections is set to "true". RouteResult has no constructor.

Samples

Search for samples that use this class.

Properties

NameTypeSummary
directionsDirectionsFeatureSetRoute directions are returned if RouteParameters.returnDirections is set to true.
routeGraphicThe Route graphic that is returned if RouteParameters.returnRoutes is true.
routeNameStringThe name of the route.
stopsGraphic[]Array of stops.
Property Details
Route directions are returned if RouteParameters.returnDirections is set to true.

NOTE: For a more updated approach to working with directions, please see the Working with the Directions Widget topic.

<Graphic> route

The Route graphic that is returned if RouteParameters.returnRoutes is true.

<String> routeName

The name of the route.

<Graphic[]> stops

Array of stops. Returned only if RouteParameters.returnStops is true.