RouteSolveResult | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: RouteSolveResult→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.23

The results from solve() method. A RouteSolveResult may contain barriers, messages, and one or more RouteResult.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`RouteSolveResultProperties`

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
`messages`	`NAMessage[] \| null \| undefined`
`pointBarriers`	`Graphic[] \| null \| undefined`
`polygonBarriers`	`Graphic[] \| null \| undefined`
`polylineBarriers`	`Graphic[] \| null \| undefined`
`routeResults`	`RouteResult[]`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

messages

autocast Property

Type: NAMessage[] | null | undefined

An array of processing messages generated by the server.

pointBarriers

autocast Property

Type: Graphic[] | null | undefined

An array of graphics representing point barriers. Point barriers are returned if RouteParameters.returnBarriers is set to true in a solve() request.

See also

barriers

polygonBarriers

autocast Property

Type: Graphic[] | null | undefined

An array of graphics representing polygon barriers. Polygon barriers are returned if RouteParameters.returnPolygonBarriers is set to true in a solve() request.

See also

polygonBarriers

polylineBarriers

autocast Property

Type: Graphic[] | null | undefined

An array of graphics representing polyline barriers. Polyline barriers are returned if RouteParameters.returnPolylineBarriers is set to true in a solve() request.

See also

polylineBarriers

routeResults

autocast Property

Type: RouteResult[]

An array of route results.

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.