require(["esri/layers/FeatureLayer"], function(FeatureLayer){
  // points to the states layer in a service storing U.S. census data
  const fl = new FeatureLayer({
    url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3"
  });
  map.add(fl);  // adds the layer to the map
});

// points to a hosted Feature Layer in ArcGIS Online
const fl = new FeatureLayer({
  portalItem: {  // autocasts as esri/portal/PortalItem
    id: "8444e275037549c1acab02d2626daaee"
  }
});
map.add(fl);  // adds the layer to the map

const layer = new FeatureLayer({

   // create an instance of esri/layers/support/Field for each field object
   fields: [
   {
     name: "ObjectID",
     alias: "ObjectID",
     type: "oid"
   }, {
     name: "type",
     alias: "Type",
     type: "string"
   }, {
     name: "place",
     alias: "Place",
     type: "string"
   }],
   objectIdField: "ObjectID",
   geometryType: "point",
   spatialReference: { wkid: 4326 },
   source: graphics,  //  an array of graphics with geometry and attributes
                     // popupTemplate and symbol are not required in each graphic
                     // since those are handled with the popupTemplate and
                     // renderer properties of the layer
   popupTemplate: pTemplate,
   renderer: uvRenderer  // UniqueValueRenderer based on `type` attribute
});
map.add(layer);

// returns all the graphics from the layer view
view.whenLayerView(layer).then(function(layerView){
  layerView.watch("updating", function(val){
    if(!val){  // wait for the layer view to finish updating
      layerView.queryFeatures().then(function(results){
        console.log(results);  // prints all the client-side graphics to the console
      });
    }
  });
});

// Queries for all the features in the service (not the graphics in the view)
layer.queryFeatures().then(function(results){
  // prints an array of all the features in the service to the console
  console.log(results.features);
});

<script>
  var dojoConfig = {
    has: {
      "esri-featurelayer-webgl": 1
    }
  };
</script>

Property Overview

Property Details

capabilitiesObjectreadonly

Indicates the layer's supported capabilities.

Properties:

data Object Indicates data capabilities that can be performed on features in the layer. Specification: supportsAttachment Boolean Indicates if the attachment is enabled on the layer. supportsM Boolean Indicates if the features in the layer support M values. Requires ArcGIS Server service 10.1 or greater. supportsZ Boolean Indicates if the features in the layer support Z values. Requires ArcGIS Server service 10.1 or greater. See elevationInfo for details regarding placement and rendering of graphics with z-values in 3D SceneViews.

editing Object Indicates editing capabilities that can be performed on the features in the layer. Specification: supportsDeleteByAnonymous Boolean Indicates if anonymous users can delete features created by others. supportsDeleteByOthers Boolean Indicates if logged in users can delete features created by others. supportsGeometryUpdate Boolean Indicates if the geometry of the features in the layer can be edited. supportsGlobalId Boolean Indicates if the globalid values provided by the client are used in applyEdits. supportsRollbackOnFailure Boolean Indicates if the rollbackOnFailure parameter can be set to true or false when running the synchronizeReplica operation. supportsUpdateByAnonymous Boolean Indicates if anonymous users can update features created by others. supportsUpdateByOthers Boolean Indicates if logged in users can update features created by others. supportsUpdateWithoutM Boolean Indicates if m-values must be provided when updating features. supportsUploadWithItemId Boolean Indicates if the layer supports uploading attachments by UploadId.

operations Object Indicates operations that can be performed on features in the layer. Specification: supportsAdd Boolean Indicates if new features can be added to the layer. supportsDelete Boolean Indicates if features can be deleted from the layer. supportsUpdate Boolean Indicates if features in the layer can be updated. supportsEditing Boolean Indicates if features in the layer can be edited. Use supportsAdd, supportsUpdate and supportsDelete to determine which editing operations are supported. supportsCalculate Boolean Indicates if values of one or more field values in the layer can be updated. See the Calculate REST operation document for more information. supportsQuery Boolean Indicates if features in the layer can be queried. supportsValidateSql Boolean Indicates if the layer supports a SQL-92 expression or where clause. This operation is only supported in ArcGIS Online hosted feature services. supportsResizeAttachments Boolean Indicates if resized attachments are supported in the feature layer. This is useful for showing thumbnails in Popups.

