RouteResult

AMD: require(["esri/rest/support/RouteResult"], (RouteResult) => { /* code goes here */ });
ESM: import RouteResult from "@arcgis/core/rest/support/RouteResult.js";
Class: esri/rest/support/RouteResult
Inheritance: RouteResult Accessor
Since: ArcGIS Maps SDK for JavaScript 4.0

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

Accessor
FeatureSet

Direction lines contains a set of line features for each segment of the route.

RouteResult
FeatureSet

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
DirectionsFeatureSet

Direction are returned if RouteParameters.returnDirections is set to true and RouteParameters.directionsOutputType is set to complete, complete-no-events, instructions-only', standardorsummary-only` in a route.solve() request.

RouteResult
Graphic

This property returns a Graphic that represent the overall path with attributes containing the total cost.

RouteResult
String

The name of the route.

RouteResult
Graphic[]

Array of stops.

RouteResult
FeatureSet

This provides access to the edges that are traversed while solving a network analysis layer.

RouteResult
FeatureSet

This provides access to the junctions that are traversed while solving a network analysis layer.

RouteResult
FeatureSet

This provides access to the turns that are traversed while solving a network analysis layer.

RouteResult

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

directionLines

Property
directionLines FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.23 RouteResult 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 to featureset in a route.solve() request.

directionPoints

Property
directionPoints FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.23 RouteResult 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 to featureset in a route.solve() request.

directions

Property
directions DirectionsFeatureSet

Direction are returned if RouteParameters.returnDirections is set to true and RouteParameters.directionsOutputType is set to complete, complete-no-events, instructions-only', standardorsummary-only` in a route.solve() request.

route

Property
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

Property
routeName String

The name of the route.

See also

stops

Property
stops Graphic[]

Array of stops. Stops are returned if RouteParameters.returnStops is set to true in a route.solve() request.

traversedEdges

Property
traversedEdges FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.24 RouteResult 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

Property
traversedJunctions FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.24 RouteResult 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.

traversedTurns

Property
traversedTurns FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.24 RouteResult 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

Show inherited methods Hide inherited methods
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
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

RouteResult

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

fromJSON

Method
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 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.

Parameter
json Object

A 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.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON

Method
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.