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.

Referenced by: operationalLayers

Properties

Property	Details
blendMode	Blend modes are used to create various effects by blending colors of top and background layers. normal blend mode is the default. Valid values: average, color, color-burn, color-dodge, darken, destination-atop, destination-in, destination-out, destination-over, difference, exclusion, hard-light, hue, invert, lighten, lighter, luminosity, minus, multiply, normal, overlay, plus, reflect, saturation, screen, soft-light, source-atop, source-in, source-out, vivid-light, xor
capabilities	A comma-separated string listing which editing operations are allowed on an editable feature service.
charts[]	An array of chart items of type WebChart available on the feature layer.
customParameters	A sequence of custom parameters appended to the URL of all requests related to a layer.
definitionEditor	Stores interactive filters.
disablePopup	Indicates whether to allow a client to ignore popups defined by the service item.
effect	Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.
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. Valid values: markup notes route
featureEffect	Feature Effect emphasizes or deemphasizes features that satisfy a filter using graphical effects. Must be one of the following values: Feature Effect Null
formInfo	A formInfo object defining the content of the form when you are editing a feature.
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. See layerDefinition properties table.
layerType	String indicating the layer type. Valid value of this property 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 window when you click a feature on the map.
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	Boolean value indicating whether to display the layer in the legend. Default value is true.
subtypeCode	The feature subtype code identifying the layer. Used with SubtypeGroupLayers.
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.
visibilityTimeExtent	Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.
visibleLayers[]	An array of sublayer ids that should appear visible. Used with feature layers that are based on feature collections.

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	Contains the drawing and labeling information.
featureReduction	An object defining how to aggregate dense point data to clusters or bins.
floorInfo	Contains floor-awareness information for the layer.
maxScale	Integer property used to determine the maximum scale at which the layer is displayed.
minScale	Integer property used to determine the minimum scale at which the layer is displayed.
orderBy[]	An array of orderByField objects specifying the feature display order. Features can be sorted in ascending or descending order of a numeric or date field only. If ascending, features with smaller values will be drawn on top of features with larger values. For date values, ascending order means features with older dates will be drawn on top of features with recent dates. If descending, the sort behavior is reversed. When this property is not defined, features are displayed in the order in which they are received by the client.
templates[]	A property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types.

featureLayer Example

Live sample web map 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,
  "mode": 1,
  "title": "Map Service Layer",
  "blendMode": "color-burn",
  "popupInfo": {
    "title": "Facilities: {description}",
    "fieldInfos": [],
    "description": null,
    "showAttachments": true,
    "mediaInfos": []
  }
}

Example

{
  "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": []
  },
  "formInfo": {
    "title": "Damage Inspection Report",
    "description": "Enter information about the damage in the form below.",
    "formElements": []
  }
}

Example

{
  "layerType": "ArcGISFeatureLayer",
  "id": "mapNotes_2391",
  "title": "Feature Collection - Map Notes",
  "featureCollectionType": "notes",
  "featureCollection": {
    "layers": [],
    "showLegend": false
  },
  "opacity": 1,
  "visibility": true
}