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
});

// Add a non-spatial table.
require(["esri/layers/FeatureLayer"], function(FeatureLayer){
  // points to the non-spatial table in a service storing San Francisco crime incidents.
  const table = new FeatureLayer({
    url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/1"
  });
  table.load().then(function() {
     // table is loaded. ready to be queried on the server.
  });
});

// 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 feature
                     // 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 features 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);
});

Property Overview

Property Details

capabilities Objectreadonly

Describes the layer's supported capabilities.

Properties:

attachment Object Describes what attachment capabilities are enabled on the layer. Specification: supportsName Boolean Indicates if the attachments can be queried by their names. supportsSize Boolean Indicates if the attachments can be queried by their sizes. supportsContentType Boolean Indicates if the attachments can be queried by their content types. supportsKeywords Boolean Indicates if the attachments can be queried by their keywords. supportsExifInfo Boolean Indicates if the attachment queries support exifInfo.

data Object Describes characteristics of the data in the layer. Specification: isVersioned Boolean Indicates if the feature service is versioned. 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 features with z-values in 3D SceneViews.

editing Object Describes editing capabilities that can be performed on the features in the layer via applyEdits(). 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 rollbackOnFailureEnabled parameter can be set to true or false when editing features. 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.

metadata Object Describes the metadata contained on features in the layer. Specification: supportsAdvancedFieldProperties Boolean Indicates whether to provide a user-defined field description. See Describe attribute fields for additional information.

operations Object Describes 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. supportsQueryAttachments Boolean Indicates if the layer supports REST API queryAttachments operation, which is supported with hosted feature services at version 10.5 and greater. If false, queryAttachments() method can only return attachments for one feature at a time. If true, queryAttachments() can return attachments for array of objectIds. 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 Describes query operations that can be performed on features in the layer. Specification: maxRecordCount Number The maximum number of records that will be returned for a given query. 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. supportsDisjointSpatialRelationship Boolean Indicates if the query operation supports disjoint spatial relationship. This is valid only for hosted feature services. supportsCacheHint Boolean Indicates if the query operation supports a cache hint. This is valid only for hosted feature services. 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 supported in ArcGIS Online hosted feature services created since December 2016 and ArcGIS Enterprise feature services since version 10.7. supportsHavingClause Boolean Indicates if the layer supports the having clause on the service. Requires an ArcGIS Server service 10.6.1 or greater. 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. supportsQueryGeometry Boolean Indicates if the query response includes the query geometry. This is valid only for hosted feature services. supportsQuantization Boolean Indicates if the query operation supports the projection of geometries onto a virtual grid. Requires an ArcGIS Server service 10.6.1 or greater. supportsQuantizationEditMode Boolean Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). Requires an ArcGIS Server service 10.6.1 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();
  }
});

copyright String

Copyright information for the layer.

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

definitionExpression String

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.

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";

displayField String

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.

dynamicDataSource DynamicMapLayer|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"
    }
  }
});

editFieldsInfo EditFieldsInforeadonly

Since: ArcGIS API for JavaScript 4.11

The editor tracking fields, which record who adds or edits the data through the feature service and when edits are made.

editingInfo EditingInforeadonly

Since: ArcGIS API for JavaScript 4.12

If present, this value specifies information about editing.

elevationInfo Object

Specifies how features 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 feature 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 Features 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 Features are placed at an elevation relative to the terrain surface. The feature'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 Features are placed at an absolute elevation (z-value) above sea level. This z-value 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 Features are aligned to extruded polygons and objects part of 3D Object SceneLayers or IntegratedMeshLayers, depending on which has higher elevation. If the feature 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. Possible Values:"on-the-ground"|"relative-to-ground"|"absolute-height"|"relative-to-scene"

offset Number optional An elevation offset, which is added to the vertical position of the feature. 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 z-value on the feature. Specification: expression String optional An Arcade expression evaluating to a number that determines the z-value of the feature. If the geometry has z-values, they will be ignored and featureExpressionInfo will be used to calculate the vertical position of the feature. 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"

featureReduction FeatureReductionCluster|FeatureReductionSelectionautocast

Since: ArcGIS API for JavaScript 4.4