query Object Indicates query operations that can be performed on features in the layer. Specification: supportsCentroid Boolean Indicates if the geometry centroid associated with each polygon feature can be returned. This operation is only supported in ArcGIS Online hosted feature services. supportsDistance Boolean Indicates if the layer's query operation supports a buffer distance for input geometries. supportsDistinct Boolean Indicates if the layer supports queries for distinct values based on fields specified in the outFields. supportsExtent Boolean Indicates if the layer's query response includes the extent of features. At 10.3, this option is only available for hosted feature services. At 10.3.1, it is available for hosted and non-hosted feature services. supportsGeometryProperties Boolean Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. This operation is only supported in ArcGIS Online hosted feature services. supportsOrderBy Boolean Indicates if features returned in the query response can be ordered by one or more fields. Requires an ArcGIS Server service 10.3 or greater. supportsPagination Boolean Indicates if the query response supports pagination. Requires an ArcGIS Server service 10.3 or greater. supportsQuantization Boolean Indicates if the query operation supports the projection of geometries onto a virtual grid. Requires an ArcGIS Server service 10.3 or greater. supportsResultType Boolean Indicates if the number of features returned by the query operation can be controlled. supportsSqlExpression Boolean Indicates if the query operation supports SQL expressions. supportsStandardizedQueriesOnly Boolean Indicates if the query operation supports using standardized queries. Learn more about standardized queries here. supportsStatistics Boolean Indicates if the layer supports field-based statistical functions. Requires ArcGIS Server service 10.1 or greater. supportsHistoricMoment Boolean Indicates if the layer supports historic moment query. Requires ArcGIS Server service 10.5 or greater.

queryRelated Object Indicates if the layer's query operation supports querying features or records related to features in the layer. Specification: supportsCount Boolean Indicates if the layer's query response includes the number of features or records related to features in the layer. supportsOrderBy Boolean Indicates if the related features or records returned in the query response can be ordered by one or more fields. Requires ArcGIS Server service 10.3 or greater. supportsPagination Boolean Indicates if the query response supports pagination for related features or records. Requires ArcGIS Server service 10.3 or greater.

Example:

// Once the layer loads, check if the
// supportsAdd operations is enabled on the layer
featureLayer.when(function(){
  if (featureLayer.capabilities.operations.supportsAdd) {
    // if new features can be created in the layer
    // set up the UI for editing
    setupEditing();
  }
});

copyrightString

The copyright text as defined by the map service.

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

definitionExpressionString

The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are displayed in the View. Setting a definition expression is useful when the dataset is large and you don't want to bring all features to the client for analysis. Definition expressions may be set when a layer is constructed prior to it loading in the view or after it has been added to the map. If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression.

Known Limitations

Definition expressions will not be honored when working with FeatureLayers created from client-side graphics.

Examples:

// Set definition expression in constructor to only display trees with scientific name Ulmus pumila
const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Landscape_Trees/FeatureServer/0"
  definitionExpression: "Sci_Name = 'Ulmus pumila'"
});

// Set the definition expression directly on layer instance to only display trees taller than 50ft
layer.definitionExpression = "HEIGHT > 50";

displayFieldString

Since: ArcGIS API for JavaScript 4.4

The name of the layer's primary display field. The value of this property matches the name of one of the fields of the layer.

dynamicDataSourceDynamicMapLayer|DynamicDataLayer

Since: ArcGIS API for JavaScript 4.7

An object that allows you to create a dynamic layer with data either from map service sublayers or data from a registered workspace. See DynamicMapLayer for creating dynamic layers from map service layers for on the fly rendering, labeling, and filtering (definition expressions). To create dynamic layers from other sources in registered workspaces such as tables and table joins, see DynamicDataLayer.

If you already have a Sublayer instance, you can call the createFeatureLayer() method on the Sublayer to construct the layer for you.

This only applies to map services with dynamic layers enabled. Therefore, the url of the FeatureLayer instance must point to a map service url ending with /dynamicLayer.

See also:

• Sublayer.source
• Sublayer.createFeatureLayer()

Example:

const layer = new FeatureLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/AGP/Census/MapServer/dynamicLayer",
  title: "United States Population",
  popupTemplate: {
    title: "{states.STATE_NAME}",
    content: "{expression/per_ancestry}% of the {states.POP2007} people in {states.STATE_NAME} have "
      + "Norwegian ancestry.",
    expressionInfos: [{
      name: "per_ancestry",
      expression: "Round( ( $feature['ancestry.norwegian'] / $feature['states.POP2007'] ) * 100, 1)"
    }],
    fieldInfos: [{
      fieldName: "states.POP2007",
      format: {
        digitSeparator: true,
        places: 0
      }
    }]
  },
  dynamicDataSource: {
    type: "data-layer",
    dataSource: {
      type: "join-table",
      leftTableSource: {
        type: "map-layer",
        mapLayerId: 3
      },
      rightTableSource: {
        type: "data-layer",
        dataSource: {
          type: "table",
          workspaceId: "CensusFileGDBWorkspaceID",
          dataSourceName: "ancestry"
        }
      },
      leftTableKey: "STATE_NAME",
      rightTableKey: "State",
      joinType: "left-outer-join"
    }
  }
});

elevationInfoObject

