DataLayer

require(["esri/tasks/support/DataLayer"], function(DataLayer) { /* code goes here */ });
Class: esri/tasks/support/DataLayer
Inheritance: DataLayer Accessor
Since: ArcGIS API for JavaScript 4.0

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.

more details
more detailsAccessor
Geometry

The geometry to apply to the spatial filter.

more details
more detailsDataLayer
String

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

more details
more detailsDataLayer
String

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

more details
more detailsDataLayer
String For DataLayer the type is always "layer". more detailsmore detailsDataLayer
String

A where clause for the query.

more details
more detailsDataLayer

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

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:
var stops = new DataLayer();
stops.geometry = view.extent;
name String

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

Example:
var 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:
var 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:
var stops = new DataLayer();
stops.where = "POP2000 > 350000";

Method Overview

Name Return Type Summary Class
*

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

more details
more detailsDataLayer
Object

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

more details
more detailsDataLayer

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.
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.