Configures the method for reducing the number of point features in the view. By default this property is null, which indicates the layer view should draw every feature.

There are two types of feature reduction: selection and cluster.

• Selection only applies to points in a SceneView and involves thinning overlapping features so no features intersect on screen. This has been available since version 4.4.
• Cluster spatially groups points in a MapView into clusters. The size of each cluster is proportional to the number of features within the cluster. This has been available since version 4.14.

See also:

• Sample - Point clustering

• Sample - Point clustering with visual variables

• Sample - Filter clustered points

• Sample - Point styles for cities

Examples:

// clusters points based on their spatial proximity to other points
layer.featureReduction = {
  type: "cluster",
  clusterRadius: 100
};

// thins features in the view
layer.featureReduction = {
  type: "selection"
};

fields Field[]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 features. To create FeatureLayers from client-side features you must also set the source, objectIdField, spatialReference, geometryType, renderer, and type 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({
  // geometryType and spatialReference are inferred
  // from the input source features
  source: features,
  // Object ID field is inferred from the fields array
  fields: fields,
  renderer: renderer
});

fieldsIndex FieldsIndexreadonly

Since: ArcGIS API for JavaScript 4.12

A convenient property that can be used to make case-insensitive lookups for a field by name. It can also provide a list of the date fields in a layer.

Example:

// lookup a field by name. name is case-insensitive
const field = layer.fieldsIndex.get("SoMeFiEld");

if (field) {
  console.log(field.name); // SomeField
}

fullExtent Extentautocast 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;
});

gdbVersion String

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

geometryType String

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.

When creating a FeatureLayer from client-side features, this property is inferred by the geometryType of the features provided in the layer's source property.

Possible Values:"point"|"multipoint"|"polyline"|"polygon"|"multipatch"|"mesh"

hasM Booleanreadonly

Indicates whether the client-side features in the layer have M (measurement) values. Use the supportsM property in the FeatureLayer's capabilities.data object to verify if M values are supported on feature service features.

Default Value:undefined

hasZ Booleanreadonly

Indicates whether the client-side features in the layer have Z (elevation) values. Refer to elevationInfo for details regarding placement and rendering of features with z-values in 3D SceneViews. Use the supportsZ property in the FeatureLayer's capabilities.data object to verify if Z values are supported on feature service features.

Default Value:undefined

historicMoment Dateautocast

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.

id String inherited

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

isTable Boolean

Since: ArcGIS API for JavaScript 4.11

Returns true if the layer is loaded from a non-spatial table in a service. Non-spatial table does not have a spatial column that represents geographic features.

Default Value:false

labelingInfo LabelClass[]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.

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).

See the Labeling guide page for more information and known limitations.

Known Limitations

• 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 ];

labelsVisible Boolean

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

Known Limitations

• Currently 3D SceneViews only support one LabelClass per feature.

Default Value:true

layerId Number

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",
});

legendEnabled Boolean

Indicates whether the layer will be included in the legend.

Default Value:true

listMode String 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, BuildingSceneLayer, KMLLayer, MapImageLayer, TileLayer or WMSLayer, hide the children layers from the table of contents.

Possible Values:"show"|"hide"|"hide-children"

Default Value:show

loaded Booleanreadonly inherited

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

Default Value:false

loadError Errorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value:null

loadStatus Stringreadonly 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.

Possible Values:"not-loaded"|"loading"|"failed"|"loaded"

Default Value:not-loaded

loadWarnings Object[]readonly inherited

A list of warnings which occurred while loading.

maxScale Number

The maximum scale (most zoomed in) 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. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.

Default Value:0

Examples:

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

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

minScale Number

The minimum scale (most zoomed out) 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. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

Default Value:0

Examples:

// The layer will not be visible when the view is zoomed out 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;

objectIdField String

The name of an oid field containing a unique value or identifier for each feature in the layer. This is required when constructing a FeatureLayer from a collection of client-side features.

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>
});

opacity Number 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;

outFields String[]

An array of field names from the service to include with each feature. To fetch the values from all fields in the layer, use ["*"]. Fields specified in outFields will be requested alongside with required fields for rendering, labeling and setting the elevation info for the layer. The required fields and outFields are used to populate FeatureLayerView.availableFields. Set this property to include the fields that will be used for client-side queries if the fields are not part of required fields used for rendering.