Specifies how graphics are placed on the vertical axis (z). This property may only be used in a SceneView. See the ElevationInfo sample for an example of how this property may be used.

Properties:

mode String Defines how the graphic is placed with respect to the terrain surface. If the geometry consists of multiple points (e.g. lines or polygons), the elevation is evaluated separately for each point. See the table below for a list of possible values. Mode Description on-the-ground Graphics are draped on the terrain surface. This is the default value for features with Polyline or Polygon geometries and features with Point geometries rendered with ObjectSymbol3DLayers. relative-to-ground Graphics are placed at an elevation relative to the terrain surface. The graphic's elevation is determined by summing up the terrain elevation and the geometry's z-value (if present). If featureExpressionInfo is defined, the result of the expression is used instead of the geometry’s z-value. relative-to-ground is the default value for Point geometries rendered with IconSymbol3DLayers. absolute-height Graphics are placed at an absolute height above sea level. This height is determined by the geometry's z-value (if present). If featureExpressionInfo is defined, the result of the expression is used instead of the geometry’s z-value. This mode doesn't take the elevation of the terrain into account. This is the default value of features with any geometry type where hasZ is true. relative-to-scene Graphics are aligned to buildings and other objects part of 3D Object SceneLayers or IntegratedMeshLayers, depending on which has higher elevation. If the graphic is not directly above a building or any other feature, it is aligned to the terrain surface elevation. If defined, the result of featureExpressionInfo is added to the 3D Object/terrain surface elevation. In this mode z-values are ignored.

offset Number optional An elevation offset, which is added to the vertical position of the graphic. If unit is not defined, the offset is in meters. When mode = "on-the-ground", this property has no effect.

featureExpressionInfo Object optional This object contains information about setting a custom height on the graphic. If this property is set, then z values are not considered for calculating graphic height. Specification: expression String optional An Arcade expression evaluating to a number that determines the height of the graphic. If the geometry has z-values, they will be ignored and only featureExpressionInfo is used to calculate the vertical position of the graphic. When mode = "on-the-ground", this property has no effect. For line and polygon geometries the result of the expression is the same for all vertices of a feature.

unit String optional The unit for featureExpressionInfo and offset values. It doesn't apply to z-values. Possible Values: feet | meters | kilometers | miles | us-feet | yards

featureReductionObject

Since: ArcGIS API for JavaScript 4.4

Configures the method for decluttering overlapping features in the view. If this property is not set (or set to null), every feature is drawn individually.

Currently this property is only supported in 3D SceneViews for point features with non-draped Icons or Text symbol layers.

Property:

type String Type of the decluttering method. The only supported type at the moment is "selection". In this method, some of the overlapping features are hidden such that none of the remaining features intersect on screen. Label deconfliction also respects this option and hides labels that would overlap with the features of this layer.

See also:

• Sample: Point styles for cities

Example:

layer.featureReduction = {
  type: "selection"
};

fieldsField[]autocast

Autocasts from Object[]

An array of fields in the layer. Each field represents an attribute that may contain a value for each feature in the layer. For example, a field named POP_2015, stores information about total population as a numeric value for each feature; this value represents the total number of people living within the geographic bounds of the feature.

This property must be set in the constructor when creating a FeatureLayer from client-side graphics. To create FeatureLayers from client-side graphics you must also set the source, objectIdField, spatialReference, geometryType, and renderer properties.

See also:

• source

• objectIdField

Example:

// define each field's schema
const fields = [
 new Field({
   name: "ObjectID",
   alias: "ObjectID",
   type: "oid"
 }), new Field({
   name: "description",
   alias: "Description",
   type: "string"
 }), new Field ({
   name: "title",
   alias: "Title",
   type: "string"
 })
];

// See the sample snippet for the source and renderer properties
const layer = new FeatureLayer({
  source: features,
  fields: fields,
  objectIdField: "ObjectID",  // field name of the Object IDs
  geometryType: "point",
  renderer: <renderer>
});

fullExtentExtentautocast inherited

The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.

Example:

// Once the layer loads, set the view's extent to the layer's fullextent
layer.when(function(){
  view.extent = layer.fullExtent;
});

gdbVersionStringreadonly

The version of the geodatabase of the feature service data. Read the Overview of versioning topic for more details about this capability.

geometryTypeString

The geometry type of features in the layer. All features must be of the same type. This property is read-only when the layer is created from a url.

However, when creating a FeatureLayer from client-side graphics, this property must be specified in the layer's constructor along with the source, spatialReference, fields, objectIdField, and renderer properties.

Possible Values: point | mulitpoint | polyline | polygon | extent | mesh

hasAttachmentsBooleanreadonly

Value is true if attachments are enabled on the feature layer.

Default Value:false

hasMBooleanreadonly

Indicates if the features in the layer have M values.

