RouteResult | References | ArcGIS Maps SDK for JavaScript

import RouteResult from "@arcgis/core/rest/support/RouteResult.js";

Inheritance:: RouteResult→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

The route result from 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

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`RouteResultProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`directionLines`	`FeatureSet \| null \| undefined`
`directionPoints`	`FeatureSet \| null \| undefined`
`directions`	`DirectionsFeatureSet \| null \| undefined`
`route`	`Graphic \| null \| undefined`
`routeName`	`string`
`stops`	`Graphic[] \| null \| undefined`
`traversedEdges`	`FeatureSet \| null \| undefined`
`traversedJunctions`	`FeatureSet \| null \| undefined`
`traversedTurns`	`FeatureSet \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

directionLines

autocast Property

Type: FeatureSet | null | undefined

Since: ArcGIS Maps SDK for JavaScript 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 solve() request.

directionPoints

autocast Property

Type: FeatureSet | null | undefined

Since: ArcGIS Maps SDK for JavaScript 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 solve() request.

directions

autocast Property

Type: DirectionsFeatureSet | null | undefined

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 solve() request.

route

autocast Property

Type: Graphic | null | undefined

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 solve() request.

See also

routes

routeName

Property

Type: string

The name of the route.

stops

autocast Property

Type: Graphic[] | null | undefined

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

See also

traversedEdges

autocast Property

Type: FeatureSet | null | undefined

Since: ArcGIS Maps SDK for JavaScript 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 solve() request.

See also

traversedEdges

traversedJunctions

autocast Property

Type: FeatureSet | null | undefined

Since: ArcGIS Maps SDK for JavaScript 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 solve() request.

See also

traversedJunctions

traversedTurns

autocast Property

Type: FeatureSet | null | undefined

Since: ArcGIS Maps SDK for JavaScript 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 solve() request.

See also

traversedTurns

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.