Default Value:null

See also:

• FeatureLayerView.availableFields
• fieldUtils

Examples:

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

// Get the specified fields from the service in the layer
// These fields will be added to FeatureLayerView.availableFields
// along with rendering and labeling fields. Use these fields
// for client-side filtering and querying.
fl.outFields = ["NAME", "POP_2010", "FIPS", "AREA"];

// set the outFields for the layer coming from webmap
webmap.when(function () {
  layer = webmap.layers.getItemAt(1);
  layer.outFields = ["*"];
});

popupEnabled Boolean

Indicates whether to display popups when features in the layer are clicked. The layer needs to have a popupTemplate to define what information should be displayed in the popup. Alternatively, a default popup template may be automatically used if Popup.defaultPopupTemplateEnabled is set to true.

Default Value:true

See also:

• createPopupTemplate

• View

popupTemplate PopupTemplateautocast

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.

A default popup template is automatically used if no popupTemplate has been defined when Popup.defaultPopupTemplateEnabled is set to true.

See also:

• createPopupTemplate

• View

portalItem PortalItem

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
});

refreshInterval Number

Since: ArcGIS API for JavaScript 4.6

Refresh interval of the layer in minutes. Value of 0 indicates no refresh.

Default Value:0

Example:

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

relationships Relationship[]readonly

Since: ArcGIS API for JavaScript 4.9

Array of relationships set up for the layer. Each object in the array describes the layer's relationship with another layer or table.

See also:

• FeatureLayer.queryRelatedFeatures

Example:

// print out layer's relationship length and each relationship info to console
featureLayer.when(function () {
  console.log("layer relationships", featureLayer.relationships.length);

  featureLayer.relationships.forEach(function (relationship) {
    console.log("relationship id:", relationship.id)
    console.log("relationship cardinality:", relationship.cardinality)
    console.log("relationship key field:", relationship.keyField)
    console.log("relationship name:", relationship.name)
    console.log("relationship relatedTableId:", relationship.relatedTableId)
  });
});

renderer Rendererautocast

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 features, this property must be specified in the layer's constructor along with the source, fields, objectIdField 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"
    }
  }
};

returnM Boolean

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

returnZ Boolean

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

screenSizePerspectiveEnabled Boolean

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

source Collection<Graphic>autocast

Autocasts from Object[]

A collection of Graphic objects used to create a FeatureLayer. The geometry of each feature all must have a matching geometryType. This property should only be used when creating a FeatureLayer from client-side features. When creating a FeatureLayer from client-side features, the fields, objectIdField, renderer, and type properties must also be set.

Use applyEdits() method to add, remove, and update features from a layer at runtime. Once applyEdits() resolves successfully, use queryFeatures() to return updated features.

The spatialReference and geometryType properties are determined based on the features provided to this property.

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 new Graphic()
  ...
});

sourceJSON Object

Since: ArcGIS API for JavaScript 4.13

The feature service's metadata JSON exposed by the ArcGIS REST API. While most commonly used properties are exposed on the FeatureLayer class directly, this property gives access to all information returned by the feature service. This property is useful if working in an application built using an older version of the API which requires access to feature service properties from a more recent version.

spatialReference SpatialReferenceautocast

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

When creating a FeatureLayer from client-side features, this property is inferred from the geometries of the features provided in the source property.

templates FeatureTemplate[]

Since: ArcGIS API for JavaScript 4.4

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

timeExtent TimeExtentautocast

Since: ArcGIS API for JavaScript 4.14

The layer's time extent. When the layer's useViewTime is false, the layer instructs the view to show data from the layer based on this time extent. If the useViewTime is true, then this property has no effect on the layer, because the layer will show the data within the view's timeExtent property.

Default Value:null

Examples:

if (!layer.useViewTime) {
  if (layer.timeExtent) {
    console.log("Current timeExtent:", layer.timeExtent.start, " - ", layer.timeExtent.end}
  } else {
    console.log("The layer will display data within the view's timeExtent.");
    console.log("Current view.timeExtent:", view.timeExtent.start, " - ", view.timeExtent.end}
  }
}

