Describes the layer's supported capabilities.
Copyright information for the layer.
A list of custom parameters appended to the URL of all resources fetched by the layer.
The SQL where clause used to filter features on the client.
The name of the layer's primary display field.
The editor tracking fields, which record who adds or edits the data through the feature service and when edits are made.
Determines if the layer is editable.
If present, this value specifies information about editing.
Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work.
Specifies how features are placed on the vertical axis (z).
An array of fields in the layer.
A convenient property that can be used to make case-insensitive lookups for a field by name.
When a feature layer is configured as floor-aware, it has a floorInfo property defined.
The associated template used in an associated layer's FeatureForm.
The full extent of the layer.
The version of the geodatabase of the feature service data.
Provides information on the system maintained area and length fields along with their respective units.
The geometry type of features in the layer.
Indicates whether the client-side features in the layer have M
(measurement) values.
Indicates whether the client-side features in the layer have Z
(elevation) values.
The historic moment to query.
The unique ID assigned to the layer.
Returns true
if the layer is loaded from a non-spatial table in a service.
The layer ID, or layer index, of a Feature Service layer.
Indicates whether the layer will be included in the legend.
Indicates how the layer should display in the LayerList widget.
The Error object returned if an error occurred while loading.
Represents the status of a load operation.
A list of warnings which occurred while loading.
Indicates whether the layer's resources have loaded.
The maximum scale (most zoomed in) at which the layer is visible in the view.
The minimum scale (most zoomed out) at which the layer is visible in the view.
The name of an oid
field containing a unique value or identifier for each feature in the layer.
The opacity of the layer.
An array of field names from the service to include with each feature.
The portal item from which the layer is loaded.
Refresh interval of the layer in minutes.
When true
, indicates that M values will be returned.
When true
, indicates that z-values will always be returned.
Apply perspective scaling to screen-size point symbols in a SceneView.
The service definition expression limits the features available for display and query.
The feature service's metadata JSON exposed by the ArcGIS REST API.
The spatial reference of the layer.
A Collection of SubtypeSublayer objects that allow you to alter the properties of one or more sublayers of the SubtypeGroupLayer.
The name of the SubtypeGroupLayer's subtype field.
The layer's time extent.
TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.
A temporary offset of the time data based on a certain TimeInterval.
The title of the layer used to identify it in places such as the LayerList widget.
The name of the field holding the type ID or subtypes for the features.
The URL of the REST endpoint of the layer, non-spatial table or service.
Determines if the layer will update its temporal data based on the view's timeExtent.
The version of ArcGIS Server in which the layer is published.
Indicates if the layer is visible in the View.
Adds an attachment to a feature.
Applies edits to features in a layer.
Cancels a load() operation if it is already in progress.
Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.
Creates query parameter object that can be used to fetch features that satisfy the layer's configurations such as definitionExpression, gdbVersion, and historicMoment.
Deletes attachments from a feature.
Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).
Emits an event on the instance.
Fetches custom attribution data for the layer when it becomes available.
Returns the Domain associated with the given field name.
Indicates whether there is an event listener on the instance that matches the provided event name.
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
isRejected()
may be used to verify if creating an instance of the class is rejected.
isResolved()
may be used to verify if creating an instance of the class is resolved.
Loads the resources referenced by this class.
Query information about attachments associated with features.
Executes a Query against the feature service and returns the number of features that satisfy the query.
Executes a Query against the feature service and returns a FeatureSet, which can be accessed using the .then()
method once the promise resolves.
Executes a Query against the feature service and returns an array of Object IDs for features that satisfy the input query.
Fetches all the data for the layer.
Updates an existing attachment for a feature.
when()
may be leveraged once an instance of the class is created.
Generated using TypeDoc
Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.
Read more...