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
Stringmore details

The name of the class.

more detailsAccessor
NAMessage[]more details

Message received when the solve is complete.

more detailsRouteSolveResult
Graphic[]more details

Point barriers are an array of graphics with point geometry.

more detailsRouteSolveResult
Graphic[]more details

Polygon barriers are an array of graphics with polygon geometry.

more detailsRouteSolveResult
Graphic[]more details

Polyline barriers are an array of graphics with polyline geometry.

more detailsRouteSolveResult
RouteResult[]more details

An array of route results.

more detailsRouteSolveResult

Property Details

declaredClass Stringreadonly inherited

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

messages NAMessage[]

Message received when the solve is complete. If a closest facility cannot be solved, the message returned by the server identifies the incident that could not be solved.

pointBarriers Graphic[]

Point barriers are an array of graphics with point geometry. They are only returned if RouteParameters.returnBarriers is set to true (default value is false) in a route.solve() request.

polygonBarriers Graphic[]

Polygon barriers are an array of graphics with polygon geometry. They are only returned if RouteParameters.returnPolygonBarriers is set to true (default value is false) in a route.solve() request.

polylineBarriers Graphic[]

Polyline barriers are an array of graphics with polyline geometry. They are only returned if RouteParameters.returnPolylineBarriers is set to true (default value is false) in a route.solve() request.

routeResults RouteResult[]

An array of route results.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
*more details

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

more detailsRouteSolveResult
more details

Adds one or more handles which are to be tied to the lifecycle of the object.

more detailsAccessor
Objectmore details

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

more detailsRouteSolveResult

Method Details

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.
own(handleOrHandles)inherited
Since: ArcGIS API for JavaScript 4.24

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.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));
Parameter:
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

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.