// set the timeExtent on the layer and useViewTime false
// In this case, the layer will honor its timeExtent and ignore
// the view's timeExtent
const layer = new ImageryLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ScientificData/SeaTemperature/ImageServer",
  timeExtent: {
    start: new Date(2014, 4, 18),
    end: new Date(2014, 4, 19)
  },
  useViewTime: false
});

timeInfo TimeInfoautocast

Since: ArcGIS API for JavaScript 4.11

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer. The timeInfo property, along with its startField and endField properties, must be set at the time of layer initialization if it is being set for a GeoJSONLayer, CSVLayer or FeatureLayer initialized from client-side features. The fullTimeExtent for timeInfo is automatically calculated based on its startField and endField properties. The timeInfo parameters cannot be changed after the layer is loaded.

Default Value:null

Example:

// create geojson layer from usgs earthquakes geojson feed
const geojsonLayer = new GeoJSONLayer({
  url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_month.geojson",
  copyright: "USGS Earthquakes",
  fields: [
    { "name": "mag", "type": "double" },
    { "name": "place", "type": "string" },
    { "name": "time", "type": "date" }, // date field
    { "name": "depth", "type": "double" }
  ],
  // timeInfo can be used to do temporal queries
  // set the startField and endField.
  // timeExtent is automatically calculated from the
  // the start and end date fields
  timeInfo: {
    startField: "time"
  }
});

timeOffset TimeIntervalautocast

Since: ArcGIS API for JavaScript 4.14

A temporary offset of the time data based on a certain TimeInterval. This allows users to overlay features from two or more time-aware layers with different time extents. For example, if a layer has data recorded for the year 1970, an offset value of 2 years would temporarily shift the data to 1972. You can then overlay this data with data recorded in 1972. A time offset can be used for display purposes only. The query and selection are not affected by the offset.

Default Value:null

Example:

// Offset a CSV Layer containing hurricanes from 2015 so that they appear in 2019 (+4 years).
var layer = new CSVLayer({
  url: `hurricanes-and-storms-2015.csv`,
  timeOffset: {
    value: 4,
    unit: "years"
  },
  timeInfo: {
    startField: "ISO_time"
  },
  renderer: {
    type: "simple",
    symbol: {
      type: "simple-marker",
      size: 6,
      color: "red",
      outline: {
        width: 0.5,
        color: "black"
      }
    }
  }
});

title String

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.

type Stringreadonly

For FeatureLayer the type is feature.

Possible Values:"feature"|"stream"

typeIdField String

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.

types FeatureType[]

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.

url String

The URL of the REST endpoint of the layer, non-spatial table 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
});

// Non-spatial table in San Francisco incidents service.
const table = new FeatureLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/1"
});
// table must be loaded so it can be used in the app.
table.load().then(function() {
  // table is loaded. ready to be queried.
});

useViewTime Boolean

Since: ArcGIS API for JavaScript 4.14

Determines if the layer will update its temporal data based on the view's current timeExtent. When false, the layer will display its temporal data based on the layer's timeExtent, regardless of changes to the view.

Default Value:true

Example:

if (featureLayer.useViewTime) {
  console.log("Displaying data between:", view.timeExtent.start, " - ", view.timeExtent.end);
}

version Numberreadonly

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);

visible Boolean 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

addAttachment(feature, attachment){Promise<FeatureEditResult>}

Since: ArcGIS API for JavaScript 4.9

Adds an attachment to a feature. This operation is available only if the layer's capabilities.data.supportsAttachment is set to true.

Parameters:

feature Graphic Feature to which the attachment is to be added.

attachment HTMLFormElement|FormData HTML form that contains a file upload field pointing to the file to be added as an attachment.

Returns:

Type	Description
Promise<FeatureEditResult>	When resolved, a FeatureEditResult object is returned. FeatureEditResult indicates whether or not the edit was successful. If successful, the objectId of the result is the Id of the new attachment. If unsuccessful, it also includes an error name and error message.

See also:

• capabilities.data.supportsAttachment

Example:

