Feature Layer (ArcGISFeatureLayer)

Feature layers can be created by referencing a layer from either a map service or a feature service. 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.

Referenced by: operationalLayers

Properties

Property Details
customParameters A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types.
disablePopup Indicates whether to allow a client to ignore popups defined by the service item.
id A unique identifying string for the layer.
itemId Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerDefinition Additional properties that define drawing information and other configurations for the layer.
See layerDefinition properties table.
layerType String indicating the layer type.
Valid value of this property ArcGISFeatureLayer
listMode To show or hide layers in the layer list
Valid values:
  • hide
  • show
opacity The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
path For offline data, a path to a geodatabase file. A URI format is used starting with file: followed by a file system path with a .geodatabase extension. A query parameter itemId must also be present specifying the ID of a table in the geodatabase's GDB_ServiceItems table. A relative path must be from the file which defines the layer. For example file:../p20/northamerica.geodatabase?itemId=1.
popupInfo A popupInfo object defining the content of popup windows when you click or query a feature.
refreshInterval 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.
screenSizePerspective Apply perspective scaling to screen-size symbols.
showLabels 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 scene config and in the item/data.
showLegend Boolean value indicating whether to display the layer in the legend. Default value is true.
title A user-friendly string title for the layer that can be used in a table of contents.
url The URL to the layer. If the layer is not from a web service but rather a feature collection, then the url property is omitted.
visibility Boolean property determining whether the layer is initially visible in the web scene.

layerDefinition properties

Property Details
capabilities A comma separated list of supported capabilities, e.g. Query,Editing.
definitionExpression SQL-based definition expression string that narrows the data to be displayed in the layer.
drawingInfo.labelingInfo An array of labelingInfo objects.
drawingInfo.renderer The renderer object contains the drawing information for the operationalLayer.
drawingInfo.transparency Number value ranging between 0 (no transparency) to 100 (completely transparent).
elevationInfo Elevation info defines how features are aligned to ground or other layers.
featureReduction An object that specifies how features are reduced or aggregated, with the goal of decluttering the view or presenting the user with an aggregate visualization. If unset, every feature is rendered individually.
floorInfo Contains floor-awareness information for the layer.
maxScale Represents the maximum scale (most zoomed in) at which the layer is visible in the view. If the web scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. If set, the maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.
minScale Represents the minimum scale (most zoomed out) at which the layer is visible in the view. If the web scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. If set, the minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

featureLayer Example

Live sample web scene showing ArcGISFeatureLayer as an operationalLayer

{
  "id": "Recreation_4720",
  "layerType": "ArcGISFeatureLayer",
  "url": "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Recreation/MapServer/0",
  "visibility": true,
  "opacity": 1,
  "title": "Map Service Layer",
  "popupInfo": {
    "title": "Facilities: {description}",
    "fieldInfos": [],
    "showAttachments": true,
    "mediaInfos": []
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.