The results from route.solve() method. A RouteSolveResult may contain barriers, messages, and one or more RouteResult.
- See also:
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
NAMessage[] | more details Message received when the solve is complete. | more details | RouteSolveResult | |
Graphic[] | more details Point barriers are an array of graphics with point geometry. | more details | RouteSolveResult | |
Graphic[] | more details Polygon barriers are an array of graphics with polygon geometry. | more details | RouteSolveResult | |
Graphic[] | more details Polyline barriers are an array of graphics with polyline geometry. | more details | RouteSolveResult | |
RouteResult[] | more details An array of route results. | more details | RouteSolveResult |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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.
-
Point barriers are an array of graphics with point geometry. They are only returned if RouteParameters.returnBarriers is set to
true
(default value isfalse
) in a route.solve() request.
-
Polygon barriers are an array of graphics with polygon geometry. They are only returned if RouteParameters.returnPolygonBarriers is set to
true
(default value isfalse
) in a route.solve() request.
-
Polyline barriers are an array of graphics with polyline geometry. They are only returned if RouteParameters.returnPolylineBarriers is set to
true
(default value isfalse
) in a route.solve() request.
-
routeResults RouteResult[]
-
An array of route results.
Method Overview
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 details | RouteSolveResult | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | RouteSolveResult |
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 ObjectA 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)inheritedSince: 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.