view.when(function () {
  view.on("click", function (event) {

    view.hitTest(event).then(function (response) {
      const feature = response.results[0].graphic;

      // The form is defined as below in the html.
      // For enterprise services:
      // 1. File input name must be "attachment"
      // <form id="attachmentForm">
      //   Select a file: <input type="file" name="attachment">
      // </form>
      const attachmentForm = document.getElementById("attachmentForm");
      const formData = new FormData(attachmentForm);

      // For enterprise services - add input with name:f and value:json
      formData.append("f","json");
      const form = new FormData();
      form.set("attachment", file);
      form.append("f","json")
      var form = document.getElementById("myForm");

      // Add an attachment to the clicked feature.
      // The attachment is taken from the form.
      layer.addAttachment(feature, form).then(function (result) {
        console.log("attachment added: ", result);
      })
      .catch(function (err) {
        console.log("attachment adding failed: ", err);
      });
    });
  });
});

applyEdits(edits, options){Promise<Object>}

Applies edits to features in a 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 and client-side features set through the layer's source.

If client-side features are added, removed or updated at runtime using applyEdits() then use queryFeatures() to return updated features.

Parameters:

Specification:

edits Object Object containing features and attachments to be added, updated or deleted. Specification: addFeatures Graphic[]|Collection<Graphic> optional An array or a collection 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[]|Collection<Graphic> optional An array or a collection 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[]|Collection<Graphic>|Object[] optional An array or a collection of features, or an array of objects with objectId or globalId of each feature to be deleted. When an array or collection of features is passed, each feature must have a valid objectId. When an array of objects is used, each object must have a valid value set for objectId or globalId property. addAttachments AttachmentEdit[] optional An array of attachments to be added. Applies only when the options.globalIdUsed parameter is set to true. User must provide globalIds for all attachments to be added. updateAttachments AttachmentEdit[] optional An array of attachments to be updated. Applies only when the options.globalIdUsed parameter is set to true. User must provide globalIds for all attachments to be updated. deleteAttachments String[] optional An array of globalIds for attachments to be deleted. Applies only when the options.globalIdUsed parameter is set to true.

options Object optional Additional edit options to specify when editing features or attachments. Specification: gdbVersion String optional The geodatabase version to apply the edits. This parameter applies only if the capabilities.data.isVersioned property of the layer is true. If the gdbVersion parameter is not specified, edits are made to the published map’s version. rollbackOnFailureEnabled Boolean optional Indicates whether the edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The layer's capabilities.editing.supportsRollbackOnFailure property must be true if using this parameter. If supportsRollbackOnFailure is false for a layer, then rollbackOnFailureEnabled will always be true, regardless of how the parameter is set. globalIdUsed Boolean optional Indicates whether the edits can be applied using globalIds of features or attachments. This parameter applies only if the layer's capabilities.editing.supportsGlobalId property is true. When false, globalIds submitted with the features are ignored and the service assigns new globalIds to the new features. When true, the globalIds must be submitted with the new features. When updating or deleting existing features, if the globalIdUsed is false, the objectIds of the features to be updated or deleted must be provided. If the globalIdUsed is true, globalIds of features to be updated or deleted must be provided. When adding, updating or deleting attachments, globalIdUsed parameter must be set to true and the attachment globalId must be set. For new attachments, the user must provide globalIds. In order for an attachment to be updated or deleted, clients must include its globalId. Attachments are not supported in an edit payload when globalIdUsed is false.

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. addedAttachments FeatureEditResult[] Result of adding attachments. deletedAttachments FeatureEditResult[] Result of deleting attachments. updatedAttachments FeatureEditResult[] Result of updating attachments.

See also:

• Sample - Edit features

Examples:

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 deleteFeatures = [
    { objectId: 467 },
    { objectId: 500 }
  ];

  // or specify globalIds of features to be deleted
  // const deleteFeature = [
  //  { globalId: "18633204-1801-4d35-a73a-174563608ad9" }
  // ];

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

