import DataLayer from "@arcgis/core/rest/support/DataLayer.js";const DataLayer = await $arcgis.import("@arcgis/core/rest/support/DataLayer.js");- Inheritance:
- DataLayer→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.20
Input for properties of ClosestFacilityParameters, RouteParameters or ServiceAreaParameters. The DataLayer can be used to define the following for each parameter type:
- ClosestFacilityParameters: define facilities, incidents and barriers.
- RouteParameters: define barriers and stops.
- ServiceAreaParameters: define facilities and barriers.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
Exclude<SpatialRelationship, "disjoint"> | null | undefined | | |
type readonly | "layer" | |
| |
geometry
- Type
- GeometryUnion | null | undefined
The geometry to apply to the spatial filter. The spatial relationship as specified by spatialRelationship is applied to this geometry while performing the query.
Example
let stops = new DataLayer();stops.geometry = view.extent; geometryType
- Type
- GeometryType | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.24
The type of geometry specified by the geometry property.
spatialRelationship
- Type
- Exclude<SpatialRelationship, "disjoint"> | null | undefined
The spatial relationship to be applied on the input geometry while performing the query.
| Possible Value | Description |
|---|---|
| intersects | Part of a feature from feature class 1 is contained in a feature from feature class 2. |
| contains | Part or all of a feature from feature class 1 is contained within a feature from feature class 2. |
| crosses | The feature from feature class 1 crosses a feature from feature class 2. |
| envelope-intersects | The envelope of feature class 1 intersects with the envelope of feature class 2. |
| index-intersects | The envelope of the query feature class intersects the index entry for the target feature class. |
| overlaps | Features from feature class 1 overlap features in feature class 2. |
| touches | The feature from feature class 1 touches the border of a feature from feature class 2. |
| within | The feature from feature class 1 is completely enclosed by the feature from feature class 2. |
| relation | Allows specification of any relationship defined using the Shape Comparison Language. |
Example
let stops = new DataLayer();stops.spatialRelationship = "contains";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.
clone
- Signature
-
clone (): this
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
- Returns
- this
A deep clone of the class instance that invoked this method.
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.