Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: RouteResult
[ AMD Module Require | Legacy Module Require ]
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
| Name | Type | Summary |
|---|---|---|
| directions | DirectionsFeatureSet | Route directions are returned if RouteParameters.returnDirections is set to true. |
| route | Graphic | The Route graphic that is returned if RouteParameters.returnRoutes is true. |
| routeName | String | The name of the route. |
| stops | Graphic[] | Array of stops. |
Property Details
<DirectionsFeatureSet
DirectionsFeatureSetRoute 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.
See also: RouteParameters.returnDirections
<Graphic
GraphicThe Route graphic that is returned if
RouteParameters.returnRoutes is true. See also: RouteParameters.returnRoutes
<String
StringThe name of the route.
<Graphic[]
Graphic[]Array of stops. Returned only if
RouteParameters.returnStops is true. See also: RouteParameters.returnStops