Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
FeatureSet | Direction lines contains a set of line features for each segment of the route. more details | 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. more details | ClosestFacilitySolveResult | |
DirectionsFeatureSet[] | Directions are returned if ClosestFacilityParameters.returnDirections is set to | ClosestFacilitySolveResult | |
FeatureSet | This provides access to the output facilities from a closest facility analysis. more details | ClosestFacilitySolveResult | |
FeatureSet | This provides access to the locations used as starting or ending points in a closest facility analysis. more details | ClosestFacilitySolveResult | |
NAMessage[] | An array of processing messages generated by the server. more details | ClosestFacilitySolveResult | |
FeatureSet | A set of features representing point barriers. more details | ClosestFacilitySolveResult | |
FeatureSet | A set of features representing polygon barriers. more details | ClosestFacilitySolveResult | |
FeatureSet | A set of features representing polyline barriers. more details | ClosestFacilitySolveResult | |
FeatureSet | A set of features representing routes between the facilities and the incidents. more details | ClosestFacilitySolveResult | |
FeatureSet | This provides access to the edges that are traversed while solving a network analysis layer. more details | ClosestFacilitySolveResult | |
FeatureSet | This provides access to the junctions that are traversed while solving a network analysis layer. more details | ClosestFacilitySolveResult | |
FeatureSet | This provides access to the turns that are traversed while solving a network analysis layer. more details | ClosestFacilitySolveResult |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
directionLines FeatureSetSince: ArcGIS Maps SDK for JavaScript 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 tofeatureset
in a closestFacility.solve() request.
-
directionPoints FeatureSetSince: ArcGIS Maps SDK for JavaScript 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 tofeatureset
in a closestFacility.solve() request.
-
directions DirectionsFeatureSet[]
-
Directions are returned if ClosestFacilityParameters.returnDirections is set to
true
and ClosestFacilityParameters.directionsOutputType is set tocomplete
,complete-no-events
,instructions-only',
standardor
summary-only` in a closestFacility.solve() request.
-
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 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
-
An array of processing messages generated by the server.
-
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 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 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 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 FeatureSetSince: ArcGIS Maps SDK for JavaScript 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 FeatureSetSince: ArcGIS Maps SDK for JavaScript 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.- See also
-
traversedTurns FeatureSetSince: ArcGIS Maps SDK for JavaScript 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
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 | ClosestFacilitySolveResult | |
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 | ClosestFacilitySolveResult |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.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.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.