RouteSolveResult

AMD: require(["esri/rest/support/RouteSolveResult"], (RouteSolveResult) => { /* code goes here */ });
ESM: import RouteSolveResult from "@arcgis/core/rest/support/RouteSolveResult";
Class: esri/rest/support/RouteSolveResult
Inheritance: RouteSolveResult Accessor
Since: ArcGIS API for JavaScript 4.23

The results from route.solve() method. A RouteSolveResult may contain barriers, messages, and one or more 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.

more details
Accessor
NAMessage[]

An array of processing messages generated by the server.

more details
RouteSolveResult
Graphic[]

An array of graphics representing point barriers.

more details
RouteSolveResult
Graphic[]

An array of graphics representing polygon barriers.

more details
RouteSolveResult
Graphic[]

An array of graphics representing polyline barriers.

more details
RouteSolveResult
RouteResult[]

An array of route results.

more details
RouteSolveResult

Property Details

declaredClass Stringreadonly inherited

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

messages NAMessage[]

An array of processing messages generated by the server.

pointBarriers Graphic[]

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

See also
polygonBarriers Graphic[]

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

See also
polylineBarriers Graphic[]

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

See also
routeResults RouteResult[]

An array of route results.

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.

more details
Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
RouteSolveResult
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
RouteSolveResult

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(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(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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(){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.