function addAttachment(selectedFeature) {
  const blob = new Blob(byteArrays, { type: "image/png" });
  addAttachments.push({
    feature: selectedFeature,
    attachment: {
      globalId: "8c4d6085-a33c-42a0-8e11-21e9528bca0d",
      name: "brokenLight",
      data: blob
    }
  });

  const edits = {
    addAttachments: addAttachments
  };

  const options = {
    // globalIdUsed has to be true when adding, updating or deleting attachments
    globalIdUsed: true,
    rollbackOnFailureEnabled: true
  };

  featureLayer.applyEdits(edits, options).then(function(results) {
    console.log("edits added: ", results);
  });
}

cancelLoad()inherited

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

createLayerView(view, options){Promise<LayerView>}inherited

Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.

Parameters:

view * The parent view.

options Object optional An object specifying additional options. See the object specification table below for the required properties of this object. Specification: signal AbortSignal optional A signal to abort the creation of the layerview.

Returns:

Type	Description
Promise<LayerView>	Resolves with a LayerView instance.

See also:

• Sample - Custom WebGL layer view

createPopupTemplate(options){PopupTemplate}

Since: ArcGIS API for JavaScript 4.11

Creates a popup template for the layer, populated with all the fields of the layer.

Parameters:

Specification:

options Object optional Options for creating the popup template. Specification: maximumFields Number optional Default Value: 75 The maximum number of fields to include in the popup template. ignoreFieldTypes String[] optional Field types to ignore when creating the popup. By default the geometry, blob, raster, guid and xml field types are ignored.

Returns:

Type	Description
PopupTemplate	The popup template, or null if the layer does not have any fields.

createQuery(){Query}

Creates query parameter object that can be used to fetch features that satisfy the layer's configurations such as definitionExpression, gdbVersion, and historicMoment. It will return Z and M values based on the layer's data capabilities. It sets the query parameter's outFields property to ["*"]. The results will include geometries of features and values for all available fields for client-side queries or all fields in the layer for server side queries.

Returns:

Type	Description
Query	The query object representing the layer's definition expression and other configurations.

See also:

• Sample - Query features from a FeatureLayer

Examples:

// this snippet shows the query parameter object that is returned
// from FeatureLayer.createQuery().
const queryParams = new Query();
const dataCapabilities = this.get<DataCapabilities>("capabilities.data");

queryParams.gdbVersion = layer.gdbVersion;
queryParams.historicMoment = layer.historicMoment;
queryParams.returnGeometry = true;

if (layer.capabilities.data) {
  if (layer.capabilities.data.supportsZ && this.returnZ != null) {
    queryParams.returnZ = layer.returnZ;
  }

  if (layer.capabilities.data && layer.returnM != null) {
    queryParams.returnM = layer.returnM;
  }
}

queryParams.outFields = ["*"];
queryParams.where = this.definitionExpression || "1=1";
queryParams.multipatchOption = layer.geometryType === "multipatch" ? "xyFootprint" : null;

// Get a query object for the layer's current configuration
// queryParams.outFields will be set to ["*"] to get values
// for all available fields.
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);
});

deleteAttachments(feature, attachmentIds){Promise<FeatureEditResult>}

Since: ArcGIS API for JavaScript 4.9

Deletes attachments from a feature. This operation is available only if the layer's capabilities.data.supportsAttachment is set to true.

Parameters:

feature Graphic Feature containing attachments to be deleted.

attachmentIds Number[] Ids of the attachments to be deleted.

Returns:

Type	Description
Promise<FeatureEditResult>	When resolved, a FeatureEditResult object is returned. FeatureEditResult indicates whether or not the edit was successful. If successful, the objectId of the result is the Id of the new attachment. If unsuccessful, it also includes an error name and error message.

See also:

• capabilities.data.supportsAttachment

emit(type, event){Boolean}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 optional The event payload.

Returns:

Type	Description
Boolean	true if a listener was notified

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.

getField(fieldName){Field}

Since: ArcGIS API for JavaScript 4.11

Returns the Field instance for a field name (case-insensitive).

Parameter:

fieldName String Name of the field.

Returns:

Type	Description
Field	the matching field or undefined

See also:

