The route result from RouteTask as part of a
RouteSolveResult. The RouteResult properties are dependent on the
RouteParameters inputs. For example, directions are only returned if
RouteParameters.returnDirections
is set to true.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | more details The name of the class. | more details | Accessor | |
| FeatureSet | more details Direction lines contains a set of line features for each segment of the route. | more details | RouteResult | |
| FeatureSet | more details Direction points contains a set of point features representing the direction maneuvers such as arriving to or departing from a stop, turning left or right, and other events along your route. | more details | RouteResult | |
| DirectionsFeatureSet | more details Route directions are returned if | more details | RouteResult | |
| Graphic | more details The Route graphic that is returned if | more details | RouteResult | |
| String | more details The name of the route. | more details | RouteResult | |
| Graphic[] | more details Array of stops. | more details | RouteResult |
Property Details
-
Since: ArcGIS API for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
directionLines FeatureSetSince: ArcGIS API for JavaScript 4.22
-
Direction lines contains a set of line features for each segment of the route. This feature set can be used to visualize the turn-by-turn directions on a map.
This feature set is only available if the RouteParameters properties
returnDirectionsanddirectionsOutputTypeare true and "featureset" respectively.- See also:
-
directionPoints FeatureSetSince: ArcGIS API for JavaScript 4.22
-
Direction points contains a set of point features representing the direction maneuvers such as arriving to or departing from a stop, turning left or right, and other events along your route. This feature set contains the route's turn-by-turn directions.
This feature set is only available if the RouteParameters properties
returnDirectionsanddirectionsOutputTypeare true and "featureset" respectively.- See also:
-
directions DirectionsFeatureSet
-
Route directions are returned if
RouteParameters.returnDirections = true.- See also:
-
route Graphic
-
The Route graphic that is returned if
RouteParameters.returnRoutes = true.- See also:
-
routeName String
-
The name of the route.
-
Array of stops. Returned only if
RouteParameters.returnStops = true.- See also:
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | RouteResult | |
| Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | RouteResult |
Method Details
-
fromJSON(json){*}static
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameter:json ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns:Type Description * Returns a new instance of this class.
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.