Default Value:false

hasZBooleanreadonly

Indicates if the features in the layer have Z values. See elevationInfo for details regarding placement and rendering of graphics with z-values in 3D SceneViews.

Default Value:false

historicMomentDateautocast

Since: ArcGIS API for JavaScript 4.7

The historic moment to query. If historicMoment is not specified, the query will apply to the current features.

idString inherited

The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.

labelingInfoLabelClass[]autocast

Autocasts from Object[]

The label definition for this layer, specified as an array of LabelClass. Use this property to specify labeling properties for the layer such as label expression, placement, and size.

The labelsVisible property of this layer must be set to true for labels to display in the view.

Multiple Label classes with different where clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks).

Known Limitations

• WebGL must be enabled in 2D MapViews for labels to display. Be sure to review the WebGL limitations.
• Currently only FeatureLayers with point and polygon geometries are supported.
• Currently only one LabelClass is supported in 3D SceneViews.

See also:

• Sample: Add multiple label classes to a layer

• Sample: Multi-line labels

• Sample: Flat vs. volumetric 3D symbol layers

Example:

const statesLabelClass = new LabelClass({
  labelExpressionInfo: { expression: "$feature.NAME" },
  symbol: {
    type: "text",  // autocasts as new TextSymbol()
    color: "black",
    haloSize: 1,
    haloColor: "white"
  }
});

featureLayer.labelingInfo = [ statesLabelClass ];

labelsVisibleBoolean

Indicates whether to display labels for this layer. If true, labels will appear as defined in the labelingInfo property.

Known Limitations

• WebGL must be enabled in 2D MapViews for labels to display. Be sure to review the WebGL limitations.
• Currently only FeatureLayers with point and polygon geometries are supported.
• Currently only one LabelClass is supported in 3D SceneViews.
• Currently the labelsVisible property must be explicitly set to true for labels to be printed.

Default Value:true

layerIdNumber

The layer ID, or layer index, of a Feature Service layer. This is particularly useful when loading a single FeatureLayer with the portalItem property from a service containing multiple layers. You can specify this value in one of two scenarios:

• When loading the layer via the portalItem property.
• When pointing the layer url directly to the Feature Service.

If a layerId is not specified in either of the above scenarios, then the first layer in the service (layerId = 0) is selected.

Examples:

// loads the third layer in the given Portal Item
const layer = new FeatureLayer({
  portalItem: {
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  layerId: 2
});

// If not specified, the first layer (layerId: 0) will be returned
const layer = new FeatureLayer({
  portalItem: {
    id: "8d26f04f31f642b6828b7023b84c2188"
  }
});

// Can also be used if URL points to service and not layer
const layer = new FeatureLayer({
  // Notice that the url doesn't end with /2
  url: "http://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/MonterreyBayCanyon_WFL/FeatureServer",
  layerId: 2
});

// This code returns the same layer as the previous snippet
const layer = new FeatureLayer({
  // The layer id is specified in the URL
  url: "http://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/MonterreyBayCanyon_WFL/FeatureServer/2",
});

legendEnabledBoolean

Indicates whether the layer will be included in the legend.

Default Value:true

listModeString inherited

Indicates how the layer should display in the LayerList widget. The possible values are listed below.

Value	Description
show	The layer is visible in the table of contents.
hide	The layer is hidden in the table of contents.
hide-children	If the layer is a GroupLayer, hide the children layers from the table of contents.

Default Value:show

loadedBooleanreadonly inherited

Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.

Default Value:false

loadErrorErrorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value:null

loadStatusStringreadonly inherited

Represents the status of a load operation.

Value	Description
not-loaded	The object's resources have not loaded.
loading	The object's resources are currently loading.
loaded	The object's resources have loaded without errors.
failed	The object's resources failed to load. See loadError for more details.

Default Value:not-loaded

loadWarningsObject[]readonly inherited

A list of warnings which occurred while loading.

maxScaleNumber

The maximum scale at which the layer is visible in the view. If the map 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.

Default Value:0

Examples:

// The layer will not be visible when the view is zoomed beyond a scale of 1:1,000
layer.maxScale = 1000;

// The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0;

minScaleNumber

The minimum scale at which the layer is visible in the view. If the map 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.

Default Value:0

Examples:

// The layer will not be visible when the view is zoomed beyond a scale of 1:3,000,000
layer.minScale = 3000000;

// The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;

objectIdFieldString

The name of one of the provided fields for each graphic containing a unique value or identifier for that graphic. This is required when constructing a FeatureLayer from a collection of client-side graphics.

When creating a FeatureLayer from client-side graphics, the source, fields, spatialReference, geometryType, and renderer properties must also be set.

See also:

• fields

Example:

// See the sample snippet for the source and fields properties
const layer = new FeatureLayer({
  source: features,
  fields: fields,
  objectIdField: "ObjectID",  // field name of the Object IDs
  geometryType: "point",
  renderer: <renderer>
});

opacityNumber inherited

The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Default Value:1

Example:

// Makes the layer 50% transparent
layer.opacity = 0.5;

outFieldsString[]

An array of field names from the service to include in the FeatureLayer. If not specified, the layer will only return the OBJECTID field. To fetch the values from all fields in the layer, use ["*"]. This is particularly useful when editing features.

Examples:

// Includes all fields from the service in the layer
fl.outFields = ["*"];

// Includes only the specified fields from the service in the layer
fl.outFields = ["NAME", "POP_2010", "FIPS", "AREA"];

popupEnabledBoolean

Indicates whether to display popups when features in the layer are clicked.

Default Value:true

popupTemplatePopupTemplateautocast

The popup template for the layer. When set on the layer, the popupTemplate allows users to access attributes and display their values in the view's popup when a feature is selected using text and/or charts. See the PopupTemplate sample for an example of how PopupTemplate interacts with a FeatureLayer.

portalItemPortalItem

The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to load with the layerId property.

Examples:

// while this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // the first layer in the service is returned
});

