require(["esri/layers/FeatureLayer"], function(FeatureLayer) { /* code goes here */ });
Class: esri/layers/FeatureLayer
Inheritance: FeatureLayer Layer Accessor
Subclasses: StreamLayer
Since: ArcGIS API for JavaScript 4.0

Overview

A FeatureLayer is a single layer that can be created from a Map Service or Feature Service; ArcGIS Online or ArcGIS for Portal items; or from an array of client-side graphics. It is composed of discrete features, each of which has a Geometry that allows it to be rendered in either a 2D MapView or 3D SceneView as a graphic with spatial context. Features also contain data attributes that provide additional information about the real-world feature it represents; attributes may be viewed in popup windows and used for rendering the layer. FeatureLayers may be queried, analyzed, and rendered to visualize data in a spatial context.

Known Limitations

Some features may not be visible in the view because of present limitations of the fetch strategy in the API. The fetch strategy will continually improve as needed in future versions.

An instance of this class is also a Promise. This allows you to execute code once the promise resolves, or when the layer finishes loading its resources. See then() for additional details.

Creating a FeatureLayer

FeatureLayers may be created in one of three ways: from a service URL, an ArcGIS Portal item ID, or from an array of client-side graphics.

Reference a service URL

To create a FeatureLayer instance from a service, you must set the url property to the REST endpoint of a layer in either a Feature Service or a Map Service. For a layer to be visible in a view, it must be added to the Map referenced by the view. See Map.add() for information about adding layers to a map.

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

If the service is requested from a different domain, a CORS enabled server or a proxy is required. If CORS is enabled on the server add the service domain to esriConfig.request.corsEnabledServers. Alternatively, if CORS cannot be enabled on ArcGIS Server you can set up a proxy on your web server and then add it to the proxy rules list in esriConfig using addProxyRule().

Reference an ArcGIS Portal Item ID

You can also create a FeatureLayer from its ID if it exists as an item in ArcGIS Online or ArcGIS for Portal. For example, the following snippet shows how to add a new FeatureLayer instance to a map using the portalItem property.

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

Add an array of client-slide graphics

Client-side graphics may also be used to create a FeatureLayer. Since the FeatureLayer requires a schema, several properties need to be set when creating a layer from an array of graphics. The geometry type of the features must be indicated (since only one geometry type is allowed per layer) using the geometryType property along with a valid spatial reference. An ObjectID field must be indicated along with an array of field objects, providing the schema of each field. Once those properties are specified, the array of graphics must be set to the source property. There is no limit to the number of graphics that may be added to a FeatureLayer via source.

var lyr = 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(lyr);

Querying

Features within a FeatureLayer are rendered as graphics inside a LayerView. Therefore the graphics visible in a view are accessed via the LayerView, not the FeatureLayer. To access features visible in the view, use the query methods in the FeatureLayerView.

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

When accessing features from a query on the FeatureLayerView, note that features are returned as they are displayed in the view, including any generalization that may have been applied to the features to enhance performance. To obtain feature geometries at full resolution, use the queryFeatures() method on the FeatureLayer.

The query methods methods in the FeatureLayer class query features directly from the service. For example, the following snippet returns all features from the service, not just the features drawn in the FeatureLayerView.

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

For information regarding how to create a LayerView for a particular layer, see View.whenLayerView().

Data Visualization

Features in a FeatureLayer are visualized by setting a Renderer to the renderer property of the layer. Features may be visualized with the same symbol using SimpleRenderer, by type with UniqueValueRenderer, with class breaks using ClassBreaksRenderer, or with continuous color, size, or opacity schemes using visual variables in any of the renderers. See the documentation for Renderer and the Creating visualizations manually guide for more information about the various visualization options for Feature Layers.

See also:

Constructors

