import ClosestFacilitySolveResult from "@arcgis/core/rest/support/ClosestFacilitySolveResult.js";const ClosestFacilitySolveResult = await $arcgis.import("@arcgis/core/rest/support/ClosestFacilitySolveResult.js");- Inheritance:
- ClosestFacilitySolveResult→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.20
The result from closestFacility.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
FeatureSet | null | undefined | | |
FeatureSet | null | undefined | | |
| | ||
FeatureSet | null | undefined | | |
FeatureSet | null | undefined | | |
| | ||
FeatureSet | null | undefined | | |
FeatureSet | null | undefined | | |
FeatureSet | null | undefined | | |
FeatureSet | null | undefined | | |
FeatureSet | null | undefined | | |
FeatureSet | null | undefined | | |
FeatureSet | null | undefined | |
directionLines
- Type
- FeatureSet | null | undefined
- Since
- 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
to featureset in a solve() request.
directionPoints
- Type
- FeatureSet | null | undefined
- Since
- 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
to featureset in a solve() request.
directions
- Type
- DirectionsFeatureSet[] | null | undefined
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 solve() request.
facilities
- Type
- FeatureSet | null | undefined
This provides access to the output facilities from a closest facility analysis.
Facilities are returned if ClosestFacilityParameters.returnFacilities is set to true
in a solve() request.
- See also
incidents
- Type
- FeatureSet | null | undefined
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 solve() request.
- See also
pointBarriers
- Type
- FeatureSet | null | undefined
A set of features representing point barriers.
Point barriers are returned if ClosestFacilityParameters.returnPointBarriers
is set to true in a solve() request.
- See also
polygonBarriers
- Type
- FeatureSet | null | undefined
A set of features representing polygon barriers.
Point barriers are returned if ClosestFacilityParameters.returnPolygonBarriers
is set to true in a solve() request.
- See also
polylineBarriers
- Type
- FeatureSet | null | undefined
A set of features representing polyline barriers.
Point barriers are returned if ClosestFacilityParameters.returnPolylineBarriers
is set to true in a solve() request.
- See also
routes
- Type
- FeatureSet | null | undefined
A set of features representing routes between the facilities and the incidents.
Routes are returned if ClosestFacilityParameters.returnRoutes
is set to true in a solve() request.
- See also
traversedEdges
- Type
- FeatureSet | null | undefined
- Since
- 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 solve() request.
- See also
traversedJunctions
- Type
- FeatureSet | null | undefined
- Since
- 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 solve() request.
- See also
traversedTurns
- Type
- FeatureSet | null | undefined
- Since
- 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 solve() request.
- See also
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- any
Returns a new instance of this class.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.