Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

geometryGeometry

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;

nameString

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

Example:

var stops = new DataLayer();
stops.name = "Hospitals";

spatialRelationshipString

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:

var stops = new DataLayer();
stops.spatialRelationship = "contains";

whereString

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

Method Details

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.