• fields

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(signal){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.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameter:

signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

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|String[] A event type, or an array of event types, 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(s). Property Type Description remove Function When called, removes the listener from the event.

Example:

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

queryAttachments(attachmentQuery, options){Promise<Object>}

Since: ArcGIS API for JavaScript 4.9

Query information about attachments associated with features. It will return an error if the layer's capabilities.data.supportsAttachment property is false. Attachments for multiple features can be queried if the layer's capabilities.operations.supportsQueryAttachments is true.

Known Limitations

When the layer's capabilities.operations.supportsQueryAttachments property is false, AttachmentQuery.objectIds property only accepts a single objectId.

Parameters:

attachmentQuery AttachmentQuery autocast Autocasts from Object Specifies the attachment parameters for query.

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:

Type	Description
Promise<Object>	When resolved, returns an object containing AttachmentInfos grouped by the source feature objectIds.

See also:

• capabilities.data.supportsAttachment
• capabilities.operations.supportsQueryAttachments

Example:

featureLayer.when(function () {
  // queryObjectIds for all features within the layer
  featureLayer.queryObjectIds().then(function (objectIds) {
    // Define parameters for querying attachments,
    // query features where objectIds are less than 735,
    // and only query jpeg attachments for these features.
    var attachmentQuery = {
      objectIds: objectIds,
      definitionExpression: "OBJECTID < 735",
      attachmentTypes: ["image/jpeg"]
    };

    // Only pass in one objectId for attachmentQuery.objectIds
    // if the layer's capabilities.operations.supportsQueryAttachments is false
    featureLayer.queryAttachments(attachmentQuery).then(function (attachments) {
      // Print out all returned attachment infos to the console.
      attachmentQuery.objectIds.forEach(function (objectId) {
        if (attachments[objectId]) {
          var attachment = attachments[objectId];
          console.group("attachment for", objectId);
          attachment.forEach(function (item) {
            console.log("attachment id", item.id);
            console.log("content type", item.contentType);
            console.log("name", item.name);
            console.log("size", item.size);
            console.log("url", item.url);
            console.groupEnd();
          });
        }
      });
    })
    .catch(function (error) {
      console.log("attachment query error", error);
    })
  });
});

queryExtent(query, options){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.

Parameters:

query 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.

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

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
});

queryFeatureCount(query, options){Promise<Number>}

Executes a Query against the feature service and returns the number of features that satisfy the query. If no parameters are specified, 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.

Parameters:

query Query autocast optional Autocasts from Object Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned.

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

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(query, options){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. See the querying section for more information on how to query features from a layer.

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.

Parameters:

query 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.

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

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);
});

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

// query all features from the layer and only return
// attributes specified in outFields.
const query = { // autocasts as Query
  where: "1=1", // select all features
  returnGeometry: false,
  outFields: ["State_Name", "City_Name", "pop2010"]
};

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

queryObjectIds(query, options){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.

Parameters:

query 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.

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

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
});

queryRelatedFeatures(relationshipQuery, options){Promise<Object>}

Since: ArcGIS API for JavaScript 4.9

Executes a RelationshipQuery against the feature service and returns FeatureSets grouped by source layer or table objectIds.

Parameters:

relationshipQuery RelationshipQuery autocast Autocasts from Object Specifies relationship parameters for querying related features or records from a layer or a table.

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:

Type	Description
Promise<Object>	When resolved, returns FeatureSets grouped by source layer/table objectIds. Each FeatureSet contains an array of Graphic features including the values of the fields requested by the user.

See also:

• FeatureLayer.relationships

Example:

const objectIds = [385, 416];

// relationship query parameter
const query = {
  outFields: ["*"],
  relationshipId: relationshipId,
  objectIds: objectIds
}

// query related features for given objectIds
featureLayer.queryRelatedFeatures(query).then(function (result) {
  objectIds.forEach(function (objectId) {
    // print out the attributes of related features if the result
    // is returned for the specified objectId
    if (result[objectId]) {
      console.group("relationship for feature:", objectId)
      result[objectId].features.forEach(function (feature) {
        console.log("attributes", JSON.stringify(feature.attributes));
      });
      console.groupEnd();
    }
  });
}).catch(function (error) {
  console.log("error from queryRelatedFeatures", error);
});

refresh()

Since: ArcGIS API for JavaScript 4.6

