Feature Layer (ArcGISFeatureLayer)

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.

Properties

Property Details
capabilities A comma-separated string listing which editing operations are allowed on an editable feature service.
definitionEditor Stores interactive filters.
disablePopup Indicates whether to allow a client to ignore popups defined by the service item.
featureCollection 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 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.
If property is present, must be one of the following values:
  • markup
  • notes
  • route
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 A layerDefinition object defining the attribute schema and drawing information for the layer.
layerType String indicating the layer type.
Value of this property must be ArcGISFeatureLayer
mode 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.
opacity The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
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.
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 map config and in the item/data.
showLegend Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.
timeAnimation Indicates whether to disable time animation if the layer supports it.
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 map.
visibleLayers An array of sublayer ids that should appear visible. Used with feature layers that are based on feature collections.

Example

Live sample web map showing ArcGISFeatureLayer as an operationalLayer

{
  "operationalLayers": [
    {
      "id": "Recreation_4720",
      "layerType": "ArcGISFeatureLayer",
      "url": "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Recreation/MapServer/0",
      "visibility": true,
      "opacity": 1,
      "mode": 1,
      "title": "Map Service Layer",
      "popupInfo": {
        "title": "Facilities: {description}",
        "fieldInfos": [],
        "description": null,
        "showAttachments": true,
        "mediaInfos": []
      }
    },
    {
      "id": "DamageAssessment_2445",
      "layerType": "ArcGISFeatureLayer",
      "url": "http://sampleserver6.arcgisonline.com/arcgis/rest/services/DamageAssessment/FeatureServer/0",
      "visibility": true,
      "opacity": 1,
      "mode": 1,
      "title": "Feature Service",
      "layerDefinition": {
        "definitionExpression": "inspdate BETWEEN timestamp '2015-04-20 04:00:00' AND timestamp '2016-04-21 03:59:59'"
      },
      "popupInfo": {
        "title": "Damage to Residential Buildings: {firstname}",
        "fieldInfos": [],
        "description": null,
        "showAttachments": true,
        "mediaInfos": []
      }
    },
    {
      "layerType": "ArcGISFeatureLayer",
      "id": "mapNotes_2391",
      "title": "Feature Collection - Map Notes",
      "featureCollectionType": "notes",
      "featureCollection": {
        "layers": [],
        "showLegend": false
      },
      "opacity": 1,
      "visibility": true
    }
  ]
}

Feedback on this topic?