ClosestFacilitySolveResult

AMD: require(["esri/rest/support/ClosestFacilitySolveResult"], (ClosestFacilitySolveResult) => { /* code goes here */ });
ESM: import ClosestFacilitySolveResult from "@arcgis/core/rest/support/ClosestFacilitySolveResult.js";
Class: esri/rest/support/ClosestFacilitySolveResult
Inheritance: ClosestFacilitySolveResult Accessor
Since: ArcGIS Maps SDK for JavaScript 4.20

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.

Accessor
FeatureSet

Direction lines contains a set of line features for each segment of the route.

ClosestFacilitySolveResult
FeatureSet

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.

ClosestFacilitySolveResult
DirectionsFeatureSet[]

Directions are returned if ClosestFacilityParameters.returnDirections is set to true and ClosestFacilityParameters.directionsOutputType is set to complete, complete-no-events, instructions-only', standardorsummary-only` in a closestFacility.solve() request.

ClosestFacilitySolveResult
FeatureSet

This provides access to the output facilities from a closest facility analysis.

ClosestFacilitySolveResult
FeatureSet

This provides access to the locations used as starting or ending points in a closest facility analysis.

ClosestFacilitySolveResult
NAMessage[]

An array of processing messages generated by the server.

ClosestFacilitySolveResult
FeatureSet

A set of features representing point barriers.

ClosestFacilitySolveResult
FeatureSet

A set of features representing polygon barriers.

ClosestFacilitySolveResult
FeatureSet

A set of features representing polyline barriers.

ClosestFacilitySolveResult
FeatureSet

A set of features representing routes between the facilities and the incidents.

ClosestFacilitySolveResult
FeatureSet

This provides access to the edges that are traversed while solving a network analysis layer.

ClosestFacilitySolveResult
FeatureSet

This provides access to the junctions that are traversed while solving a network analysis layer.

ClosestFacilitySolveResult
FeatureSet

This provides access to the turns that are traversed while solving a network analysis layer.

ClosestFacilitySolveResult

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

directionLines

Property
directionLines FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.25 ClosestFacilitySolveResult since 4.20, directionLines added at 4.25.

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 ClosestFacilityParameters.returnDirections is set to true and ClosestFacilityParameters.directionsOutputType is set to featureset in a closestFacility.solve() request.

directionPoints

Property
directionPoints FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.25 ClosestFacilitySolveResult since 4.20, directionPoints added at 4.25.

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 lines are returned if ClosestFacilityParameters.returnDirections is set to true and ClosestFacilityParameters.directionsOutputType is set to featureset in a closestFacility.solve() request.

directions

Property
directions DirectionsFeatureSet[]

Directions are returned if ClosestFacilityParameters.returnDirections is set to true and ClosestFacilityParameters.directionsOutputType is set to complete, complete-no-events, instructions-only', standardorsummary-only` in a closestFacility.solve() request.

facilities

Property
facilities FeatureSet

This provides access to the output facilities from a closest facility analysis. Facilities are returned if ClosestFacilityParameters.returnFacilities is set to true in a closestFacility.solve() request.

See also

incidents

Property
incidents FeatureSet

This provides access to the locations used as starting or ending points in a closest facility analysis. Facilities are returned if ClosestFacilityParameters.returnIncidents is set to true in a closestFacility.solve() request.

See also

messages

Property
messages NAMessage[]

An array of processing messages generated by the server.

pointBarriers

Property
pointBarriers FeatureSet

A set of features representing point barriers. Point barriers are returned if ClosestFacilityParameters.returnBarriers is set to true in a closestFacility.solve() request.

See also

polygonBarriers

Property
polygonBarriers FeatureSet

A set of features representing polygon barriers. Point barriers are returned if ClosestFacilityParameters.returnPolygonBarriers is set to true in a closestFacility.solve() request.

See also

polylineBarriers

Property
polylineBarriers FeatureSet

A set of features representing polyline barriers. Point barriers are returned if ClosestFacilityParameters.returnPolylineBarriers is set to true in a closestFacility.solve() request.

See also

routes

Property
routes FeatureSet

A set of features representing routes between the facilities and the incidents. Routes are returned if ClosestFacilityParameters.returnRoutes is set to true in a closestFacility.solve() request.

See also

traversedEdges

Property
traversedEdges FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.25 ClosestFacilitySolveResult since 4.20, traversedEdges added at 4.25.

This provides access to the edges that are traversed while solving a network analysis layer. Traversed edges are returned if ClosestFacilityParameters.returnTraversedEdges is set to true in a closestFacility.solve() request.

See also

traversedJunctions

Property
traversedJunctions FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.25 ClosestFacilitySolveResult since 4.20, traversedJunctions added at 4.25.

This provides access to the junctions that are traversed while solving a network analysis layer. Traversed junctions are returned if ClosestFacilityParameters.returnTraversedJunctions is set to true in a closestFacility.solve() request.

traversedTurns

Property
traversedTurns FeatureSet
Since: ArcGIS Maps SDK for JavaScript 4.25 ClosestFacilitySolveResult since 4.20, traversedTurns added at 4.25.

This provides access to the turns that are traversed while solving a network analysis layer. Traversed turns are returned if ClosestFacilityParameters.returnTraversedTurns is set to true in a closestFacility.solve() request.

See also

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.

Accessor
*

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

ClosestFacilitySolveResult
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor
Object

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

ClosestFacilitySolveResult

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
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

Method
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

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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

Method
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.