Esri
- Last UpdatedFeb 11, 2025
- 2 minute read
Loads an Esri Feature Layer including the drawingInfo and featureReduction (clustering) layer definitions. Features are loaded using a bounding box strategy (loaded as needed depending on the visible extent).
An API key (access token) is required to use ArcGIS basemap layer services. For more information about obtaining an API key, see the Esri site- https://developers.arcgis.com/documentation/mapping-apis-and-services/security/api-keys/
You can find Terms of Use, Master Agreements, and all other legal documents pertaining to licensing on the Esri Legal website: https://www.esri.com/en-us/legal/overview.
The following table provides the specific configurable options available for this layer:
|
Property |
Type |
Description |
|---|---|---|
|
asImage [Optional] |
Boolean |
Defines vector data is rendered client-side, to an image. This provides great performance during panning and zooming, but pixels are scaled during zoom animations. |
|
assetNameTemplate [Optional] |
String |
Defines template string to generate each feature asset name which is used to set CurrentAsset control property when clicked. When merge is enabled, the generated asset name is used to match the properties derived from the Features control property. |
|
assetZoom [Optional] |
String |
Defines zoom level to set when an asset in this layer is selected via CurrentAsset control property. Attribute templates can be used to get this value from a feature property ({property}). |
|
centerOnClick [Optional] |
Boolean |
Centers the map on a feature when clicked. |
|
drawingInfo [Optional] |
DrawingInfo |
Provides drawing, labeling, and transparency information for the layer. For more information, refer DrawingInfo. |
|
featureReduction [Optional] |
FeatureReduction |
Provides options for reducing the number of features in the view by aggregating them to clusters. For more information, refer Feature Reduction. |
|
layerDefinition [Optional] |
EsriLayerDefinition |
Defines layer definition overrides. |
|
merge [Optional] |
Boolean |
Enables feature merging capacity for this layer. |
|
popup [Optional] |
Popup |
Defines layer popup configuration. For more information, refer Popup. |
|
time [Optional] |
TimeOrRange |
Defines time value or range for layers data.
|
|
type |
esri |
A type of Layer. |
|
url |
string |
Defines feature Layer URL |
|
zoomOnClick [Optional] |
Boolean |
Sets the assetZoom level to the map when a feature is clicked. |
Examples of Esri
Cities
-
Configuration and map preview

-
Configuration JSON string
{
"title": "Esri Cities",
"type": "esri",
"url": "https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/World_Cities/FeatureServer/0",
"isBaseMap": false
}
States
-
Configuration and Map Preview

-
Configuration JSON string
{
"title": "Esri States",
"type": "esri",
"url": " https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3",
"isBaseMap": false
}