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 paramater 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.
NameTypeSummaryClass
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

A where clause for the query.

more details
more detailsDataLayer

Property Details

declaredClassStringreadonly inherited

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 ValueDescription
intersectsPart of a feature from feature class 1 is contained in a feature from feature class 2.
containsPart or all of a feature from feature class 1 is contained within a feature from feature class 2.
crossesThe feature from feature class 1 crosses a feature from feature class 2.
envelope-intersectsThe envelope of feature class 1 intersects with the envelope of feature class 2.
index-intersectsThe envelope of the query feature class intersects the index entry for the target feature class.
overlapsFeatures from feature class 1 overlap features in feature class 2.
touchesThe feature from feature class 1 touches the border of a feature from feature class 2.
withinThe feature from feature class 1 is completely enclosed by the feature from feature class 2.
relationAllows 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

NameReturn TypeSummaryClass
Object

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

more details
more detailsDataLayer

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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.