Fetches all the data for the layer.

updateAttachment(feature, attachmentId, attachment){Promise<FeatureEditResult>}

Since: ArcGIS API for JavaScript 4.9

Updates an existing attachment for a feature. This operation is available only if the layer's capabilities.data.supportsAttachment is set to true.

Parameters:

feature Graphic The feature containing the attachment to be updated.

attachmentId Number Id of the attachment to be updated.

attachment HTMLFormElement|FormData HTML form that contains a file upload field pointing to the file to be added as an attachment.

Returns:

Type	Description
Promise<FeatureEditResult>	When resolved, a FeatureEditResult object is returned. FeatureEditResult indicates whether or not the edit was successful. If successful, the objectId of the result is the Id of the new attachment. If unsuccessful, it also includes an error name and error message.

See also:

• capabilities.data.supportsAttachment

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

AttachmentEdit Object

AttachmentEdit represents an attachment that can be added, updated or deleted via applyEdits. This object can be either pre-uploaded data or base 64 encoded data.

Properties:

feature Graphic|Number|String The feature, objectId or globalId of feature associated with the attachment.

attachment Object The attachment to be added, updated or deleted. Specification: globalId String The globalId of the attachment to be added or updated. name String optional The name of the attachment. This parameter must be set if the attachment type is Blob. contentType String optional The content type of the attachment. For example, 'image/jpeg'. See the ArcGIS REST API documentation for more information on supported attachment types. uploadId String optional The id of pre-loaded attachment. data Blob|File|String optional The attachment data.

EditFieldsInfo Object

Since: ArcGIS API for JavaScript 4.11

The fields that record who adds or edits data in the feature service and when the edit is made.

Properties:

creatorField String The name of the field that stores the name of the user who created the feature.

creationDateField String The name of the field that stores the date and time the feature was created.

editorField String The name of the field that stores the name of the user who last edited the feature.

editDateField String The name of the field that stores the date and time the feature was last edited.

EditingInfo Object

Since: ArcGIS API for JavaScript 4.12

Specifies information about editing.

Property:

lastEditDate Date Indicates the last time the layer was edited. This value gets updated every time the layer's data is edited or when any of its properties change.

FeatureEditResult Object

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

Properties:

objectId Number The objectId of the feature or the attachmentId of the attachment that was edited.

globalId String The globalId of the feature or the attachment 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

{addedFeatures: FeatureEditResult[],deletedFeatures: FeatureEditResult[],updatedFeatures: FeatureEditResult[],addedAttachments: FeatureEditResult[],deletedAttachments: FeatureEditResult[],updatedAttachments: FeatureEditResult[]}

{view: View,layerView: LayerView}

{view: View,error: Error}

{view: View,layerView: LayerView}

Event Details

edits

Since: ArcGIS API for JavaScript 4.12

Fires after applyEdits() is completed successfully. The event payload includes only successful edits, not the failed edits.

Properties:

addedFeatures FeatureEditResult[] An array of successfully added features.

deletedFeatures FeatureEditResult[] An array of successfully deleted features.

updatedFeatures FeatureEditResult[] An array of successfully updated features.

addedAttachments FeatureEditResult[] An array of successfully added attachments.

deletedAttachments FeatureEditResult[] An array of successfully deleted attachments.

updatedAttachments FeatureEditResult[] An array of successfully updated attachments.

See also:

• applyEdits()

Example:

// This function will fire each time applyEdits() is completed successfully
featureLayer.on("edits", function(event) {

  const extractObjectId = function(result) {
    return result.objectId;
  };

  const adds = event.addedFeatures.map(extractObjectId);
  console.log("addedFeatures: ", adds.length, adds);

  const updates = event.updatedFeatures.map(extractObjectId);
  console.log("updatedFeatures: ", updates.length, updates);

  const deletes = event.deletedFeatures.map(extractObjectId);
  console.log("deletedFeatures: ", deletes.length, deletes);
});

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-create-errorinherited

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

Properties:

view View The view that failed to create a layerview for the layer emitting this event.

error Error An error object describing why the layer view failed to create.

See also:

• View.whenLayerView()

Example:

// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
  console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});

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.