// set hostname when using an on-premise portal (default is ArcGIS Online)
// esriConfig.portalUrl = "http://myHostName.esri.com/arcgis";
// while this example uses FeatureLayer, this same pattern can be
// used for SceneLayers
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

refreshIntervalNumber

Since: ArcGIS API for JavaScript 4.6

Refresh interval of the layer in minutes. Minimum refresh interval is 0.1 minute (6 seconds). Value of 0 indicates no refresh.

Default Value:0

Example:

// the layer will be refreshed every 6 seconds.
layer.refreshInterval = 0.1;

rendererRendererautocast

The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions.

However, when creating a FeatureLayer from client-side graphics, this property must be specified in the layer's constructor along with the source, spatialReference, fields, objectIdField, and geometryType properties.

See also:

• Creating visualizations manually

Example:

// all features in the layer will be visualized with
// a 6pt black marker symbol and a thin, white outline
layer.renderer = {
  type: "simple",  // autocasts as new SimpleRenderer()
  symbol: {
    type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
    size: 6,
    color: "black",
    outline: {  // autocasts as new SimpleLineSymbol()
      width: 0.5,
      color: "white"
    }
  }
};

returnMBoolean

When true, indicates that M values will be returned. When false, indicates that M values will never be returned. The layer view determines whether to include M values in feature queries when the property value is undefined.

Default Value:undefined

returnZBoolean

When true, indicates that Z values will always be returned. When false, indicates that Z values will never be returned. The layer view determines whether to include Z values in feature queries when the property value is undefined.

Default Value:undefined

screenSizePerspectiveEnabledBoolean

Since: ArcGIS API for JavaScript 4.4

Apply perspective scaling to screen-size point symbols in a SceneView. When true, screen sized objects such as icons, labels or callouts integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a SceneView.

layer.screenSizePerspectiveEnabled = true

layer.screenSizePerspectiveEnabled = false

Known Limitations

Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. As screen size perspective changes the size based on distance to the camera, it should be set to false when using size visual variables.

Default Value:true

See also:

• Sample: Point styles for cities

sourceCollection<Graphic>autocast

Autocasts from Object[]

A collection of Graphic objects used to create a FeatureLayer. This property should only used when creating a FeatureLayer from client-side graphics. When creating a FeatureLayer from client-side graphics, the fields, objectIdField, spatialReference, geometryType, and renderer properties must also be set.

Example:

var features = [
 {
   geometry: {
     type: "point",
     x: -100,
     y: 38
   },
   attributes: {
     ObjectID: 1,
     DepArpt: "KATL",
     MsgTime: Date.now(),
     FltId: "UAL1"
   }
 },
 {
   geometry: {
     type: "point",
     x: -77,
     y: 35
   },
   attributes: {
     ObjectID: 2,
     DepArpt: "KZBW",
     MsgTime: Date.now(),
     FltId: "SW999"
   }
 },
 {
   geometry: {
     type: "point",
     x: -120,
     y: 40
   },
   attributes: {
     ObjectID: 3,
     DepArpt: "WKRP",
     MsgTime: Date.now(),
     FltId: "Fever1"
   }
 }
];

var layer = new FeatureLayer({
  source: features,  // autocast as a Collection of esri/Graphic
  ...
});

spatialReferenceSpatialReferenceautocast

The spatial reference of the layer. When creating the layer from a url, the spatial reference is read from the service.

This property should be set explicitly when creating a FeatureLayer from client-side graphics. When creating a FeatureLayer from client-side graphics, the fields, objectIdField, source, geometryType, and renderer properties must also be set.