new FeatureLayer(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:
// Typical usage
var layer = new FeatureLayer({
  // URL to the service
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0"
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummary
Object

Indicates the layer's supported capabilities.

more details
more details
String

The copyright text as defined by the map service.

more details
more details
String

The name of the class.

more details
more details
String

The SQL where clause used to filter features on the client.

more details
more details
Object

Specifies how graphics are placed on the vertical axis (z).

more details
more details
Field[]

An array of fields in the layer.

more details
more details
Extent

The full extent of the layer.

more details
more details
String

The version of the geodatabase of the feature service data.

more details
more details
String

The geometry type of features in the layer.

more details
more details
Boolean

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

more details
more details
Boolean

Indicates if the features in the layer have M values.

more details
more details
Boolean

Indicates if the features in the layer have Z values.

more details
more details
String

The unique ID assigned to the layer.

more details
more details
LabelClass[]

The label definition for this layer, specified as an array of LabelClass.

more details
more details
Boolean

Indicates whether to display labels for this layer.

more details
more details
Number

The layer ID, or layer index, of a Feature Service layer.

more details
more details
Boolean

Indicates whether the layer will be included in the legend.

more details
more details
String

Indicates how the layer should display in the LayerList widget.

more details
more details
Boolean

Indicates whether the layer's resources have loaded.

more details
more details
Error

The Error object returned if an error occurred while loading.

more details
more details
String

Represents the status of a load operation.

more details
more details
Object[]

A list of warnings which occurred while loading.

more details
more details
Number

The maximum scale at which the layer is visible in the view.

more details
more details
Number

The minimum scale at which the layer is visible in the view.

more details
more details
String

The name of one of the provided fields for each graphic containing a unique value or identifier for that graphic.

more details
more details
Number

The opacity of the layer.

more details
more details
String[]

An array of field names from the service to include in the FeatureLayer.

more details
more details
Boolean

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

more details
more details
PopupTemplate

The popup template for the layer.

more details
more details
PortalItem

The portal item from which the layer is loaded.

more details
more details
Renderer

The renderer assigned to the layer.

more details
more details
Boolean

When true, indicates that M values will be returned.

more details
more details
Boolean

When true, indicates that Z values will be returned.

more details
more details
Collection

A collection of Graphic objects used to create a FeatureLayer.

more details
more details
SpatialReference

The spatial reference of the layer.

more details
more details
String

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

more details
more details
String

Token generated by the token service using the specified userId and password.

more details
more details
String

For FeatureLayer the type is feature.

more details
more details
String

The URL of the REST endpoint of the layer or service.

more details
more details
Number

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

more details
more details
Boolean

Indicates if the layer is visible in the MapView or SceneView.

more details
more details

Property Details

capabilitiesObject

Indicates the layer's supported capabilities.

Properties:
operations Object

Incidates operations that can be performed on features in the layer.

Specification:
supportsAdd Boolean

Indicates if features can be added to the layer.

supportsDelete Boolean

Indicates if new 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.

supportsQuery Boolean

Indicates if features in the layer can be queried.

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

The copyright text as defined by the map service.

declaredClassStringreadonly

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.

Examples:
// Set definition expression in constructor to only display trees with scientific name Ulmus pumila
var 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";

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.

ModeDescription
on-the-groundGraphics 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-groundThe graphic is placed at an elevation relative to the terrain surface. The graphic's elevation is determined by summing up the terrain elevation, the offset value and the geometry's z-value (if present). This is the default value for Point geometries rendered with IconSymbol3DLayers.
absolute-heightGraphics are placed at an absolute height above sea level. This height is determined by summing up the offset value and the geometry's z-value (if present). It 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.
offset Number
optional

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

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, and geometryType properties.

See also:
Example:
// define each field's schema
var 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 property
var layer = new FeatureLayer({
  source: features,
  fields: fields,
  objectIdField: "ObjectID",  // field name of the Object IDs
  geometryType: "point"
});

fullExtentExtent autocast

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.then(function(){
  view.extent = layer.fullExtent;
});

gdbVersionString

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 propety must be specified in the layer's constructor along with the source, spatialReference, fields, and objectIdField properties.

Possible Values: point | mulitpoint | polyline | polygon

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

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

labelingInfoLabelClass[]

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.

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

Known Limitations

There is no support for labeling in 2D. Labeling is only supported in 3D SceneViews.

See also:
Example:
var statesLabelClass = new LabelClass({
  labelExpressionInfo: { value: "{NAME}" },
  symbol: new TextSymbol({
    color: "black",
    haloSize: 1,
    haloColor: "white"
  })
});

featureLayer.labelsVisible = true;
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

There is no support for labeling in 2D. Labeling is only supported in 3D SceneViews.

Default Value: false
See also:

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
var lyr = new FeatureLayer({
  portalItem: {
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  layerId: 2
});
// If not specified, the first layer (layerId: 0) will be returned
var lyr = new FeatureLayer({
  portalItem: {
    id: "8d26f04f31f642b6828b7023b84c2188"
  }
});
// Can also be used if URL points to service and not layer
var lyr = 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
var lyr = 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

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

ValueDescription
showThe layer is visible in the table of contents.
hideThe layer is hidden in the table of contents.
hide-childrenIf the layer is a GroupLayer, hide the children layers from the table of contents.
Default Value: show

loadedBooleanreadonly

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

Default Value: false

loadErrorErrorreadonly

The Error object returned if an error occurred while loading.

Default Value: null

loadStatusStringreadonly

Represents the status of a load operation.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe object's resources failed to load. See loadError for more details.
Default Value: not-loaded

loadWarningsObject[]readonly

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, and geometryType properties must also be set.

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

opacityNumber

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

popupTemplatePopupTemplate autocast

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

rendererRenderer

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.

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

returnMBoolean

When true, indicates that M values will be returned.

Default Value: false

returnZBoolean

When true, indicates that Z values will be returned.

Default Value: false

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, and geometryType properties must also be set.

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

var lyr = new FeatureLayer({
  source: features,  // autocast as an array of esri/Graphic
  ...
});

spatialReferenceSpatialReference autocast

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, and geometryType properties must also be set.

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.

tokenString

Token generated by the token service using the specified userId and password.

typeStringreadonly

For FeatureLayer the type is feature.

The URL of the REST endpoint of the layer or service. The URL may either point to a resource on ArcGIS for Server, Portal for ArcGIS, 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
var lyr = 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

Indicates if the layer is visible in the MapView or SceneView. 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

NameReturn TypeSummary
Promise

An instance of this class is a Promise.

more details
more details
Promise

Applies edits to features in a feature layer.

more details
more details

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

more details
more details
Query

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

more details
more details
Promise

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

more details
more details
Domain

Returns the Domain associated with the given field name.

more details
more details
Boolean

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

more details
more details
Boolean

An instance of this class is a Promise.

more details
more details
Boolean

An instance of this class is a Promise.

more details
more details
Boolean

An instance of this class is a Promise.

more details
more details
Promise

Loads the resources referenced by this class.

more details
more details
Object

Registers an event handler on the instance.

more details
more details
Promise

An instance of this class is a Promise.

more details
more details
Promise

Executes a Query against the feature service and returns the Extent of features that satisfy the query.

more details
more details
Promise

Executes a Query against the feature service and returns the number of features that satisfy the query.

more details
more details
Promise

Executes a Query against the feature service and returns a FeatureSet, which can be accessed using the .then() method once the promise resolves.

more details
more details
Promise

Executes a Query against the feature service and returns an array of Object IDs for features that satisfy the input query.

more details
more details
Promise

An instance of this class is a Promise.

more details
more details

Method Details

always(callbackOrErrback){Promise}inherited

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:
callbackOrErrback Function
optional

The function to execute when the promise is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
Example:
// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

applyEdits(edits){Promise}

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:
TypeDescription
PromiseResolves to an object containing edit results. See the object specification table below for details.
PropertyTypeDescription
addFeatureResultsFeatureEditResult[]Result of adding features.
deleteFeatureResultsFeatureEditResult[]Result of deleting features.
updateFeatureResultsFeatureEditResult[]Result of updating features.
See also:
Example:
function addFeature(geometry) {
  var 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();

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

  var deleteFeature = {
   objectId:  467
  };

  var 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:
TypeDescription
QueryThe query object representing the layer's filters and other definitions.
See also:
Example:
// Get a query object for the layer's current configuration
var 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);
});

fetchAttributionData(){Promise}inherited

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

Returns:
TypeDescription
PromiseResolves to an object containing custom attribution data for the layer.

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:
TypeDescription
DomainThe 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){
  var 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:
TypeDescription
BooleanReturns true if the class supports the input event.

isFulfilled(){Boolean}inherited

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been rejected.

isResolved(){Boolean}inherited

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been resolved.

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:
TypeDescription
PromiseResolves 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. See the Events summary table for a list of listened events.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

otherwise(errback){Promise}inherited

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:
errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
Example:
// Although this example uses MapView, any class instance that is a promise may use otherwise() in the same way
var view = new MapView();
view.otherwise(function(error){
  // This function will execute if the promise is rejected due to an error
});

queryExtent(params){Promise}

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
optional

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:
TypeDescription
PromiseWhen resolved, returns the extent and count of the features that satisfy the input query. See the object specification table below for details.
PropertyTypeDescription
countNumberThe number of features that satisfy the input query.
extentExtentThe 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);
});
var lyr = new FeatureLayer({
  url: fsUrl  // points to a Feature Service layer url
});

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

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

