IFeatureLayer

Interface

Feature layers can be created by referencing a layer from either a map service or a feature service or by specifying a feature collection object. Use a map service if you just want to retrieve geometries and attributes from the server and symbolize them yourself. Use a feature service if you want to take advantage of symbols from the service's source map document. Also, use a feature service if you plan on doing editing with the feature layer. Feature layers honor any feature templates configured in the source map document. Feature collection objects are used to create a feature layer based on the supplied definition.

Extends

Properties

Property	Type	Notes
layerType	"ArcGISFeatureLayer"	String indicating the layer type.
id Inherited	any	A unique identifying string for the layer.
capabilities Optional	string	A comma-separated string listing which editing operations are allowed on an editable feature service.
definitionEditor Optional	IDefinitionEditor	Stores interactive filters.
disablePopup Optional	true	Indicates whether to allow a client to ignore popups defined by the service item.
featureCollection Optional	any	A featureCollection object defining a layer of features whose geometry and attributes are either stored directly within the web map or with an item. Feature Collections can be created from CSVs, shapefiles, GPX, or map notes.
featureCollectionType Optional	"markup" \| "notes" \| "route"	Indicates the type of features in the feature collection. If featureCollectionType is missing, it means the feature collection is a regular single-layer or multi-layer feature collection.
layerDefinition Optional	ILayerDefinition	A layerDefinition object defining the attribute schema and drawing information for the layer.
mode Optional	\| \|	0 is snapshot mode. 1 is on-demand mode. 2 is selection-only mode. Used with ArcGIS feature services and individual layers in ArcGIS map services.
popupInfo Optional	IPopupInfo	A popupInfo object defining the content of popup windows when you click or query a feature.
refreshInterval Optional	number	Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.
showLabels Optional	true	Labels will display if this property is set to true and the layer also has a labelingInfo property associated with it. This property can get stored in the web map config and in the item/data.
visibleLayers Optional	number[] \| number	An array of sublayer ids that should appear visible. Used with feature layers that are based on feature collections.
itemId Optional Inherited	string	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
maxScale Optional Inherited	number	Integer property used to determine the maximum scale at which the layer is displayed.
minScale Optional Inherited	number	Integer property used to determine the minimum scale at which the layer is displayed.
name Optional Inherited	string	Layer name
opacity Optional Inherited	number	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
showLegend Optional Inherited	boolean	Boolean property indicating whether to display in the legend.
timeAnimation Optional Inherited	boolean	This property is applicable to layers that support time. If 'true', timeAnimation is enabled.
title Optional Inherited	string	A user-friendly string title for the layer that can be used in a table of contents.
type Optional Inherited	string	Deprecated, use layerType instead.
url Optional Inherited	string	The URL to the layer. Not applicable to all layer types.
visibility Optional Inherited	boolean	Boolean property determining whether the layer is initially visible in the web map.

Interface defined in packages/arcgis-rest-types/src/webmap.ts:1324