templatesFeatureTemplate[]

Since: ArcGIS API for JavaScript 4.4

An array of feature templates defined in the feature layer. See ArcGIS Pro subtypes document.

titleString

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

When loading a layer by service url, the title is derived from the service name. If the service has several layers, then the title of each layer will be the concatenation of the service name and the layer name. When the layer is loaded from a portal item, the title of the portal item will be used instead. Finally, if a layer is loaded as part of a webmap or a webscene, then the title of the layer as stored in the webmap/webscene will be used.

tokenStringreadonly

Deprecated

• since version 4.8. Will be removed at version 4.9.

Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use IdentityManager.registerToken().

typeStringreadonly

For FeatureLayer the type is feature.

typeIdFieldStringreadonly

Since: ArcGIS API for JavaScript 4.4

The name of the field holding the type ID or subtypes for the features. See ArcGIS Pro subtypes document.

typesFeatureType[]

Since: ArcGIS API for JavaScript 4.4

An array of subtypes defined in the feature service exposed by ArcGIS REST API. Each item includes information about the type, such as the type ID, name, and definition expression.

urlString

The URL of the REST endpoint of the layer or service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online.

If the url points directly to a service, then the layer must be specified in the layerId property. If no layerId is given, then the first layer in the service will be loaded.

Examples:

// Hosted Feature Service on ArcGIS Online
layer.url = "http://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/origins/FeatureServer/0";

// Layer from Map Service on ArcGIS Server
layer.url = "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/2";

// Can also be used if URL points to service and not layer
const layer = new FeatureLayer({
  // Notice that the url doesn't end with /2
  url: "http://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/MonterreyBayCanyon_WFL/FeatureServer",
  layerId: 2
});

versionNumberreadonly

The version of ArcGIS Server in which the layer is published.

Example:

// Prints the version number to the console - e.g. 10.2, 10.3, 10.41, etc.
console.log(layer.version);

visibleBoolean inherited

Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.

Default Value:true

Example:

// The layer is no longer visible in the view
layer.visible = false;

Method Overview

Method Details

applyEdits(edits){Promise<Object>}

Applies edits to features in a feature layer. New features can be created and existing features can be updated or deleted. Feature geometries and/or attributes may be modified. Only applicable to layers in a feature service.

Parameters:

edits Object Object containing features to be added, updated or deleted. Specification: addFeatures Graphic[] optional Array of features to be added. Values of non nullable fields must be provided when adding new features. Date fields must have numeric values representing universal time. updateFeatures Graphic[] optional Array of features to be updated. Each feature must have valid objectId. Values of non nullable fields must be provided when updating features. Date fields must have numeric values representing universal time. deleteFeatures Graphic[]|Object[] optional An array of features or objects to be deleted. When an array of features is passed, each feature must have a valid objectId. When an array of objects is used, each object must have a valid objectId property.

Returns:

Type	Description
Promise<Object>	Resolves to an object containing edit results. See the object specification table below for details. Property Type Description addFeatureResults FeatureEditResult[] Result of adding features. deleteFeatureResults FeatureEditResult[] Result of deleting features. updateFeatureResults FeatureEditResult[] Result of updating features.

See also:

• Sample - Edit features

Example:

function addFeature(geometry) {
  const attributes = {};
  attributes["Description"] = "This is the description";
  attributes["Address"] = "380 New York St";

  // Date.now() returns number of milliseconds elapsed
  // since 1 January 1970 00:00:00 UTC.
  attributes["Report_Date"] = Date.now();

  const addFeature =  new Graphic({
    geometry: geometry,
    attributes: attributes
  });

  const deleteFeature = {
   objectId:  467
  };

  const promise = featureLayer.applyEdits({
    addFeatures: [addFeature],
    deleteFeatures: [deleteFeature]
  });
}

cancelLoad()inherited

Cancels a load() operation if it is already in progress.

createQuery(){Query}

Creates query parameters that can be used to fetch features that satisfy the layer's current filters, and definitions.

Returns:

Type	Description
Query	The query object representing the layer's filters and other definitions.

See also:

• Sample - Query features from a FeatureLayer

Example:

// Get a query object for the layer's current configuration
const queryParams = layer.createQuery();
// set a geometry for filtering features by a region of interest
queryParams.geometry = extentForRegionOfInterest;
// Add to the layer's current definitionExpression
queryParams.where = queryParams.where + " AND TYPE = 'Extreme'";

// query the layer with the modified params object
layer.queryFeatures(queryParams).then(function(results){
  // prints the array of result graphics to the console
  console.log(results.features);
});

emit(type, event)inherited

Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:

type String The name of the event.

event Object The event payload.

fetchAttributionData(){Promise<Object>}inherited

Fetches custom attribution data for the layer when it becomes available.

Returns:

Type	Description
Promise<Object>	Resolves to an object containing custom attribution data for the layer.

getFeatureType(feature){FeatureType}

Since: ArcGIS API for JavaScript 4.7

Returns a FeatureType describing the feature's type. This is applicable if the layer containing the feature has a typeIdField.

Parameter:

feature Graphic A feature from this layer.

Returns:

Type	Description
FeatureType	The FeatureType describing the feature's type.

getFieldDomain(fieldName, options){Domain}

Returns the Domain associated with the given field name. The domain can be either a CodedValueDomain or RangeDomain.

Parameters:

fieldName String Name of the field.

options Object optional An object specifying additional options. See the object specification table below for the required properties of this object. Specification: feature Graphic The feature to which the Domain is assigned.

Returns:

Type	Description
Domain	The Domain object associated with the given field name for the given feature.

Example:

// Get a range domain associated with the first feature
// returned from queryFeatures().
featureLayer.queryFeatures(query).then(function(results){
  const domain = featureLayer.getFieldDomain("Height", {feature: results.features[0]});
  console.log("domain", domain)
});

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

isFulfilled(){Boolean}inherited

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}inherited

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

load(){Promise}inherited

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

Returns:

Type	Description
Promise	Resolves when the resources have loaded.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

type String The name of event to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

queryExtent(params){Promise<Object>}

Executes a Query against the feature service and returns the Extent of features that satisfy the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. This is valid only for hosted feature services on arcgis.com and for ArcGIS Server 10.3.1 and later.

To query for the extent of features/graphics available to or visible in the View on the client rather than making a server-side query, you must use the FeatureLayerView.queryExtent() method.

Parameter:

params Query autocast optional Autocasts from Object Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. If working with a FeatureLayer created from a FeatureCollection (via source), only the geometry, objectIds, and spatialRelationship properties should be specified. Adding any other properties will return an error. If specifying a spatialRelationship, note that intersects is the only supported operation.

Returns:

Type	Description
Promise<Object>	When resolved, returns the extent and count of the features that satisfy the input query. See the object specification table below for details. Property Type Description count Number The number of features that satisfy the input query. extent Extent The extent of the features that satisfy the query.

Examples:

// Queries for the extent of all features matching the layer's configurations
// e.g. definitionExpression
layer.queryExtent().then(function(results){
  // go to the extent of the results satisfying the query
  view.goTo(results.extent);
});

const layer = new FeatureLayer({
  url: fsUrl  // points to a Feature Service layer url
});

const query = new Query();
query.where = "region = 'Southern California'";

layer.queryExtent(query).then(function(results){
  view.goTo(results.extent);  // go to the extent of the results satisfying the query
});

queryFeatureAttachments(feature){Promise<AttachmentInfo[]>}

Since: ArcGIS API for JavaScript 4.7

Query information about attachments associated with a specified feature.

Parameter:

feature Graphic The feature to query.

Returns:

Type	Description
Promise<AttachmentInfo[]>	When resolved, returns an array of AttachmentInfo.

Example:

var featureLayer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/grafitti/FeatureServer/0"
});

// Query a feature layer to return its resulting features
featureLayer.queryFeatures().then(function(results) {
  // Iterate through the queried results
  for (var i = 0, il = results.features.length; i < il; i++) {
    var feature = results.features[i];

    // Query any feature attachments associated with the specified feature
    // to return its associated AttachmentInfo
    featureLayer.queryFeatureAttachments(feature).then(function(info)
      {
        // Iterate through the array of attachments and print its contents to the console
        for (var x = 0, xl = info.length; x < xl; x++) {
          console.log(info[x]);
        }
      })
    }
});

queryFeatureCount(params){Promise<Number>}

Executes a Query against the feature service and returns the number of features that satisfy the query. If no parameters are specified, then the total number of features satisfying the layer's configuration/filters is returned.

To query for the count of features/graphics available to or visible in the View on the client rather than making a server-side query, you must use the FeatureLayerView.queryFeatureCount() method.

Parameter:

params Query autocast optional Autocasts from Object Specifies the attributes and spatial filter of the query. If no parameters are specified, then the total number of features satisfying the layer's configuration/filters is returned. If working with a FeatureLayer created from a FeatureCollection (via source), only the geometry, objectIds, and spatialRelationship properties should be specified. Adding any other properties will return an error. If specifying a spatialRelationship, note that intersects is the only supported operation.

Returns:

Type	Description
Promise<Number>	When resolved, returns an the number of features satisfying the query.

Examples:

// Queries for the count of all features matching the layer's configurations
// e.g. definitionExpression
layer.queryFeatureCount().then(function(numFeatures){
  // prints the total count to the console
  console.log(numFeatures);
});

const layer = new FeatureLayer({
  url: fsUrl  // points to a Feature Service layer url
});

