require(["esri/rest/support/RouteResult"], (RouteResult) => { /* code goes here */ });
import RouteResult from "@arcgis/core/rest/support/RouteResult.js";
esri/rest/support/RouteResult
The route result from route.solve() as part of a
RouteSolveResult. A successfully solved route will contain
one RouteSolveRoute
, which may contain barriers, messages, and one or more RouteResult.
RouteResult may contain stops, directions, directions lines, direction points, and route information,
depending on the corresponding RouteParameters properties. For example,
setting RouteParameters.returnStops to true
will include stops in the RouteResult.
- See also
-
- route
- RouteParameters
- RouteSolveResult
- esri/rest/widgets/Directions
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
Direction lines contains a set of line features for each segment of the route. | RouteResult | ||
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. | RouteResult | ||
Direction are returned if RouteParameters.returnDirections is set to | RouteResult | ||
This property returns a Graphic that represent the overall path with attributes containing the total cost. | RouteResult | ||
The name of the route. | RouteResult | ||
Array of stops. | RouteResult | ||
This provides access to the edges that are traversed while solving a network analysis layer. | RouteResult | ||
This provides access to the junctions that are traversed while solving a network analysis layer. | RouteResult | ||
This provides access to the turns that are traversed while solving a network analysis layer. | RouteResult |
Property Details
-
directionLines
directionLines FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.23RouteResult since 4.0, directionLines added at 4.23. -
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. Direction lines are returned if RouteParameters.returnDirections is set to
true
and RouteParameters.directionsOutputType is set tofeatureset
in a route.solve() request.
-
directionPoints
directionPoints FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.23RouteResult since 4.0, directionPoints added at 4.23. -
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. Direction points are returned if RouteParameters.returnDirections is set to
true
and RouteParameters.directionsOutputType is set tofeatureset
in a route.solve() request.
-
directions
directions DirectionsFeatureSet
-
Direction are returned if RouteParameters.returnDirections is set to
true
and RouteParameters.directionsOutputType is set tocomplete
,complete-no-events
,instructions-only',
standardor
summary-only` in a route.solve() request.
-
route
route Graphic
-
This property returns a Graphic that represent the overall path with attributes containing the total cost. Route is returned if RouteParameters.returnRoutes is set to
true
in a route.solve() request.- See also
-
routeName
routeName String
-
The name of the route.
-
Array of stops. Stops are returned if RouteParameters.returnStops is set to
true
in a route.solve() request.- See also
-
traversedEdges
traversedEdges FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.24RouteResult since 4.0, traversedEdges added at 4.24. -
This provides access to the edges that are traversed while solving a network analysis layer. Traversed edges are returned if RouteParameters.returnTraversedEdges is set to
true
in a route.solve() request.- See also
-
traversedJunctions
traversedJunctions FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.24RouteResult since 4.0, traversedJunctions added at 4.24. -
This provides access to the junctions that are traversed while solving a network analysis layer. Traversed junctions are returned if RouteParameters.returnTraversedJunctions is set to
true
in a route.solve() request.- See also
-
traversedTurns
traversedTurns FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.24RouteResult since 4.0, traversedTurns added at 4.24. -
This provides access to the turns that are traversed while solving a network analysis layer. Traversed turns are returned if RouteParameters.returnTraversedTurns is set to
true
in a route.solve() request.- See also
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | RouteResult | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | RouteResult |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
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
json
parameter 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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.