queryFeatureCount(params){Promise}

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
optional

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:
TypeDescription
PromiseWhen 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);
});
var lyr = new FeatureLayer({
  url: fsUrl  // points to a Feature Service layer url
});

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

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

queryFeatures(params){Promise}

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
optional

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:
TypeDescription
PromiseWhen resolved, a FeatureSet containing an array of graphic features is returned.
See also:
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);
});
var lyr = new FeatureLayer({
  url: fsUrl  // points to a Feature Service layer url
});

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

lyr.queryFeatures(query).then(function(results){
  console.log(results.graphics);  // prints the array of graphics to the console
});
// Get a query object for the layer's current configuration
var 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}

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
optional

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:
TypeDescription
PromiseWhen 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);
});
var lyr = new FeatureLayer({
  url: fsUrl  // points to a Feature Service layer url
});

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

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

then(callback, errback, progback){Promise}inherited

An instance of this class is a Promise. Therefore then() 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 promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

progback Function
optional

The function to invoke when the promise emits a progress update.

Returns:
TypeDescription
PromiseReturns 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.then(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

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

NameTypeSummary
{view: View,layerView: LayerView}

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

more details
more details
{view: View,layerView: LayerView}

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

more details
more details

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

API Reference search results

NameTypeModule

There were no match results from your search criteria.