const query = new Query();
query.where = "region = 'Southern California'";

layer.queryFeatureCount(query).then(function(numResults){
  console.log(numResults);  // prints the number of results satisfying the query
});

queryFeatures(params){Promise<FeatureSet>}

Executes a Query against the feature service and returns a FeatureSet, which can be accessed using the .then() method once the promise resolves. A FeatureSet contains an array of Graphic features, which can be added to the view's graphics. This array will not be populated if zero results are found.

To query features/graphics available to or visible in the View on the client rather than making a server-side query, you must use the FeatureLayerView.queryFeatures() method.

Parameter:

params Query autocast optional Autocasts from Object Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. If working with a FeatureLayer created from a FeatureCollection (via source), only the geometry, objectIds, and spatialRelationship properties should be specified. Adding any other properties will return an error. If specifying a spatialRelationship, note that intersects is the only supported operation.

Returns:

Type	Description
Promise<FeatureSet>	When resolved, a FeatureSet containing an array of graphic features is returned.

See also:

• Sample - Query features from a FeatureLayer

Examples:

// Queries for all the features matching the layer's configurations
// e.g. definitionExpression
layer.queryFeatures().then(function(results){
  // prints the array of result graphics to the console
  console.log(results.features);
});

const layer = new FeatureLayer({
  url: fsUrl  // points to a Feature Service layer url
});

const query = new Query();
query.where = "STATE_NAME = 'Washington'";
query.outSpatialReference = { wkid: 102100 };
query.returnGeometry = true;
query.outFields = [ "CITY_NAME" ];

layer.queryFeatures(query).then(function(results){
  console.log(results.features);  // prints the array of features to the console
});

// Get a query object for the layer's current configuration
const queryParams = layer.createQuery();
// set a geometry for filtering features by a region of interest
queryParams.geometry = extentForRegionOfInterest;
// Add to the layer's current definitionExpression
queryParams.where = queryParams.where + " AND TYPE = 'Extreme'";

// query the layer with the modified params object
layer.queryFeatures(queryParams).then(function(results){
  // prints the array of result graphics to the console
  console.log(results.features);
});

queryObjectIds(params){Promise<Number[]>}

Executes a Query against the feature service and returns an array of Object IDs for features that satisfy the input query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned.

To query for ObjectIDs of features/graphics available to or visible in the View on the client rather than making a server-side query, you must use the FeatureLayerView.queryObjectIds() method.

Parameter:

params Query autocast optional Autocasts from Object Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. If working with a FeatureLayer created from a FeatureCollection (via source), only the geometry, objectIds, and spatialRelationship properties should be specified. Adding any other properties will return an error. If specifying a spatialRelationship, note that intersects is the only supported operation.

Returns:

Type	Description
Promise<Number[]>	When resolved, returns an array of numbers representing the object IDs of the features satisfying the query.

Examples:

// Queries for all the Object IDs of features matching the layer's configurations
// e.g. definitionExpression
layer.queryObjectIds().then(function(results){
  // prints the array of Object IDs to the console
  console.log(results);
});

const layer = new FeatureLayer({
  url: fsUrl  // points to a Feature Service layer url
});

const query = new Query();
query.where = "region = 'Southern California'";

layer.queryObjectIds(query).then(function(ids){
  console.log(ids);  // an array of object IDs
});

refresh()

Since: ArcGIS API for JavaScript 4.6

Fetches all the data for the layer.

when(callback, errback){Promise}inherited

Since: ArcGIS API for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:

callback Function optional The function to call when the promise resolves.

errback Function optional The function to execute when the promise fails.

Returns:

Type	Description
Promise	Returns a new promise for the result of callback that may be used to chain additional functions.

Example:

// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

AttachmentInfo

Properties:

contentType String The content type of the attachment. For example, image/jpeg.

id Number The identifier for the attachment.

keywords String Keywords for the attachment.

name String The name of the attachment.

parentObjectId Number The parent object id of the attachment.

size Number The size of the attachment.

url String The URL of the attachment.

FeatureEditResultObject

FeatureEditResult represents the result of adding, updating or deleting a feature.

Properties:

objectId Number Object Id of the feature that was edited.

error Object If the edit failed, the edit result includes an error. Specification: name String Error name. message String Message describing the error.

Event Overview

{view: View,layerView: LayerView}

{view: View,layerView: LayerView}

Event Details

layerview-createinherited

Fires after the layer's LayerView is created and rendered in a view.

Properties:

view View The view in which the layerView was created.

layerView LayerView The LayerView rendered in the view representing the layer in layer.

See also:

• View.whenLayerView()

Example:

// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});

layerview-destroyinherited

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Properties:

view View The view in which the layerView was destroyed.

layerView LayerView The destroyed LayerView representing the layer.