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
-
new DataLayer(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
Boolean | If true, restricted network elements should be considered when finding network locations. more details | DataLayer | |
Geometry | The geometry to apply to the spatial filter. more details | DataLayer | |
String | The type of geometry specified by the geometry property. more details | DataLayer | |
String | The name of the data layer in the map service that is being referenced. more details | DataLayer | |
String | The spatial relationship to be applied on the input geometry while performing the query. more details | DataLayer | |
String | For DataLayer the type is always "layer". more details | DataLayer | |
String | A where clause for the query. more details | DataLayer |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
doNotLocateOnRestrictedElements BooleanSince: ArcGIS Maps SDK for JavaScript 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.
Examplelet stops = new DataLayer(); stops.geometry = view.extent;
-
geometryType StringSince: ArcGIS Maps SDK for JavaScript 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.
Examplelet 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"
Examplelet stops = new DataLayer(); stops.spatialRelationship = "contains";
-
where String
-
A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed.
Examplelet stops = new DataLayer(); stops.where = "POP2000 > 350000";
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | DataLayer | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | DataLayer |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.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.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.