DataLayer

AMD: require(["esri/rest/support/DataLayer"], (DataLayer) => { /* code goes here */ });
ESM: import DataLayer from "@arcgis/core/rest/support/DataLayer.js";
Class: esri/rest/support/DataLayer
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:

Constructors

new DataLayer(properties)

Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

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
Boolean

If true, restricted network elements should be considered when finding network locations.

DataLayer
Geometry

The geometry to apply to the spatial filter.

DataLayer
String

The type of geometry specified by the geometry property.

DataLayer
String

The name of the data layer in the map service that is being referenced.

DataLayer
String

The spatial relationship to be applied on the input geometry while performing the query.

DataLayer
String For DataLayer the type is always "layer". DataLayer
String

A where clause for the query.

DataLayer

Property Details

declaredClass Stringreadonly inherited

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

doNotLocateOnRestrictedElements Boolean

Since: ArcGIS Maps SDK for JavaScript 4.21 DataLayer since 4.20, doNotLocateOnRestrictedElements added at 4.21.

If true, restricted network elements should be considered when finding network locations.

geometry Geometry

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 String

Since: ArcGIS Maps SDK for JavaScript 4.24 DataLayer since 4.20, geometryType added at 4.24.

The type of geometry specified by the geometry property.

Possible Values:"point"|"polyline"|"polygon"|"envelope"|"multipoint"

name String

The name of the data layer in the map service that is being referenced.

Example
let stops = new DataLayer();
stops.name = "Hospitals";

spatialRelationship String

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.

Possible Values:"intersects"|"contains"|"crosses"|"envelope-intersects"|"index-intersects"|"overlaps"|"touches"|"within"|"relation"

Example
let stops = new DataLayer();
stops.spatialRelationship = "contains";

type String

For DataLayer the type is always "layer".

where String

A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed.

Example
let stops = new DataLayer();
stops.where = "POP2000 > 350000";

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.

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

DataLayer

Method Details

addHandles(handleOrHandles, groupKey)inherited

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(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(groupKey){Boolean}inherited

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(groupKey)inherited

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(){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.