FeatureLayer | References | ArcGIS Maps SDK for JavaScript

import FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";

Inheritance:: FeatureLayer→Layer→Accessor

Subclasses:: OrientedImageryLayer

Since: ArcGIS Maps SDK 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 Enterprise portal items; or from an array of client-side features. The layer can be either a spatial (has geographic features) or non-spatial (table).

Spatial layer 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 Graphic.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.

Non-spatial layer is a table which does not have a spatial column representing geographic features.

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

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.

const FeatureLayer = await $arcgis.import("@arcgis/core/layers/FeatureLayer.js");
// 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

Non-spatial table instance can be created from the table url in a service and the table must be loaded by calling load() method.

// Add a non-spatial table.
const FeatureLayer = await $arcgis.import("@arcgis/core/layers/FeatureLayer.js");
// 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.
});

If the service is requested from a different domain, a CORS enabled server or a proxy is required.

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 Enterprise. 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
const fl = new FeatureLayer({
  portalItem: { // autocasts as esri/portal/PortalItem
    id: "8444e275037549c1acab02d2626daaee"
  }
});
map.add(fl);  // adds the layer to the map

The following snippet shows how to create a FeatureLayer referencing a table using the portalItem property.

// points to a hosted table in ArcGIS Online
const table = new FeatureLayer({
  portalItem: { // autocasts as esri/portal/PortalItem
    id: "123f4410054b43d7a0bacc1533ceb8dc"
  }
});

// Before adding the table to the map, it must first be loaded and confirm it is the right type.
table.load().then(function() {
  if (table.isTable) {
    map.tables.add(table);
  }
});

Add an array of client-side features

A FeatureLayer can be created from client-side features such as an array of graphics. These graphics may have geometries for spatial layers or may be non-spatial. If the graphics do not include geometries and the geometryType is null, the resulting layer will be a non-spatial FeatureLayer. Since a FeatureLayer requires a defined schema, several properties must be specified when initializing a layer with client-side data.

Automatic property inference: If required properties are not explicitly set, the API attempts to infer values from the provided parameters or features in the source. For example, the spatialReference, geometryType, hasZ and hasM properties can be derived from the features provided in the source. However, if the source is an empty array at the time of initialization, the geometryType cannot be inferred, and the layer will fail to initialize when the layer is added to the map.

Geometry type and spatial reference: For spatial data, the geometryType must be defined explicitly, if the source is empty at the time layer's initialization. A valid spatialReference is also required.

Field schema: Both spatial and non-spatial feature collections must include an objectIdField, which provides a unique identifier for each feature. This must be indicated along with an array of field objects, providing the schema of each field. Certain characters are not supported in field names. See field naming guidelines for details. If the data includes date fields with values recorded in a time zone other than UTC, the dateFieldsTimeZone property should be set to ensure correct results in date-based queries.

Once all required properties are configured, the array of features must be assigned to the source property. See create a FeatureLayer with client-side graphics sample.

Runtime updates: FeatureLayer's source is not updated after the FeatureLayer is initialized. If features are added, removed or updated at runtime, then use applyEdits() to update the features then use queryFeatures() to return updated features. Check out Working with large feature collections to see this in action.

Attribute values used in attribute queries executed against client-side feature layer, and layer views are case sensitive.

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"
  },{
    name: "recordedDate",
    alias: "recordedDate",
    type: "date"
  }],
  dateFieldsTimeZone: "America/New_York", // date field values in are eastern time zone
  objectIdField: "ObjectID", // inferred from fields array if not specified
  geometryType: "point", // geometryType and spatialReference are inferred from the first feature
                         // in the source array if they are not specified.
  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: popupTemplate,
  // a default simple renderer will be applied if not set.
  renderer: uvRenderer  // UniqueValueRenderer based on `type` attribute
});
map.add(layer);

A client-side non-spatial table can be created by setting the layer's geometryType property to null, then the table must be loaded by calling the load() method.

// Create an empty non-spatial feature layer
// Set geometryType property to null when creating non-spatial feature layer
const layer = new FeatureLayer({
  source: [],
  objectIdField: "OBJECTID",
  fields: [{
    name: "OBJECTID",
    type: "oid"
  },
  {
    name: "type",
    type: "string",
  }],
  geometryType: null
});
layer.load().then(() => console.log(layer.isTable))

Querying

Features within a FeatureLayer are rendered as features inside a FeatureLayerView. A FeatureLayerView may or may not have all features from the associated FeatureLayer. To determine this, check the FeatureLayerView.hasAllFeatures property on the FeatureLayerView. If hasAllFeatures is true, the FeatureLayerView has all features from the layer, not just those visible in the view extent.

When hasAllFeatures is true, calling FeatureLayerView.queryFeatures() on the FeatureLayerView runs against all features in the layer. Otherwise, the FeatureLayerView.queryFeatures() runs only against features available for drawing in the FeatureLayerView. To limit the query to features currently visible in the view when hasAllFeatures is true, set the query’s Query.geometry property to the View's View2D.extent.

// returns all the graphics from the layer view
view.whenLayerView(layer).then((layerView) => {
  reactiveUtils.when(
    () => !layerView.updating,
    (val) => {
      const query = layerView.createQuery();
     // check if layerView has all features in the layer
     // if true, set query.geoemtry to view.extent to run
     // the query against features visible in the view
      if (layerView.hasAllFeatures) {
        query.geometry = view.extent;
      }

      layerView.queryFeatures(query).then((results) =>{
        console.log(results);
      });
    }
  );
});

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, first check the FeatureLayerView’s FeatureLayerView.hasFullGeometries property; if it is true, use the FeatureLayerView.queryFeatures() method on the FeatureLayerView; otherwise, use the queryFeatures() method on the FeatureLayer.

The query 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((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. See the Styles and data visualization guide for a comprehensive set of examples of how to visualize data in a FeatureLayer.

FeatureLayer supports FeatureLayerView.highlight(), which is enabled by default when users click or tap features to view the popup. You can also call the FeatureLayerView.highlight() method on the FeatureLayerView to highlight features in other workflows.

Known Limitations

Locations with a very high density of features may not display all available features at small scales. Very large datasets may require potentially long initial load times, particularly at small scales. FeatureLayers are not optimized for high-frequency, dynamic data, or real-time streaming use cases. As a result, they may not perform efficiently with rapidly updating data streams. For real-time or dynamic data updates, use StreamLayers, which are designed for efficient handling of high-frequency streaming data and dynamic features. Server-side and client-side feature tile caching allow features to load much faster after the initial data download. We are continuously improving our feature fetching strategy and load time efficiency in each release. The big-integer field type is still in beta and may not be fully supported in the JavaScript SDK. Console warnings will be thrown when a layer has a big-integer field. To disable the warnings use the following flag:

<script>
  var esriConfig = {
    has: {
      "big-integer-warning-enabled": false
    }
  }
</script>

See also

Constructors

Constructor

See also

Client-side FeatureLayer

Parameters

Parameter	Type	Description	Required
properties	`FeatureLayerProperties`

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

Example

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

// Typical usage
// Create featurelayer from client-side graphics
const layer = new FeatureLayer({
  source: graphics,
  fields: [{
    name: "ObjectID",
    alias: "ObjectID",
    type: "oid"
  }, {
    name: "place",
    alias: "Place",
    type: "string"
  }],
  objectIdField: "ObjectID",
  geometryType: "point"
});

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`apiKey` inherited	`string \| null \| undefined`	APIKeyMixin
`attributeTableTemplate`	`AttributeTableTemplate \| null \| undefined`
`blendMode` inherited	`BlendMode`	BlendLayer
`capabilities` readonly inherited	`FeatureLayerCapabilities`	FeatureLayerBase
`charts`	`object[] \| null \| undefined`
`copyright` inherited	`string \| null \| undefined`	FeatureLayerBase
`customParameters` inherited	`CustomParameters \| null \| undefined`	CustomParametersMixin
`dateFieldsTimeZone` inherited	`TimeZone \| null \| undefined`	FeatureLayerBase
`datesInUnknownTimezone` readonly inherited	`boolean`	FeatureLayerBase
`declaredClass` readonly inherited	`string`	Accessor
`definitionExpression` inherited	`string \| null \| undefined`	FeatureLayerBase
`displayField` inherited	`string \| null \| undefined`	FeatureLayerBase
`displayFilterEnabled` inherited	`boolean`	DisplayFilteredLayer
`displayFilterInfo` inherited	`DisplayFilterInfo \| null \| undefined`	DisplayFilteredLayer
`dynamicDataSource`	`DynamicDataLayer \| null \| undefined`
`editFieldsInfo` readonly inherited	`EditFieldsInfo \| null \| undefined`	FeatureLayerBase
`editingEnabled`	`boolean`
`editingInfo` readonly inherited	`EditingInfo \| null \| undefined`	FeatureLayerBase
`effect` inherited	`Effect \| null \| undefined`	BlendLayer
`effectiveCapabilities` readonly inherited	`FeatureLayerCapabilities \| null \| undefined`	FeatureLayerBase
`effectiveEditingEnabled` readonly inherited	`boolean`	FeatureLayerBase
`elevationInfo` inherited	`ElevationInfo \| null \| undefined`	FeatureLayerBase
`featureEffect` inherited	`FeatureEffect \| null \| undefined`	FeatureEffectLayer
`featureReduction` inherited	`FeatureReductionUnion \| null \| undefined`	FeatureReductionLayer
`fieldConfigurations`	`FieldConfiguration[] \| null \| undefined`
`fields`	`Field[]`
`fieldsIndex` readonly inherited	`FieldsIndex<Field>`	FeatureLayerBase
`floorInfo` inherited	`LayerFloorInfo \| null \| undefined`	FeatureLayerBase
`formTemplate`	`FormTemplate \| null \| undefined`
`fullExtent` inherited	`Extent \| null \| undefined`	FeatureLayerBase
`gdbVersion` inherited	`string \| null \| undefined`	FeatureLayerBase
`geometryFieldsInfo` readonly inherited	`GeometryFieldsInfo \| null \| undefined`	FeatureLayerBase
`geometryType` inherited	`"point" \| "polygon" \| "polyline" \| "multipoint" \| "multipatch" \| "mesh"`	FeatureLayerBase
`globalIdField` inherited	`string \| null \| undefined`	FeatureLayerBase
`hasM` inherited	`boolean`	FeatureLayerBase
`hasZ` inherited	`boolean`	FeatureLayerBase
`historicMoment` inherited	`Date \| null \| undefined`	FeatureLayerBase
`id` inherited	`string`	Layer
`isTable` readonly inherited	`boolean`	FeatureLayerBase
`labelingInfo`	`LabelClass[] \| null \| undefined`
`labelsVisible`	`boolean`
`layerId` inherited	`number`	FeatureLayerBase
`legendEnabled`	`boolean`
`listMode` inherited	`LayerListMode`	Layer
`loaded` readonly inherited	`boolean`	Layer
`loadError` readonly inherited	`EsriError \| null \| undefined`	LoadableMixin
`loadStatus` readonly inherited	`"not-loaded" \| "loading" \| "failed" \| "loaded"`	LoadableMixin
`loadWarnings` readonly inherited	`any[]`	LoadableMixin
`maxScale` inherited	`number`	ScaleRangeLayer
`minScale` inherited	`number`	ScaleRangeLayer
`objectIdField` inherited	`string`	FeatureLayerBase
`opacity` inherited	`number`	Layer
`orderBy` inherited	`OrderByInfo[] \| null \| undefined`	OrderedLayer
`outFields`	`string[] \| null \| undefined`
`parent` inherited	`Map \| Basemap \| Ground \| GroupLayer \| CatalogDynamicGroupLayer \| CatalogLayer \| null \| undefined`	Layer
`persistenceEnabled` inherited	`boolean`	OperationalLayer
`popupEnabled`	`boolean`
`popupTemplate`	`PopupTemplate \| null \| undefined`
`portalItem` inherited	`PortalItem \| null \| undefined`	PortalLayer
`preferredTimeZone` readonly inherited	`TimeZone \| null \| undefined`	FeatureLayerBase
`publishingInfo` readonly inherited	`PublishingInfo \| null`	PublishableLayer
`refreshInterval`	`number`
`relationships` readonly inherited	`Relationship[] \| null \| undefined`	FeatureLayerBase
`renderer`	`RendererUnion \| null \| undefined`
`returnM` inherited	`boolean \| null \| undefined`	FeatureLayerBase
`returnZ` inherited	`boolean \| null \| undefined`	FeatureLayerBase
`screenSizePerspectiveEnabled`	`boolean`
`serviceDefinitionExpression` readonly inherited	`string \| null \| undefined`	FeatureLayerBase
`serviceItemId` readonly inherited	`string \| null \| undefined`	FeatureLayerBase
`source`	`Collection<Graphic>`
`sourceJSON` inherited	`Record<string, any> \| null \| undefined`	FeatureLayerBase
`spatialReference` inherited	`SpatialReference`	FeatureLayerBase
`subtypeField` readonly inherited	`string`	FeatureLayerBase
`subtypes` readonly inherited	`Subtype[] \| null \| undefined`	FeatureLayerBase
`templates`	`FeatureTemplate[] \| null \| undefined`
`timeExtent` inherited	`TimeExtent \| null \| undefined`	TemporalLayer
`timeInfo` inherited	`TimeInfo \| null \| undefined`	TemporalLayer
`timeOffset` inherited	`TimeInterval \| null \| undefined`	TemporalLayer
`title` inherited	`string \| null \| undefined`	FeatureLayerBase
`trackInfo` inherited	`TrackInfo \| null \| undefined`	TrackableLayer
`type` readonly	`"feature"`
`typeIdField`	`string \| null \| undefined`
`types`	`FeatureType[] \| null \| undefined`
`uid` readonly inherited	`string`	IdentifiableMixin
`uniqueIdFields` readonly	`string[] \| null \| undefined`
`url` inherited	`string \| null \| undefined`	FeatureLayerBase
`useViewTime` inherited	`boolean`	TemporalLayer
`version` readonly inherited	`number \| null \| undefined`	FeatureLayerBase
`visibilityTimeExtent` inherited	`TimeExtent \| null \| undefined`	Layer
`visible` inherited	`boolean`	Layer

apiKey

inherited Property

Type: string | null | undefined

Inherited from: APIKeyMixin

Since: ArcGIS Maps SDK for JavaScript 4.20

An authorization string used to access a resource or service. This property will append the API key to all requests made by the layer to the service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.

If loading a secure layer with API authentication via a PortalItem, the API key needs to be set on the layer's portalItem property.

See also

Example

// set the api key to access a protected service
const layer = new FeatureLayer({
  url: serviceUrl,
  apiKey: "YOUR_API_KEY"
});

attributeTableTemplate

autocast Property

Type: AttributeTableTemplate | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.31

This property is used to configure the associated layer's Feature Table. It is meant to configure how the columns display within the table in regard to visibility, column order, and sorting.

This property differs from a FeatureTable's tableTemplate property. The TableTemplate provides more fine-grained control over how the table is rendered within the application by offering more advanced configurations such as custom cell rendering, column formatting, and more. TableTemplate is useful for application-level development that remains within an application. Use the attributeTableTemplate property to access the table's settings across different applications. By using this property, the settings can be saved within a webmap or layer. Please refer to the AttributeTableTemplate and TableTemplate documentation for more information.

See also

Sample - FeatureTable Component

blendMode

inherited Property

Type: BlendMode

Inherited from: BlendLayer

Since: ArcGIS Maps SDK for JavaScript 4.16

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer. Unlike the method of using transparency which can result in a washed-out top layer, blend modes can create a variety of very vibrant and intriguing results by blending a layer with the layer(s) below it.

When blending layers, a top layer is a layer that has a blend mode applied. All layers underneath the top layer are background layers. The default blending mode is normal where the top layer is simply displayed over the background layer. While this default behavior is perfectly acceptable, the use of blend modes on layers open up a world of endless possibilities to generate creative maps.

The layers in a GroupLayer are blended together in isolation from the rest of the map.

In the following screenshots, the vintage shaded relief layer is displayed over a firefly world imagery layer. The color blend mode is applied to the vintage shaded relief and the result looks like a new layer.

Known Limitations

In 3D SceneViews, the blendMode is supported on BaseTileLayer, ImageryTileLayer, OpenStreetMapLayer, TileLayer, VectorTileLayer, WCSLayer, WebTileLayer, WMTSLayer and GroupLayer.
When working with GroupLayers in a 3D SceneView, the blendMode is only applied to the sublayers that support it.
The blendMode is not supported in the Legend.
See print for known printing limitations.

The following factors will affect the blend result:

Order of all layers
Layer opacity
Opacity of features in layers
Visibility of layers
By default, the very bottom layer in a map is drawn on a transparent background. You can change the MapView's background color.

Blend mode	Description
normal	The top layer is displayed over the background layer. The data of the top layer block the data of background layer where they overlap.
average	Takes the mathematical average of top and background layers. Result of `average` blend mode is often similar to the effect of setting the layer's opacity to 50%.

Lighten blend modes:

The following blend modes create lighter results than all layers. In lighten blend modes, pure black colors in the top layer become transparent allowing the background layer to show through. White in the top layer will stay unchanged. Any color that is lighter than pure black is going to lighten colors in the top layer to varying degrees all way to pure white.

Lighten blend modes can be useful when lightening dark colors of the top layer or removing black colors from the result. The plus, lighten and screen modes can be used to brighten layers that have faded or dark colors on a dark background.

Blend mode	Description
lighten	Compares top and background layers and retains the lighter color. Colors in the top layer become transparent if they are darker than the overlapping colors in the background layer allowing the background layer to show through completely. Can be thought of as the opposite of `darken` blend mode.
lighter	Colors in top and background layers are multiplied by their alphas (layer opacity and layer's data opacity. Then the resulting colors are added together. All overlapping midrange colors are lightened in the top layer. The opacity of layer and layer's data will affect the blend result.
plus	Colors in top and background layers are added together. All overlapping midrange colors are lightened in the top layer. This mode is also known as `add` or `linear-dodge`.
screen	Multiplies inverted colors in top and background layers then inverts the colors again. The resulting colors will be lighter than the original color with less contrast. Screen can produce many different levels of brightening depending on the luminosity values of the top layer. Can be thought of as the opposite of the `multiply` mode.
color-dodge	Divides colors in background layer by the inverted top layer. This lightens the background layer depending on the value of the top layer. The brighter the top layer, the more its color affects the background layer. Decreases the contrast between top and background layers resulting in saturated mid-tones and blown highlights.

Darken blend modes:

The following blend modes create darker results than all layers. In darken blend modes, pure white in the top layer will become transparent allowing the background layer to show through. Black in the top layer will stay unchanged. Any color that is darker than pure white is going to darken a top layer to varying degrees all the way to pure black.

The multiply blend mode is often used to highlight shadows, show contrast, or accentuate an aspect of a map. For example, you can use multiply blend mode on a topographic map displayed over hillshade when you want to have your elevation show through the topographic layer. See the intro to layer blending sample.

The multiply and darken modes can be used to have dark labels of the basemap to show through top layers. See the darken blending sample.

The color-burn mode works well with colorful top and background layers since it increases saturation in mid-tones. It increases the contrast by tinting pixels in overlapping areas in top and bottom layers more towards the top layer color. Use this blend mode, when you want an effect with more contrast than multiply or darken.

The following screenshots show how the multiply blend mode used for creating a physical map of the world that shows both boundaries and elevation. multiply-blend

Blend mode	Description
darken	Emphasizes the darkest parts of overlapping layers. Colors in the top layer become transparent if they are lighter than the overlapping colors in the background layer, allowing the background layer to show through completely.
multiply	Emphasizes the darkest parts of overlapping layers by multiplying colors of the top layer and the background layer. Midrange colors from top and background layers are mixed together more evenly.
color-burn	Intensifies the dark areas in all layers. It increases the contrast between top and background layers, by tinting colors in overlapping area towards the top color. To do this it inverts colors of the background layer, divides the result by colors of the top layer, then inverts the results.

Contrast blend modes:

The following blend modes create contrast by both lightening the lighter areas and darkening the darker areas in the top layer by using lightening or darkening blend modes to create the blend. The contrast blend modes will lighten the colors lighter than 50% gray ([128,128,128]), and darken the colors darker than 50% gray. 50% gray will be transparent in the top layer. Each mode can create a variety of results depending on the colors of top and background layers being blended together. The overlay blend mode makes its calculations based on the brightness of the colors in the background layer while all of the other contrast blend modes make their calculations based on the brightness of the top layer. Some of these modes are designed to simulate the effect of shining a light through the top layer, effectively projecting upon the layers beneath it.

Contrast blend modes can be used to increase the contrast and saturation to have more vibrant colors and give a punch to your layers. For example, you can duplicate a layer and set overlay blend mode on the top layer to increase the contrast and tones of your layer. You can also add a polygon layer with a white fill symbol over a dark imagery layer and apply soft-light blend mode to increase the brightness in the imagery layer.

The following screenshots show an effect of the overlay blend mode on a GraphicsLayer. The left image shows when the buffer graphics layer has the normal blend mode. As you can see, the gray color for the buffer polygon is blocking the intersecting census tracts. The right image shows when the overlay blend mode is applied to the buffer graphics layer. The overlay blend mode darkens or lightens the gray buffer polygon depending on the colors of the background layer while the census tracts layer is shining through. See this in action.

Normal blend mode	Overlay blend mode

Blend mode	Description
overlay	Uses a combination of `multiply` and `screen` modes to darken and lighten colors in the top layer with the background layer always shining through. The result is darker color values in the background layer intensify the top layer, while lighter colors in the background layer wash out overlapping areas in the top layer.
soft-light	Applies a half strength `screen` mode to lighter areas and half strength `multiply` mode to darken areas of the top layer. You can think of the `soft-light` as a softer version of the `overlay` mode.
hard-light	Multiplies or screens the colors, depending on colors of the top layer. The effect is similar to shining a harsh spotlight on the top layer.
vivid-light	Uses a combination of `color-burn` or `color-dodge` by increasing or decreasing the contrast, depending on colors in the top layer.

Component blend modes:

The following blend modes use primary color components, which are hue, saturation and luminosity to blend top and background layers. You can add a feature layer with a simple renderer over any layer and set hue, saturation, color or luminosity blend mode on this layer. With this technique, you create a brand new looking map.

The following screenshots show where the topo layer is blended with world hillshade layer with luminosity blend mode. The result is a drastically different looking map which preserves the brightness of the topo layer while adapting the hue and saturation of the hillshade layer.

Blend mode	Description
hue	Creates an effect with the hue of the top layer and the luminosity and saturation of the background layer.
saturation	Creates an effect with the saturation of the top layer and the hue and luminosity of the background layer. 50% gray with no saturation in the background layer will not produce any change.
luminosity	Creates effect with the luminosity of the top layer and the hue and saturation of the background layer. Can be thought of as the opposite of `color` blend mode.
color	Creates an effect with the hue and saturation of the top layer and the luminosity of the background layer. Can be thought of as the opposite of `luminosity` blend mode.

Composite blend modes:

The following blend modes can be used to mask the contents of top, background or both layers.

Destination modes are used to mask the data of the top layer with the data of the background layer.
Source modes are used to mask the data of the background layer with the data of the top layer.

The destination-in blend mode can be used to show areas of focus such as earthquakes, animal migration, or point-source pollution by revealing the underlying map, providing a bird's eye view of the phenomenon. Check out multiple blending and groupLayer blending samples to see composite blend modes in action.

The following screenshots show feature and imagery layers on the left side on their own in the order they are drawn in the view. The imagery layer that contains land cover classification rasters. The feature layer contains 2007 county crops data. The right image shows the result of layer blending where destination-in blendMode is set on the imagery layer. As you can see, the effect is very different from the original layers. The blended result shows areas of cultivated crops only (where both imagery and feature layers overlap).

Blend mode	Description
destination-over	Destination/background layer covers the top layer. The top layer is drawn underneath the destination layer. You'll see the top layer peek through wherever the background layer is transparent or has no data.
destination-atop	Destination/background layer is drawn only where it overlaps the top layer. The top layer is drawn underneath the background layer. You'll see the top layer peek through wherever the background layer is transparent or has no data.
destination-in	Destination/background layer is drawn only where it overlaps with the top layer. Everything else is made transparent.
destination-out	Destination/background layer is drawn where it doesn't overlap the top layer. Everything else is made transparent.
source-atop	Source/top layer is drawn only where it overlaps the background layer. You will see the background layer peek through where the source layer is transparent or has no data.
source-in	Source/top layer is drawn only where it overlaps with the background layer. Everything else is made transparent.
source-out	Source/top layer is drawn where it doesn't overlap the background layer. Everything else is made transparent.
xor	Top and background layers are made transparent where they overlap. Both layers are drawn normal everywhere else.

Invert blend modes:

The following blend modes either invert or cancel out colors depending on colors of the background layer. These blend modes look for variations between top and background layers. For example, you can use difference or exclusion blend modes on two imagery layers of forest covers to visualize how forest covers changed from one year to another.

The invert blend mode can be used to turn any light basemap into a dark basemap to accommodate those who work in low-light conditions. The following screenshots show how setting the invert blend mode set on a feature layer with a simple renderer turns the world Hillshade into a dark themed basemap in no time.

Blend mode	Description
difference	Subtracts the darker of the overlapping colors from the lighter color. When two pixels with the same value are subtracted, the result is black. Blending with black produces no change. Blending with white inverts the colors. This blending mode is useful for aligning layers with similar content.
exclusion	Similar to the `difference` blend mode, except that the resulting image is lighter overall. Overlapping areas with lighter color values are lightened, while darker overlapping color values become transparent.
minus	Subtracts colors of the top layer from colors of the background layer making the blend result darker. In the case of negative values, black is displayed.
invert	Inverts the background colors wherever the top and background layers overlap. The invert blend mode inverts the layer similar to a photographic negative.
reflect	This blend mode creates effects as if you added shiny objects or areas of light in the layer. Black pixels in the background layer are ignored as if they were transparent.

See also

Layer blending samples

Default value: "normal"

capabilities

readonlyinherited Property

Type: FeatureLayerCapabilities

Inherited from: FeatureLayerBase

Describes the layer's supported capabilities.

Example

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

charts

Property

Type: object[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.29

Array of Chart Items of type WebMapWebChart available on the feature layer.

copyright

inherited Property

Type: string | null | undefined

Inherited from: FeatureLayerBase

customParameters

inherited Property

Type: CustomParameters | null | undefined

Inherited from: CustomParametersMixin

Since: ArcGIS Maps SDK for JavaScript 4.18

A list of custom parameters appended to the URL of all resources fetched by the layer. It's an object with key-value pairs where value is a string. The layer's refresh() method needs to be called if the customParameters are updated at runtime.

Example

// send a custom parameter to your special service
let layer = new MapImageLayer({
  url: serviceUrl,
  customParameters: {
    "key": "my-special-key"
  }
});

dateFieldsTimeZone

inherited Property

Type: TimeZone | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.28

The time zone that dates are stored in. This property does not apply to date fields referenced by timeInfo or editFieldsInfo.

Even though dates are transmitted as UTC epoch values, this property may be useful when constructing date or time where clauses for querying. If constructing date or time where clauses, use FieldsIndex.getTimeZone() to get the time zone for the given date field.

Set this property in the layer constructor if you are creating client-side feature layers to indicate the time zone of the date fields. The date field must exist in the layer's fields array for client-side feature layers if the dateFieldsTimeZone is specified.

See also

Example

const layer = new FeatureLayer({
 // layer's fields definition
 fields: [
 {
   name: "ObjectID",
   alias: "ObjectID",
   type: "oid"
 }, {
   name: "type",
   alias: "Type",
   type: "string"
 }, {
   name: "recordedDate",
   alias: "recordedDate",
   type: "date"
 }],
 dateFieldsTimeZone: "America/New_York", // date field values in are eastern time zone
 objectIdField: "ObjectID", // inferred from fields array if not specified
 geometryType: "point", // geometryType and spatialReference are inferred from the first feature
                        // in the source array if they are not specified.
 spatialReference: { wkid: 4326 },
 source: graphics  //  an array of graphics with geometry and attributes
});
map.add(layer);

datesInUnknownTimezone

readonlyinherited Property

Type: boolean

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.21

This property is set by the service publisher and indicates that dates should be considered without the local timezone. This applies to both requests and responses.

Known Limitations

This capability is only available with services published with ArcGIS Enterprise 10.9 or greater.
Editing is not supported for FeatureLayers if datesInUnknownTimezone is true. The layer's editingEnabled property will be set to false.
When setting timeExtent in a Query, the layer view's filter.timeExtent or layer's timeExtent, dates must be defined in terms of UTC as illustrated in the code below. When using layer.timeInfo.fullTimeExtent in conjunction with TimeSlider, the local timezone offset must be removed. See the code snippet below.

See also

Default value: false

Examples

// Only download data for the year 2020.
// if the layer supports unknown time zone then create
// the dates in UTC
if (layer.datesInUnknownTimezone) {
  layer.timeExtent = new TimeExtent({
    start: new Date(Date.UTC(2020, 0, 1)),
    end: new Date(Date.UTC(2021, 0, 1))
  });
}
else {
  layer.timeExtent = new TimeExtent({
    start: new Date(2020, 0, 1),
    end: new Date(2021, 0, 1)
  });
}

// set up the timeslider for a service with an unknown timezone
if (layer.datesInUnknownTimezone) {
  const timeSlider = new TimeSlider({
    view: view,
    container: "timeSliderDiv",
    timeVisible: true,
  });
  view.ui.add(timeSlider, "bottom-left");

  view.whenLayerView(layer).then((layerView) => {
   // get the layer's fullTimeExtent and remove the local
   // time zone offset
    const timExtent = new TimeExtent({
      start: removeLocalOffset(layer.timeInfo.fullTimeExtent.start),
      end: removeLocalOffset(layer.timeInfo.fullTimeExtent.end)
    });

    timeSlider.fullTimeExtent = timExtent;
    timeSlider.stops = {
      interval: layer.timeInfo.interval;
    };
  });
}

// Remove the local time zone offset from dates
function removeLocalOffset(localTime) {
  return new Date(
    localTime.getUTCFullYear(),
    localTime.getUTCMonth(),
    localTime.getUTCDate(),
    localTime.getUTCHours(),
    localTime.getUTCMinutes(),
    localTime.getUTCSeconds(),
    localTime.getUTCMilliseconds()
  );
}

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

definitionExpression

inherited Property

Type: string | null | undefined

Inherited from: FeatureLayerBase

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

inherited Property

Type: string | null | undefined

Inherited from: FeatureLayerBase

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.

displayFilterEnabled

inherited Property

Type: boolean

Inherited from: DisplayFilteredLayer

Since: ArcGIS Maps SDK for JavaScript 4.32

Indicates whether the layer's displayFilterInfo is applied when rendering the layer in the view. If false, the layer's display filter is ignored and all features are rendered without filtering. To ignore display filters across all layers in the view, set the view's View.displayFilterEnabled property to false.

Default value: true

displayFilterInfo

autocast inherited Property

Type: DisplayFilterInfo | null | undefined

Inherited from: DisplayFilteredLayer

Since: ArcGIS Maps SDK for JavaScript 4.32

Information related to a display filter associated with a layer. Display filters control which features are visible on the map. They allow you to display a subset of features while retaining access to all features for querying and analysis. Unlike FeatureLayer.definitionExpression, which filters data at the source level, display filters only affect visibility on the map. Therefore display filters should be ignored when querying data to present to users. Display filters can be disabled for all layers in the map by setting the view's View.displayFilterEnabled property to false.

Notes: To optimize memory usage for rendering, display filters may be appended to the layer's FeatureLayer.definitionExpression when querying the service. As a result, the filtered features may not be available on the client for executing layer view queries. To determine if all features are available in the view, check the layer view's FeatureLayerView.hasAllFeaturesInView property when layer view's FeatureLayerView.dataUpdating is false. If false, the layer view does not have all features in the view and you should query the layer instead.

See also

Example

// set a scale-dependent display filter on a layer
const layer = new FeatureLayer({
  portalItem: {
    id: "28dbd58ad90e4a47ab0e0334d2b69427"
  },
  minScale: 0,
  maxScale: 0,
  outFields: ["*"],
  // set scale-dependent display filters to declutter the display at different scales.
  // Show more streams as user zooms in and less as user zooms out.
  displayFilterInfo: new DisplayFilterInfo({
    mode: "scale",
    filters: [
      {
        title: "streamOrder >= 8",
        minScale: 0,
        maxScale: 18_489_297.737236,
        where: "streamOrder >= 8"
      },
      {
        title: "streamOrder >= 6",
        minScale: 18_489_297.737236
        maxScale: 9_244_648.868618,
        where: "streamOrder >= 6"
      },
      {
        title: "streamOrder >= 4",
        minScale: 9_244_648.868618,
        maxScale: 577790.5542885
        where: "streamOrder >= 4"
      },
      {
        title: "all",
        minScale: 577790.5542885,
        maxScale: 0
      }
    ]
  })
});

dynamicDataSource

autocast Property

Type: DynamicDataLayer | null | undefined

Since: ArcGIS Maps SDK 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 Sublayer.createFeatureLayer() method on the Sublayer to construct the layer for you.

This only applies to map services with dynamic layers enabled.

Known Limitations

FeatureLayers with a dynamicDataSource cannot be persisted to web maps, web scenes, and portal items.

See also

Example

const layer = new FeatureLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/AGP/Census/MapServer",
  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",
      fieldFormat: {
        type: "number",
        useGrouping: "always",
        maximumFractionDigits: 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

readonlyinherited Property

Type: EditFieldsInfo | null | undefined

Inherited from: FeatureLayerBase

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

editingEnabled

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.18

Determines if the layer is editable.

See also

applyEdits()

Default value: true

editingInfo

readonlyinherited Property

Type: EditingInfo | null | undefined

Inherited from: FeatureLayerBase

Specifies information about editing.

effect

inherited Property

Type: Effect | null | undefined

Inherited from: BlendLayer

Since: ArcGIS Maps SDK for JavaScript 4.18

Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work. This powerful capability allows you to apply css filter-like functions to layers to create custom visual effects to enhance the cartographic quality of your maps. This is done by applying the desired effect to the layer's effect property as a string or an array of objects to set scale dependent effects.

Notes

Set featureEffect property on a layer if different effects need to be applied features that meet or fail a specified filter. If all of the following four properties are applied, then they will be applied in this order: featureEffect, effect, opacity and blendMode.

Known Limitations

The effect is not supported in 3D SceneViews.
The effect cannot be applied to a layer with a heatmap renderer.
The effect is not supported in layers with FeatureLayer.featureReduction of type cluster enabled.
See print for known printing limitations.

See also

Examples

// the following effect will be applied to the layer at all scales
// brightness will be applied first, then hue-rotate followed by contrast
// changing order of the effects will change the final result
layer.effect = "brightness(5) hue-rotate(270deg) contrast(200%)";

// set a scale dependent bloom effect on the layer
layer.effect = [
  {
    scale: 36978595,
    value: "drop-shadow(3px, 3px, 4px)"
  },
  {
    scale: 18489297,
    value: "drop-shadow(2px, 2px, 3px)"
  },
  {
    scale: 4622324,
    value: "drop-shadow(1px, 1px, 2px)"
  }
];

effectiveCapabilities

readonlyinherited Property

Type: FeatureLayerCapabilities | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.26

Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user.

effectiveEditingEnabled

readonlyinherited Property

Type: boolean

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.26

Indicates whether the layer is editable taking in to consideration privileges of the currently signed-in user.

elevationInfo

autocast inherited Property

Type: ElevationInfo | null | undefined

Inherited from: FeatureLayerBase

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.

If the elevation info is not specified, the effective elevation depends on the context and could vary per graphic.

featureEffect

autocast inherited Property

Type: FeatureEffect | null | undefined

Inherited from: FeatureEffectLayer

Since: ArcGIS Maps SDK for JavaScript 4.22

The featureEffect can be used to draw attention to features of interest. It allows for the selection of features via a filter, and an includedEffect and excludedEffect are applied to those features that respectively pass or fail the filter requirements.

Notes

Set the effect property if the effect needs to be applied to the entire layer.

If the featureEffect is set on the layer, it will be inherited by layerView.featureEffect unless the developer overrides it on the layer view. The layerView.featureEffect will take precedence over layer.featureEffect if both properties are set.

If all of the following four properties are applied, then they will be applied in this order: featureEffect, effect, opacity and blendMode.

Known Limitations

FeatureEffect is not supported in the following scenarios:

In 3D SceneViews
When FeatureReductionCluster is enabled
See print for known printing limitations.

See also

Examples

// gray out features that fall outside of the 3 mile buffer of the mouse's location
// by setting feature effect on excluded features
layer.featureEffect = new FeatureEffect({
  filter: new FeatureFilter({
    geometry: filterGeometry,
    spatialRelationship: "intersects",
    distance: 3,
    units: "miles"
  }),
  excludedEffect: "grayscale(100%) opacity(30%)"
});

// Apply a drop-shadow feature effect to the features that intersect the borough boundaries,
// while applying blur and brightness effects to the features that are excluded from filter criteria.
// The resulting map will make it easier to spot if the residents are more likely to experience deprivation
// if they live on a borough boundary.
const featureFilter = new FeatureFilter({
  where: "BoroughEdge='true'"
});
layer.featureEffect = new FeatureEffect({
  filter: featureFilter,
  includedEffect: "drop-shadow(3px, 3px, 3px, black)",
  excludedEffect: "blur(1px) brightness(65%)"
});

featureReduction

autocast inherited Property

Type: FeatureReductionUnion | null | undefined

Inherited from: FeatureReductionLayer

Since: ArcGIS Maps SDK for JavaScript 4.4

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

There are three types of feature reduction: selection, cluster, and binning.

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 groups points, lines, or polygons in a MapView into clusters defined in screen space. Each cluster is a point geometry whose size is proportional to the number of features within the cluster. This has been available since version 4.14.
Binning spatially groups points, lines, or polygons in a MapView into bins, clearly defining the area aggregating features in map space. Each bin is a polygon geometry typically rendered so its color represents the number of features within the bin. This has been available since version 4.24.

See also

Examples

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

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

// Aggregates features to bins
layer.featureReduction = {
  type: "binning",
  renderer: {
    type: "simple",  // autocasts as new SimpleRenderer()
    symbol: {
      type: "simple-fill",  // autocasts as new SimpleFillSymbol()
      outline: {  // autocasts as new SimpleLineSymbol()
        width: 0.5,
        color: "white"
      }
    },
    visualVariables: [{
      type: "color",
      field: "aggregateCount",
      stops: [
        { value: 1, color: "white" },
        { value: 1000, color: "blue" }
      ]
    }]
  },
  popupTemplate: {
    content: "This bin contains <b>{aggregateCount}</b> features.",
    fieldInfos: [{
      fieldName: "aggregateCount",
      format: {
        digitSeparator: true,
        places: 0
      }
    }]
  }
};

fieldConfigurations

autocast Property

Type: FieldConfiguration[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

An array of FieldConfiguration objects that control how fields are displayed in popups and other UI elements. Each object specifies options for an individual field, such as its display name, via alias, and formatting rules, via fieldFormat. Assign this property before the layer loads to ensure the configurations take effect. For more information, see the FieldConfiguration documentation.

If no field configurations are provided, they are automatically created when a popupTemplate is assigned to the layer. If no popupTemplate is set, you can manually define field configurations to customize how fields are shown.

Support is limited in version 4.34. For details, see the FieldConfiguration documentation.

To modify field configurations, clone fieldConfigurations, make the changes, and then reassign the updated clone back to FeatureLayer.fieldConfigurations.

See also

Examples

// Adding a new field configuration
const addNewConfig = (layer, fieldName, alias,
fieldFormat) => {
  // Check if there is already an existing configuration for fieldName
  const existingConfig = layer.getFieldConfiguration(fieldName);
  if (!existingConfig) {
    const newConfig = new FieldConfiguration({ name: fieldName, alias, fieldFormat });
    const newConfigs = clone(layer.fieldConfigurations);
    newConfigs.push(newConfig);
    layer.fieldConfigurations = newConfigs;
  }
};

// Updating an existing field configuration
const updateConfig = (layer, fieldName, alias,
fieldFormat) => {
  const existingConfig = layer.getFieldConfiguration(fieldName);
  if (existingConfig) {
    const newConfig = existingConfig.clone();
    newConfig.alias = alias;
    newConfig.fieldFormat = fieldFormat;

    const index = layer.fieldConfigurations.indexOf(existingConfig);
    const newConfigs = clone(layer.fieldConfigurations);
    newConfigs[index] = newConfig;
    layer.fieldConfigurations = newConfigs;
  }
};

// Deleting an existing field configuration
const deleteConfig = (layer, fieldName) => {
  const existingConfig = layer.getFieldConfiguration(fieldName);
  if (existingConfig) {
    const index = layer.fieldConfigurations.indexOf(existingConfig);
    var newConfigs = clone(layer.fieldConfigurations);
    newConfigs.splice(index, 1);
    layer.fieldConfigurations = newConfigs;
 }
};

fields

autocast Property

Type: Field[]

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.

When creating a FeatureLayer from client-side features, this property should be set in the constructor along with the source property. The objectId field also must be set either in this array or in the objectIdField property.

See also

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

readonlyinherited Property

Type: FieldsIndex<Field>

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK 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
}

floorInfo

autocast inherited Property

Type: LayerFloorInfo | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.19

When a feature layer is configured as floor-aware, it has a floorInfo property defined. A floor-aware layer is a layer that contains indoor GIS data representing features that can be located on a specific floor of a building.

formTemplate

autocast Property

Type: FormTemplate | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.16

The template used in an associated layer's FeatureForm. All of the properties and field configurations set on the layer's Feature Form are handled via the FormTemplate.

See also

Sample - Update Feature Attributes

Example

// Create the Field Elements to pass into the template
const fieldElement1 = new FieldElement({
  fieldName: "firstname",
  label: "First name",
  description: "First name of emergency contact"
});

const fieldElement2 = new FieldElement({
  fieldName: "lastname",
  label: "Last name",
  description: "Last name of emergency contact"
});

// Create the form's template
const formTemplate = new FormTemplate({
  title: "Emergency information",
  description: "In case of emergency, update any additional information needed",
  elements: [fieldElement1, fieldElement2] // pass in array of field elements from above
});

// Pass the template to the layer
featureLayer.formTemplate = formTemplate;

// Pass the layer to the FeatureForm
const form = new FeatureForm({
  container: "form", // html div referencing the form
  layer: featureLayer
});

fullExtent

autocast inherited Property

Type: Extent | null | undefined

Inherited from: FeatureLayerBase

The full extent of the layer.

gdbVersion

inherited Property

Type: string | null | undefined

Inherited from: FeatureLayerBase

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

geometryFieldsInfo

readonlyinherited Property

Type: GeometryFieldsInfo | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.19

Provides information on the system maintained area and length fields along with their respective units.

See also

ArcGIS REST API documentation

geometryType

inherited Property

Type: "point" | "polygon" | "polyline" | "multipoint" | "multipatch" | "mesh"

Inherited from: FeatureLayerBase

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. If the layer's source is an empty array at the time of initialization, this property must be set.

See also

Add an array of client-side features

globalIdField

inherited Property

Type: string | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.33

The name of a gid field containing a globally unique identifier for each feature in the layer. This may be null or undefined if the layer does not have a globally unique identifier field.

See also

FeatureLayer.fields

hasM

inherited Property

Type: boolean

Inherited from: FeatureLayerBase

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.

hasZ

inherited Property

Type: boolean

Inherited from: FeatureLayerBase

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.

historicMoment

autocast inherited Property

Type: Date | null | undefined

Inherited from: FeatureLayerBase

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

id

inherited Property

Type: string

Inherited from: Layer

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

isTable

readonlyinherited Property

Type: boolean

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.11

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

See also

Default value: false

labelingInfo

autocast Property

Type: LabelClass[] | null | undefined

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

3D SceneViews only support displaying one LabelClass per feature.

See also

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

Property

Type: boolean

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

Known Limitations

3D SceneViews only support displaying one LabelClass per feature.

Default value: true

layerId

inherited Property

Type: number

Inherited from: FeatureLayerBase

The layer ID, or layer index, of a Feature Service layer. This is particularly useful when loading a single feature layer 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's url directly to a 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

Property

Type: boolean

Indicates whether the layer will be included in the legend.

Default value: true

listMode

inherited Property

Type: LayerListMode

Inherited from: Layer

Indicates how the layer should display in the Layer List component. 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, SubtypeGroupLayer, TileLayer, or WMSLayer, hide the children layers from the table of contents.

Default value: "show"

loaded

readonlyinherited Property

Type: boolean

Inherited from: Layer

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

Default value: false

loadError

readonlyinherited Property

Type: EsriError | null | undefined

Inherited from: LoadableMixin

The Error object returned if an error occurred while loading.

loadStatus

readonlyinherited Property

Type: "not-loaded" | "loading" | "failed" | "loaded"

Inherited from: LoadableMixin

Represents the status of a load() operation.

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

Default value: "not-loaded"

loadWarnings

readonlyinherited Property

Type: any[]

Inherited from: LoadableMixin

A list of warnings which occurred while loading.

maxScale

inherited Property

Type: number

Inherited from: ScaleRangeLayer

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

inherited Property

Type: number

Inherited from: ScaleRangeLayer

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

inherited Property

Type: string

Inherited from: FeatureLayerBase

The name of the object id Field containing a unique identifier for each feature in the layer. The object id field for a FeatureLayer can contain either numeric or string values. Some feature layers use one or more unique id fields to uniquely identify features. Due to the complexity of object ids and unique ids, it is strongly recommended to use Graphic.getObjectId() method to obtain a feature's unique identifier.

If this property is not defined when creating a client-side feature layer, the object-id field will be automatically inferred from the layer's fields array.

See also

Add an array of client-side features

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

inherited Property

Type: number

Inherited from: Layer

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

Known Limitations

In a 3D SceneView, modifying opacity is not supported for DimensionLayer, GaussianSplatLayer, IntegratedMesh3DTilesLayer, IntegratedMeshLayer, LineOfSightLayer, PointCloudLayer, ViewshedLayer, and VoxelLayer.

Default value: 1

Example

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

orderBy

autocast inherited Property

Type: OrderByInfo[] | null | undefined

Inherited from: OrderedLayer

Since: ArcGIS Maps SDK for JavaScript 4.21

Determines the order in which features are drawn in the view. You can sort features by a field value or the value returned from an Arcade expression in ascending or descending order.

When null (default), features are drawn in the order they are returned from the service or client.

Known Limitations

This property only controls feature drawing order in MapView. Configuring feature drawing order in SceneView is not supported.
This property does not control the drawing order of clusters. It only applies to individual features.
Feature drawing order configurations defined with Arcade expressions cannot be saved to web maps.
Currently, you can only sort features by one field or expression.

See also

Arcade Feature Z Profile

Examples

// Features with smaller population values will
// be rendered on top of larger features.
layer.orderBy = [{
  field: "POPULATION"
}];

// Features with larger population values will
// be rendered on top of smaller features.
layer.orderBy = [{
  field: "POPULATION",
  order: "descending"
}];

// Orders features by date in descending order.
// The most recent features will be rendered
// on top of older features.
layer.orderBy = [{
  field: "Alarm_Date",
  order: "descending"
}];

// Orders features by storm warning duration in descending order.
// Warnings with longer durations
// be rendered on top of warnings with shorter durations.
layer.orderBy = [{
  valueExpression: "DateDiff($feature.Watch_End, $feature.Watch_Start, 'hours' )",
  order: "descending"
}];

// Orders features by data values used in a size visual variable
const sizeVariable = layer.renderer.visualVariables.find( vv => vv.type === "size");
const { field, valueExpression } = sizeVariable;
layer.orderBy = [{
  field,
  valueExpression,
  order: "ascending"
}];

outFields

Property

Type: string[] | null | undefined

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.

See also

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.at(1);
  layer.outFields = ["*"];
});

parent

inherited Property

Type: Map | Basemap | Ground | GroupLayer | CatalogDynamicGroupLayer | CatalogLayer | null | undefined

Inherited from: Layer

Since: ArcGIS Maps SDK for JavaScript 4.27

The parent to which the layer belongs.

persistenceEnabled

inherited Property

Type: boolean

Inherited from: OperationalLayer

Since: ArcGIS Maps SDK for JavaScript 4.28

Enable persistence of the layer in a WebMap or WebScene.

Default value: true

popupEnabled

Property

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

See also

Default value: true

popupTemplate

autocast Property

Type: PopupTemplate | null | undefined

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

portalItem

autocast inherited Property

Type: PortalItem | null | undefined

Inherited from: PortalLayer

The portal item from which the layer is loaded. If the portal item references a feature or scene service, then you can specify a single layer to load with the layer's layerId property.

Loading non-spatial tables

Non-spatial tables can be loaded from service items hosted in ArcGIS Online and ArcGIS Enterprise. This only applies to:

FeatureLayer if the layer's isTable returns true at version 4.17.
SubtypeGroupLayer if the layer's isTable returns true at version 4.32.

Examples

// While this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids.
const layer = 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.
const layer = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

// Initialize GeoJSONLayer by referencing a portalItem id pointing to geojson file.
const layer = new GeoJSONLayer({
  portalItem: new PortalItem({
    id: "81e769cd7031482797e1b0768f23c7e1",
    // optionally define the portal, of the item.
    // if not specified, the default portal defined is used.
    // see https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl
    portal: new Portal({
      url: "https://jsapi.maps.arcgis.com/"
    })
  }
});

// This snippet loads a table hosted in ArcGIS Online.
const table = new FeatureLayer({
  portalItem: { // autocasts as esri/portal/PortalItem
    id: "123f4410054b43d7a0bacc1533ceb8dc"
  }
});

// Before adding the table to the map, it must first be loaded and confirm it is the right type.
table.load().then(() => {
  if (table.isTable) {
    map.tables.add(table);
  }
});

// While this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids.
const layer = new FeatureLayer({
  portalItem: { // autocasts as esri/portal/PortalItem
    id: "caa9bd9da1f4487cb4989824053bb847",
    // Set an API key to access a secure portal item configured with API key authentication.
    apiKey: "APIKEY"
  }
});

preferredTimeZone

readonlyinherited Property

Type: TimeZone | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.28

The IANA time zone the author of the service intended data from date fields to be viewed in.

publishingInfo

readonlyinherited Property

Type: PublishingInfo | null

Inherited from: PublishableLayer

Since: ArcGIS Maps SDK for JavaScript 4.25

Checks layer's publishing status while the layer is being published to the portal. This stops when the status has been determined or when the layer is destroyed. The layer is automatically refreshed when the layer is done publishing. This is valid only for ArcGIS Online hosted feature services.

Example

// Log the current publishing status after each checks.
when(
  () => !layer.publishingInfo.updating,
  (status) => {
    switch (layer.publishingInfo.status) {
      case "unknown":
        console.log("The layer's publishing status is unknown at this point");
        break;
      case "unavailable":
        console.log("The layer doesn't provide publishing information");
        break;
      case "publishing":
        console.log("Layer is publishing");
        break;
      case "published":
        console.log("Layer is published at", layer.url);
        break;
    }
  },
  { initial: true }
);

refreshInterval

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 4.6

Refresh interval of the layer in minutes. Value of 0 indicates no refresh. At each refresh interval, the data is only updated if the lastEditDate in the layer's metadata is different from the lastEditDate field. If the lastEditDate metadata info is not available, the FeatureLayer refreshes unconditionally.

See also

Default value: 0

Examples

// the layer will be refreshed every 1 minute.
layer.refreshInterval = 1;

// the layer will be refreshed every minute.
layer.refreshInterval = 1;

relationships

readonlyinherited Property

Type: Relationship[] | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK 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
layer.when(function () {
  console.log("layer relationships", layer.relationships.length);

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

autocast Property

Type: RendererUnion | null | undefined

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

Styles and data visualization

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

inherited Property

Type: boolean | null | undefined

Inherited from: FeatureLayerBase

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.

returnZ

inherited Property

Type: boolean | null | undefined

Inherited from: FeatureLayerBase

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.

screenSizePerspectiveEnabled

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.4

Apply perspective scaling to screen-size 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

screen-size-perspective

layer.screenSizePerspectiveEnabled = false

no-screen-size-perspective

Known Limitations

Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with visual elements 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.

See also

Sample: Point styles for cities

Default value: true

serviceDefinitionExpression

readonlyinherited Property

Type: string | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.16

The service definition expression limits the features available for display and query. You can define additional filters on the layer in addition to the service definition expression by setting layer's definitionExpression. For example, if the service definition expression is set to display data where "STATE_NAME = 'California'" you could use definitionExpression to only display a subset of the features in California, for example using "COUNTY='San Diego'".

See also

Set hosted feature layer view definition

serviceItemId

readonlyinherited Property

Type: string | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates the portal item of the hosted feature service that contains this layer.

source

autocast Property

Type: Collection<Graphic>

A collection of Graphic objects used to create a FeatureLayer. The geometry of each feature all must have a matching geometryType. This property must be set when creating a FeatureLayer from client-side features. When creating a FeatureLayer from client-side features, the objectId field must be set either in the fields array or via objectIdField.

The spatialReference and geometryType properties are determined based on the features provided to this property. If the source is an empty array at the time of layer initialization, then geometryType must be set.

The source is not updated after the FeatureLayer is initialized. Use applyEdits() method to add, remove, and update features from a client-side feature layer at runtime. Once applyEdits() resolves successfully, use queryFeatures() to return updated features.

See also

Examples

let features = [
 {
   geometry: {
     type: "point",
     x: -100,
     y: 38
   },
   attributes: {
     ObjectID: 1,
     DepArpt: "KATL",
     MsgTime: Date.now(),
     FltId: "UAL1"
   }
 },
 ...
];

// geometryType and spatialReference of the layer
// will be inferred from the first feature in the array
// if it has a geometry.
let layer = new FeatureLayer({
  source: features,  // autocast as a Collection of new Graphic()
  objectIdField: "ObjectID"
});

// Create an empty non-spatial feature layer
// Set geometryType property to null when creating non-spatial feature layer
const layer = new FeatureLayer({
  source: [],
  objectIdField: "OBJECTID",
  fields: [{
    name: "OBJECTID",
    type: "oid"
  }],
  geometryType: null
});
layer.load().then(() => console.log(layer.isTable))

sourceJSON

inherited Property

Type: Record<string, any> | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK 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

autocast inherited Property

Type: SpatialReference

Inherited from: FeatureLayerBase

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 layer's source property.

subtypeField

readonlyinherited Property

Type: string

Inherited from: FeatureLayerBase

The name of the field which holds the id of the subtypes.

subtypes

readonlyinherited Property

Type: Subtype[] | null | undefined

Inherited from: FeatureLayerBase

An array of subtypes defined in the layer.

See also

Introduction to subtypes

templates

autocast Property

Type: FeatureTemplate[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.4

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

timeExtent

autocast inherited Property

Type: TimeExtent | null | undefined

Inherited from: TemporalLayer

Since: ArcGIS Maps SDK 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, and both layer and view time extents are set, then features that fall within the intersection of the view and layer time extents will be displayed. For example, if the layer's time extent is set to display features between 1970 and 1975 and the view has a time extent set to 1972-1980, the effective time on the feature layer will be 1972-1975.

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

// timeExtent is set on the layer and the view
// In this case, the layer will display features that fall
// within the intersection of view and layer time extents
// features within Jan 1, 1976 - Jan 1, 1981 will be displayed
const view = new MapView({
  timeExtent: {
    start: new Date(1976, 0, 1),
    end: new Date(2002, 0, 1)
  }
});
const layer = new FeatureLayer({
  url: myUrl,
  timeExtent: {
    start: new Date(1974, 0, 1),
    end: new Date(1981, 0, 1)
  }
});

timeInfo

autocast inherited Property

Type: TimeInfo | null | undefined

Inherited from: TemporalLayer

Since: ArcGIS Maps SDK 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 CSVLayer, GeoJSONLayer 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.

TimeInfo's TimeInfo.startField and endField can be date, date-only or timestamp-offset field type for FeatureLayer and MapImageLayer.

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
  // The date values must be in milliseconds number from the UNIX epoch specified in UTC.
  timeInfo: {
    startField: "time"
  }
});

timeOffset

autocast inherited Property

Type: TimeInterval | null | undefined

Inherited from: TemporalLayer

Since: ArcGIS Maps SDK 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.

Example

// Offset a CSV Layer containing hurricanes from 2015 so that they appear in 2019 (+4 years).
let 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

inherited Property

Type: string | null | undefined

Inherited from: FeatureLayerBase

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

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.

trackInfo

autocast inherited Property

Type: TrackInfo | null | undefined

Inherited from: TrackableLayer

Since: ArcGIS Maps SDK for JavaScript 4.32

beta

Allows you to render track data for a layer, including a track line, previous observations, and latest observations. For trackInfo to work, the layer must have timeInfo defined with a valid trackIdField.

type

readonly Property

Type: "feature"

The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.

typeIdField

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.4

The name of the field holding the type ID for the features.

types

autocast Property

Type: FeatureType[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.4

An array of types 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.

uid

readonlyinherited Property

Type: string

Inherited from: IdentifiableMixin

Since: ArcGIS Maps SDK for JavaScript 4.33

An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.

uniqueIdFields

readonly Property

Type: string[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.33

This property contains an array of field names that are used to uniquely identify a feature in the layer.

url

inherited Property

Type: string | null | undefined

Inherited from: FeatureLayerBase

The absolute 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

inherited Property

Type: boolean

Inherited from: TemporalLayer

Since: ArcGIS Maps SDK for JavaScript 4.14

Determines if the time enabled layer will update its temporal data based on the view's timeExtent. When false, the layer will display its temporal data based on the layer's timeExtent, regardless of changes to the view. If both view and layer time extents are set while this property is true, then the features that fall within the intersection of the view and layer time extents will be displayed. For example, if a layer's time extent is set to display features between 1970 and 1975 and the view has a time extent set to 1972-1980, the effective time on the feature layer will be 1972-1975.

Changing useViewTime to false does not affect layer's visibilityTimeExtent.

Default value: true

Example

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

version

readonlyinherited Property

Type: number | null | undefined

Inherited from: FeatureLayerBase

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

Example

// Prints the version number to the console - e.g. 10.91, 11.2, 11.3.
console.log(layer.version);

visibilityTimeExtent

autocast inherited Property

Type: TimeExtent | null | undefined

Inherited from: Layer

Since: ArcGIS Maps SDK for JavaScript 4.30

Specifies a fixed time extent during which a layer should be visible. This property can be used to configure a layer that does not have time values stored in an attribute field to work with time. Once configured, the TimeSlider widget will display the layer within the set time extent. In the case that only one of the TimeExtent.start or TimeExtent.end date values are available, the layer remains visible indefinitely in the direction where there is no time value.

Aerial imagery can capture seasonal variations in vegetation, water bodies, and land use patterns. For example, in agricultural regions, aerial imageries taken during different growing seasons provide insights into crop health and productivity. Defining a fixed time extent on imageries from specific time periods provides temporal context and facilitates focused analysis based on specific time periods or events.

See also

Sample - GraphicsLayer with visibilityTimeExtent

visible

inherited Property

Type: boolean

Inherited from: Layer

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;

// Watch for changes in the layer's visibility
// and set the visibility of another layer when it changes
reactiveUtils.watch(
  () => layer.visible,
  (visible) => {
    if (visible) {
      anotherLayer.visible = true;
    } else {
      anotherLayer.visible = false;
    }
  }
);

Methods

Method	Signature	Class
`fromArcGISServerUrl` inherited static	`fromArcGISServerUrl(params: string \| FromArcGISServerUrlParameters): Promise<Layer>`	Layer
`fromPortalItem` inherited static	`fromPortalItem(params: LayerFromPortalItemParameters): Promise<Layer>`	Layer
`addAttachment`	`addAttachment(feature: Graphic, attachment: HTMLFormElement \| FormData): Promise<FeatureEditResult>`
`applyEdits`	`applyEdits(edits: Edits, options?: EditOptions): Promise<EditsResult>`
`cancelLoad` inherited	`cancelLoad(): this`	LoadableMixin
`clone` inherited	`clone(): this`	ClonableMixin
`createFieldConfigurations`	`createFieldConfigurations(): FieldConfiguration[] \| null \| undefined`
`createLayerView` inherited	`createLayerView<T extends LayerView = LayerView>(view: View<T>, options?: AbortOptions): Promise<T>`	Layer
`createPopupTemplate`	`createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate \| null \| undefined`
`createQuery`	`createQuery(): Query`
`deleteAttachments`	`deleteAttachments(feature: Graphic, attachmentIds: number[]): Promise<FeatureEditResult[]>`
`destroy` inherited	`destroy(): void`	Layer
`emit` inherited	`emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean`	EventedMixin
`fetchAttributionData` inherited	`fetchAttributionData(): Promise<any>`	Layer
`getFeatureTitle`	`getFeatureTitle(graphic: Graphic, options?: FeatureTitleOptions): Promise<string>`
`getFeatureType`	`getFeatureType(feature: Graphic \| null \| undefined): FeatureType \| null \| undefined`
`getField` inherited	`getField(fieldName: string): Field \| null \| undefined`	FeatureLayerBase
`getFieldAlias`	`getFieldAlias(fieldName: string): string \| null \| undefined`
`getFieldConfiguration`	`getFieldConfiguration(fieldName: string): FieldConfiguration \| null \| undefined`
`getFieldDomain` inherited	`getFieldDomain(fieldName: string, options?: FieldDomainOptions): DomainUnion \| null \| undefined`	FeatureLayerBase
`hasEventListener` inherited	`hasEventListener<Type extends EventNames<this>>(type: Type): boolean`	EventedMixin
`isFulfilled` inherited	`isFulfilled(): boolean`	EsriPromiseMixin
`isRejected` inherited	`isRejected(): boolean`	EsriPromiseMixin
`isResolved` inherited	`isResolved(): boolean`	EsriPromiseMixin
`load` inherited	`load(options?: AbortOptions \| null \| undefined): Promise<this>`	LoadableMixin
`on` inherited	`on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle`	EventedMixin
`queryAttachments`	`queryAttachments(attachmentQuery: AttachmentQueryProperties, options?: RequestOptions): Promise<Record<string, AttachmentInfo[]>>`
`queryAttributeBins`	`queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: RequestOptions): Promise<AttributeBinsFeatureSet>`
`queryExtent`	`queryExtent(query?: QueryProperties \| null \| undefined, options?: RequestOptions): Promise<{ count: number; extent: Extent \| null; }>`
`queryFeatureCount`	`queryFeatureCount(query?: QueryProperties \| null \| undefined, options?: RequestOptions): Promise<number>`
`queryFeatures`	`queryFeatures(query?: QueryProperties \| null \| undefined, options?: RequestOptions): Promise<FeatureSet>`
`queryObjectIds`	`queryObjectIds(query?: QueryProperties \| null \| undefined, options?: RequestOptions): Promise<ObjectId[]>`
`queryRelatedFeatures`	`queryRelatedFeatures(relationshipQuery: RelationshipQueryProperties, options?: RequestOptions): Promise<Record<string, FeatureSet>>`
`queryRelatedFeaturesCount`	`queryRelatedFeaturesCount(relationshipQuery: RelationshipQueryProperties, options?: RequestOptions): Promise<Record<string, number>>`
`queryTopFeatureCount`	`queryTopFeatureCount(topFeaturesQuery?: TopFeaturesQueryProperties, options?: RequestOptions): Promise<number>`
`queryTopFeatures`	`queryTopFeatures(topFeaturesQuery: TopFeaturesQueryProperties, options?: RequestOptions): Promise<FeatureSet>`
`queryTopFeaturesExtent`	`queryTopFeaturesExtent(topFeaturesQuery?: TopFeaturesQueryProperties, options?: RequestOptions): Promise<{ count: number; extent: Extent \| null; }>`
`queryTopObjectIds`	`queryTopObjectIds(topFeaturesQuery?: TopFeaturesQueryProperties, options?: RequestOptions): Promise<number[]>`
`refresh`	`refresh(): void`
`save`	`save(options?: LayerSaveOptions): Promise<PortalItem>`
`saveAs`	`saveAs(portalItem: PortalItemProperties, options?: LayerSaveAsOptions): Promise<PortalItem>`
`updateAttachment`	`updateAttachment(feature: Graphic, attachmentId: number, attachment: HTMLFormElement \| FormData): Promise<FeatureEditResult>`
`when` inherited	`when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> \| null \| undefined, onRejected?: OnRejectedCallback<TResult2> \| null \| undefined): Promise<TResult1 \| TResult2>`	EsriPromiseMixin

fromArcGISServerUrl

inheritedstatic Method

Signature: fromArcGISServerUrl (params: string | FromArcGISServerUrlParameters): Promise<Layer>

Inherited from: Layer

Creates a new layer instance from an ArcGIS Server URL. Depending on the URL, the returned layer type may be a BuildingSceneLayer, CatalogLayer, ElevationLayer, FeatureLayer, GroupLayer, ImageryLayer, ImageryTileLayer, IntegratedMeshLayer, KnowledgeGraphLayer, MapImageLayer, OrientedImageryLayer, PointCloudLayer, SceneLayer, StreamLayer, SubtypeGroupLayer, TileLayer, or VideoLayer.

This is useful when you work with various ArcGIS Server URLs, but you don't necessarily know which layer type(s) they create. This method creates the appropriate layer type for you. In case of a feature service or a scene service, when the URL points to the service and the service has multiple layers, the returned promise will resolve to a GroupLayer.

Beginning with version 4.17, it is possible to load tables from hosted feature services. This only applies to feature layers, and will successfully load if FeatureLayer.isTable returns true.

The following table details what is returned when loading specific URL types.

URL	Returns
Feature service with one layer	FeatureLayer where FeatureLayer.isTable returns `false`.
Feature service with one table	FeatureLayer where FeatureLayer.isTable returns `true`.
Feature service with more than one layer(s)/table(s)	GroupLayer with layers and tables.
Layers with type other than "Feature Layer" are discarded, e.g. Utility Network Layers	N/A

See also

FeatureLayer.isTable

Parameters

Parameter	Type	Description	Required
params	`string \| FromArcGISServerUrlParameters`	Input parameters for creating the layer.

Returns: Promise<Layer>
Returns a promise that resolves to the new Layer instance.

Examples

// This snippet shows how to add a feature layer from an ArcGIS Server URL
// Get an ArcGIS Server URL from a custom function
const arcgisUrl = getLayerUrl();

Layer.fromArcGISServerUrl({
  url: arcgisUrl,
  properties: {
    // set any layer properties here
    popupTemplate: new PopupTemplate()
  }
}).then(function(layer){
  // add the layer to the map
  map.add(layer);
});

// This snippet shows how to add a table from an ArcGIS Server URL
// Get an ArcGIS Server URL from a custom function
const arcgisUrl = getLayerUrl();

Layer.fromArcGISServerUrl({
  url: arcgisUrl
}).then(function(layer){
  // Load the table before it can be used
  layer.load().then(function() {
    // Check that it is the right type
    if (layer.isTable) {
      // Add table to map's tables collection
      map.tables.add(layer);
    }
  });
});

fromPortalItem

inheritedstatic Method

Signature: fromPortalItem (params: LayerFromPortalItemParameters): Promise<Layer>

Inherited from: Layer

Creates a new layer instance of the appropriate layer class from an ArcGIS Online or ArcGIS Enterprise portal item. If the item points to a feature service with multiple layers, then a GroupLayer is created. If the item points to a service with a single layer, then it resolves to a layer of the same type of class as the service.

Note

At version 4.29, MediaLayer can be loaded from portal items.
At version 4.28, GroupLayer and OrientedImageryLayer can be loaded from portal items.
At version 4.25, CSVLayer and GeoJSONLayer can be loaded from CSV and GeoJSON portal items respectively.
At version 4.17, it is possible to load tables from feature service items hosted in ArcGIS Online and ArcGIS Enterprise. This only applies to feature layers, and will successfully load if FeatureLayer.isTable returns true.

The following table details what is returned when loading specific item types.

Item(s)	Returns
Feature service with one layer	FeatureLayer where FeatureLayer.isTable returns `false`.
Feature service with one table	FeatureLayer where FeatureLayer.isTable returns `true`.
Feature service with more than one layer(s)/table(s)	GroupLayer with layers and tables.
Feature collection with one layer	FeatureLayer where FeatureLayer.isTable returns `false`.
Feature collection with one table	FeatureLayer where FeatureLayer.isTable returns `true`.
Feature collection with more than one layer(s)/table(s)	GroupLayer with layers and tables.

Known Limitations

This method does not currently work with OGCFeatureServer portal items.

See also

Parameters

Parameter	Type	Description	Required
params	`LayerFromPortalItemParameters`	The parameters for loading the portal item.

Returns: Promise<Layer>
Returns a promise which resolves to the new layer instance.

Examples

// Create a layer from a specified portal item and add to the map
Layer.fromPortalItem({
  portalItem: {  // autocasts new PortalItem()
    id: "8444e275037549c1acab02d2626daaee"
  }
}).then(function(layer){
  // add the layer to the map
  map.add(layer);
});

// Create a table from a specified portal item and add it to the map's tables collection
Layer.fromPortalItem({
  portalItem: { // autocasts new PortalItem()
    id: "123f4410054b43d7a0bacc1533ceb8dc" // This is a hosted table stored in a feature service
  }
}).then(function(layer) {
  // Necessary to load the table in order for it to be read correctly
  layer.load().then(function() {
    // Confirm this reads as a table
    if (layer.isTable) {
      // Add the new table to the map's table collection
      map.tables.add(layer);
    }
  });
});

addAttachment

Method

Signature: addAttachment (feature: Graphic, attachment: HTMLFormElement | FormData): Promise<FeatureEditResult>

Since: ArcGIS Maps SDK 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.

See also

capabilities.data.supportsAttachment

Parameters

Parameter	Type	Description	Required
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: 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.

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")
      let 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

Method

Signature: applyEdits (edits: Edits, options?: EditOptions): Promise<EditsResult>

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 FeatureLayer's source property. Attachments can also be added, updated or deleted.

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

Notes

FeatureLayers are not optimized for high-frequency, dynamic data, or real-time streaming use cases. As a result, they may not perform efficiently with rapidly updating data streams. For real-time or dynamic data updates, use StreamLayers, which are designed for efficient handling of high-frequency streaming data and dynamic features.
When calling the applyEdits method on a service that does not have vertical coordinate system information, the z-values of the geometries in the edits object will automatically be converted to match the spatial reference of the layer. Example: The service has a horizontal spatial reference with feet units, and applyEdits() is called with z-values based on meter units, then the method will automatically convert the z values from meter to feet units.
As of version 4.17, using applyEdits to add geometries with z-values to a FeatureLayer with hasZ: false no longer silently drops the z-value and now throws an error.

See also

Sample - Edit features

Parameters

Parameter	Type	Description	Required
edits	`Edits`	Object containing features and attachments to be added, updated or deleted.
options	`EditOptions`	Additional edit options to specify when editing features or attachments.

Returns: Promise<EditsResult>
When resolved, an EditsResult object is returned.

Example

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

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

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

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

cancelLoad

inherited Method

Signature: cancelLoad (): this

Inherited from: LoadableMixin

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

Returns: this

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

createFieldConfigurations

Method

Signature: createFieldConfigurations (): FieldConfiguration[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

Creates default field configuration objects that define the display properties of fields. These field configurations are generated from the layer's fields property.

See also

fieldConfigurations

Returns: FieldConfiguration[] | null | undefined
An array of field configuration objects, or null if the layer does not have any fields that require formatting.

Example

const fieldConfigs = featureLayer.createFieldConfigurations();
featureLayer.fieldConfigurations = fieldConfigs;

createLayerView

inherited Method

Signature: createLayerView <T extends LayerView = LayerView>(view: View<T>, options?: AbortOptions): Promise<T>

Type parameters: <T extends LayerView = LayerView>

Inherited from: Layer

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.

See also

Sample - Custom WebGL layer view

Parameters

Parameter	Type	Description	Required
view	`View`	The parent view.
options	`AbortOptions`	An object specifying additional options. See the object specification table below for the required properties of this object.

Returns: Promise
Resolves with a LayerView instance.

createPopupTemplate

Method

Signature: createPopupTemplate (options?: CreatePopupTemplateOptions): PopupTemplate | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.11

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

Parameters

Parameter	Type	Description	Required
options	`CreatePopupTemplateOptions`	Options for creating the popup template.

Returns: PopupTemplate | null | undefined
The popup template, or null if the layer does not have any fields.

createQuery

Method

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

See also

Sample - Query features from a FeatureLayer

Returns: Query
The query object representing the layer's definition expression and other configurations.

Examples

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

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

if (dataCapabilities) {
  if (dataCapabilities.supportsZ && layer.returnZ != null) {
    queryParams.returnZ = layer.returnZ;
  }

  if (dataCapabilities.supportsM && layer.returnM != null) {
    queryParams.returnM = layer.returnM;
  }
}

queryParams.outFields = ["*"];
queryParams.where = layer.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

Method

Signature: deleteAttachments (feature: Graphic, attachmentIds: number[]): Promise<FeatureEditResult[]>

Since: ArcGIS Maps SDK 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.

See also

capabilities.data.supportsAttachment

Parameters

Parameter	Type	Description	Required
feature	`Graphic`	Feature containing attachments to be deleted.
attachmentIds	`number[]`	Ids of the attachments to be deleted.

Returns: Promise<FeatureEditResult[]>
When resolved, an array of FeatureEditResults 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.

destroy

inherited Method

Signature: destroy (): void

Inherited from: Layer

Since: ArcGIS Maps SDK for JavaScript 4.17

Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). The layer can no longer be used once it has been destroyed.

The destroyed layer will be removed from its parent object like Map, WebMap, WebScene, Basemap, Ground, or GroupLayer.

See also

Returns: void

emit

inherited Method

Signature: emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Since: ArcGIS Maps SDK for JavaScript 4.5

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

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.
event	`this["@eventTypes"][Type]`	The event payload.

Returns: boolean
true if a listener was notified

fetchAttributionData

inherited Method

Signature: fetchAttributionData (): Promise<any>

Inherited from: Layer

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

Returns: Promise<any>
Resolves to an object containing custom attribution data for the layer.

getFeatureTitle

Method

Signature: getFeatureTitle (graphic: Graphic, options?: FeatureTitleOptions): Promise<string>

Since: ArcGIS Maps SDK for JavaScript 4.34

Returns the title of a feature. The feature title is generated based on the following conditions for a FeatureLayer.

If the feature has a popup title configured, then the popup title will be returned.
If the feature does not have a popup title, then the displayField value will be returned.
If there is no displayField, then the objectId will be returned.

Parameters

Parameter	Type	Description	Required
graphic	`Graphic`	The graphic for which to generate a title.
options	`FeatureTitleOptions`	Additional options that control how the title is generated.

Returns: Promise<string>
When resolved, returns the feature's title string.

getFeatureType

Method

Signature: getFeatureType (feature: Graphic | null | undefined): FeatureType | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.7

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

Parameters

Parameter	Type	Description	Required
feature	`Graphic \| null \| undefined`	A feature from this layer.

Returns: FeatureType | null | undefined
The FeatureType describing the feature's type.

getField

inherited Method

Signature: getField (fieldName: string): Field | null | undefined

Inherited from: FeatureLayerBase

Since: ArcGIS Maps SDK for JavaScript 4.11

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

See also

FeatureLayer.fields

Parameters

Parameter	Type	Description	Required
fieldName	`string`	Name of the field.

Returns: Field | null | undefined
the matching field or undefined

getFieldAlias

Method

Signature: getFieldAlias (fieldName: string): string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

Returns the alias of the specified field. Previously, this value was commonly retrieved from FeatureLayer.popupTemplate.fieldInfos[x].label or FeatureLayer.fields[x].alias. While these properties are still supported, this method is now the recommended approach for obtaining a field's alias.

The alias is resolved in the following order:

Field configuration alias
Field.alias defined on the field.

See also

Parameters

Parameter	Type	Description	Required
fieldName	`string`	The name of the field.

Returns: string | null | undefined
The field alias of the specified field.

getFieldConfiguration

Method

Signature: getFieldConfiguration (fieldName: string): FieldConfiguration | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

Returns the FieldConfigurations for the specified field. The field configuration provides optional formatting and display information for the field.

Previously, field formatting was commonly retrieved from FeatureLayer.popupTemplate.fieldInfos[x].format. This is no longer needed, instead use FeatureLayer.getFieldConfiguration(fieldname).fieldFormat to retrieve the field configuration formatting.

See also

Parameters

Parameter	Type	Description	Required
fieldName	`string`	The name of the field.

Returns: FieldConfiguration | null | undefined
The field configuration of the specified field.

getFieldDomain

inherited Method

Signature: getFieldDomain (fieldName: string, options?: FieldDomainOptions): DomainUnion | null | undefined

Inherited from: FeatureLayerBase

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

Parameters

Parameter	Type	Description	Required
fieldName	`string`	Name of the field.
options	`FieldDomainOptions`	An object specifying additional options. See the object specification table below for the required properties of this object.

Returns: DomainUnion | null | undefined
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().
layer.queryFeatures(query).then(function(results){
  const domain = layer.getFieldDomain("Height", {feature: results.features[0]});
  console.log("domain", domain)
});

hasEventListener

inherited Method

Signature: hasEventListener <Type extends EventNames<this>>(type: Type): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

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

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.

Returns: boolean
Returns true if the class supports the input event.

isFulfilled

inherited Method

Signature: isFulfilled (): boolean

Inherited from: EsriPromiseMixin

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: boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected

inherited Method

Signature: isRejected (): boolean

Inherited from: EsriPromiseMixin

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

Returns: boolean
Indicates whether creating an instance of the class has been rejected.

isResolved

inherited Method

Signature: isResolved (): boolean

Inherited from: EsriPromiseMixin

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

Returns: boolean
Indicates whether creating an instance of the class has been resolved.

load

inherited Method

Signature: load (options?: AbortOptions | null | undefined): Promise<this>

Inherited from: LoadableMixin

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.

The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.

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.

Parameters

Parameter	Type	Description	Required
options	`AbortOptions \| null \| undefined`	Additional options.

Returns: Promise<this>
Resolves when the resources have loaded.

on

inherited Method

Signature: on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

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

Parameters

Parameter	Type	Description	Required
type	`Type`	An event or an array of events to listen for.
listener	`EventedCallback<this["@eventTypes"][Type]>`	The function to call when the event fires.

Returns

ResourceHandle

Returns an event handler with a remove() method that should 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

Method

Signature: queryAttachments (attachmentQuery: AttachmentQueryProperties, options?: RequestOptions): Promise<Record<string, AttachmentInfo[]>>

Since: ArcGIS Maps SDK 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'scapabilities.operations.supportsQueryAttachments property is false, AttachmentQuery.objectIds property only accepts a single objectId.

See also

Parameters

Parameter	Type	Description	Required
attachmentQuery	`AttachmentQueryProperties`	Specifies the attachment parameters for query.
options	`RequestOptions`	An object with the following properties.

Returns: Promise<Record<string, AttachmentInfo[]>>
When resolved, returns an object containing AttachmentInfos grouped by the source feature objectIds.

Example

layer.when(function () {
  // queryObjectIds for all features within the layer
  layer.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.
    let 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
    layer.queryAttachments(attachmentQuery).then(function (attachments) {
      // Print out all returned attachment infos to the console.
      attachmentQuery.objectIds.forEach(function (objectId) {
        if (attachments[objectId]) {
          let 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);
    })
  });
});

queryAttributeBins

Method

Signature: queryAttributeBins (binsQuery: AttributeBinsQueryProperties, options?: RequestOptions): Promise<AttributeBinsFeatureSet>

Since: ArcGIS Maps SDK for JavaScript 4.32

Executes a AttributeBinsQuery against a feature service, which groups features into bins based on ranges in numeric or date fields, and returns a AttributeBinsFeatureSet containing the series of bins. Please refer to the AttributeBinsQuery document for more detailed information on how to configure the bin parameters.

Binned data can condense complex information into meaningful insight. This query allows you to classify data into meaningful categories and summarize the data within each bin with summary statistics. Binned data can be effectively visualized in histograms (or bar charts), providing clearer insights into data distributions and trends. It can reveal underlying patterns that might be obscured in raw data. For example, bins can show concentrations of values in common ranges.

Notes

The queryAttributeBins() method is unrelated to querying bins in FeatureReductionBinning.

See also

Parameters

Parameter	Type	Description	Required
binsQuery	`AttributeBinsQueryProperties`	Specifies the parameters of the `queryAttributeBins()` operation. The AttributeBinsQuery.binParameters property must be set.
options	`RequestOptions`	An object with the following properties.

Returns: Promise<AttributeBinsFeatureSet>
When resolved, returns a FeatureSet containing a series of bins. Each feature in the AttributeBinsFeatureSet represents a bin. The attributes of each feature contains statistics summarizing the data in the bin, including count, average, standard deviation, etc.

Example

// Query the temperature field in the feature layer and create a histogram
// Analyze temperature data over a year, create 100 bins for different temperature ranges
// to assess frequency and identify patterns.
const binQuery = new AttributeBinsQuery({
  where: "UnitTop = 0",
  binParameters: new AutoIntervalBinParameters({
    bins: 100,
    field: "temp",
    start: 0, // lowest temp value to be included in the bin query
    end: 30 // highest temp value to be included
  })
});

layer.queryAttributeBins(query).then((results) => {
  const bins = results.features.map((bin) => {
    return {
      minValue: bin.attributes.lowerBoundary,
      maxValue: bin.attributes.upperBoundary,
      count: bin.attributes.temperature_count,
    };
  });

  // get the lower boundary of the first bin
  const min = results.features[0].attributes.lowerBoundary;
  // get the upper boundary of the last bin
  const max = results.features[results.features.length - 1].attributes.upperBoundary;
  // calculate the average for the bins
  const average = results.features[0].attributes.lowerBoundary + results.features[results.features.length - 1].attributes.upperBoundary) / 2;

  const histogram = new Histogram({
    container: "histogramDiv",
    bins: bins,
    min: min,
    max: max,
    average: average,
    barCreatedFunction:(index, element) => {
      element.setAttribute("fill", "#FFA500");
      element.setAttribute("opacity", 0.5);
    },
    labelFormatFunction: (value, type) => {
      return (Math.round(value)).toLocaleString();
    },
    dataLines: [{
      value: histogram.min,
      label: histogram.min.toLocaleString()
    }, {
      value: histogram.average,
      label: histogram.average.toLocaleString()
    }, {
      value: histogram.max,
      label: histogram.max.toLocaleString()
    }]
  });
});

queryExtent

Method

Signature: queryExtent (query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<{ count: number; extent: Extent | null; }>

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.

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.

See also

Sample - Zoom to extent of all features

Parameters

Parameter	Type	Description	Required
query	`QueryProperties \| null \| undefined`	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	`RequestOptions`	An object with the following properties.

Returns

Promise<{ count: number; extent: Extent | null; }>

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 \| null	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((results) =>{
  view.goTo(results.extent);  // go to the extent of the results satisfying the query
});

queryFeatureCount

Method

Signature: queryFeatureCount (query?: QueryProperties | null | undefined, options?: RequestOptions): 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.

See also

Sample - Query features from a FeatureLayer

Parameters

Parameter	Type	Description	Required
query	`QueryProperties \| null \| undefined`	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	`RequestOptions`	An object with the following properties.

Returns: Promise<number>
When resolved, returns the number of features that satisfy the query.

Examples

// Queries for the count of all features matching the layer's configurations
// e.g. definitionExpression
layer.queryFeatureCount().then((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'";

const featureCount = await layer.queryFeatureCount(query);
console.log(featureCount);  // prints the number of results satisfying the query

queryFeatures

Method

Signature: queryFeatures (query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<FeatureSet>

Executes a Query against the feature service and returns a FeatureSet once the promise resolves. A FeatureSet contains an array of features. See the querying section for more information on how to query features from a layer.

Notes

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

When querying a service with z-values and no vertical coordinate system information, the z-values will automatically be converted to match the Query.outSpatialReference units. Example: The service has a horizontal spatial reference using feet units and the query is made with outSpatialReference based on meter units, then queryFeatures() automatically converts the values from feet to meter units.

See also

Parameters

Parameter	Type	Description	Required
query	`QueryProperties \| null \| undefined`	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	`RequestOptions`	An object with the following properties.

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

Examples

// Queries for all the features matching the layer's configurations
// e.g. definitionExpression
layer.queryFeatures().then((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((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((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"]
};

const results = await layer.queryFeatures(query);
console.log(results.features);  // prints the array of features to the console

queryObjectIds

Method

Signature: queryObjectIds (query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<ObjectId[]>

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 available to or visible in the View on the client rather than making a server-side query, you must use the FeatureLayerView.queryObjectIds() method.

See also

Sample - Query Related Features

Parameters

Parameter	Type	Description	Required
query	`QueryProperties \| null \| undefined`	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	`RequestOptions`	An object with the following properties.

Returns: Promise<ObjectId[]>
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((results) => {
  // prints the array of Object IDs to the console
  console.log(results);
});

const layer = new FeatureLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3"
});

const query = new Query({
  where: "SUB_REGION = 'Pacific'"
});

const ids = await layer.queryObjectIds(query);
console.log(ids);  // an array of object IDs

queryRelatedFeatures

Method

Signature: queryRelatedFeatures (relationshipQuery: RelationshipQueryProperties, options?: RequestOptions): Promise<Record<string, FeatureSet>>

Since: ArcGIS Maps SDK for JavaScript 4.9

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

See also

Parameters

Parameter	Type	Description	Required
relationshipQuery	`RelationshipQueryProperties`	Specifies relationship parameters for querying related features or records from a layer or a table.
options	`RequestOptions`	An object with the following properties.

Returns: Promise<Record<string, FeatureSet>>
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.

Example

const objectIds = [385, 416];

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

// query related features for given objectIds
layer.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);
});

queryRelatedFeaturesCount

Method

Signature: queryRelatedFeaturesCount (relationshipQuery: RelationshipQueryProperties, options?: RequestOptions): Promise<Record<string, number>>

Since: ArcGIS Maps SDK for JavaScript 4.17

Executes a RelationshipQuery against the feature service and when resolved, it returns an object containing key value pairs. Key in this case is the objectId of the feature and value is the number of related features associated with the feature.

See also

Parameters

Parameter	Type	Description	Required
relationshipQuery	`RelationshipQueryProperties`	Specifies relationship parameters for querying related features or records from a layer or a table.
options	`RequestOptions`	An object with the following properties.

Returns: Promise<Record<string, number>>
When resolved, returns a hashmap containing key value pairs. Key in this case is the objectId of the feature and value is the number of related features.

Example

const objectIds = [385, 416];

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

// query related features for given objectIds
layer.queryRelatedFeaturesCount(query).then(function (count) {
  console.log("queryRelatedFeaturesCount", count);
  // this will print out
  // {385: 91, 416: 23}
}).catch(function (error) {
  console.log("error from queryRelatedFeatures", error);
});

queryTopFeatureCount

Method

Signature: queryTopFeatureCount (topFeaturesQuery?: TopFeaturesQueryProperties, options?: RequestOptions): Promise<number>

Since: ArcGIS Maps SDK for JavaScript 4.20

Executes a TopFeaturesQuery against a feature service and returns the count of features or records that satisfy the query.

Known Limitations

Currently, the queryTopFeatureCount is only supported with server-side FeatureLayers.

See also

Parameters

Parameter	Type	Description	Required
topFeaturesQuery	`TopFeaturesQueryProperties`	Specifies the attributes, spatial, temporal, and top filter of the query. The TopFeaturesQuery.topFilter parameter must be set.
options	`RequestOptions`	An object with the following properties.

Returns: Promise<number>
When resolved, returns the number of features satisfying the query.

Example

// set the query to return a count
// of features that has most sales grouped by regions.
// top query will run against all features available in the service
const query = new TopFeaturesQuery({
  topFilter: new TopFilter({
    topCount: 1,
    groupByFields: ["Region"],
    orderByFields: ["Sales DESC"]
  })
});
featureLayer.queryTopFeatureCount(query)
  .then(function(response){
     // returns the number of the features that have the most sales by region.
   });

queryTopFeatures

Method

Signature: queryTopFeatures (topFeaturesQuery: TopFeaturesQueryProperties, options?: RequestOptions): Promise<FeatureSet>

Since: ArcGIS Maps SDK for JavaScript 4.20

Executes a TopFeaturesQuery against a feature service and returns a FeatureSet once the promise resolves. The FeatureSet contains an array of top features grouped and ordered by specified fields. For example, you can call this method to query top three counties grouped by state names while ordering them based on their populations in a descending order.

Known Limitations

Currently, the queryTopFeatures is only supported with server-side FeatureLayers.

See also

Parameters

Parameter	Type	Description	Required
topFeaturesQuery	`TopFeaturesQueryProperties`	Specifies the attributes, spatial, temporal, and top filter of the query. The TopFeaturesQuery.topFilter parameter must be set.
options	`RequestOptions`	An object with the following properties.

Returns: Promise<FeatureSet>
When resolved, returns a FeatureSet containing an array of features that are grouped and ordered specified fields.

Example

// Query the most visited national parks in each state
// and order them by the most visited
// query will run against all features available in the service
const query = new TopFeaturesQuery({
  outFields: ["State, TOTAL, Park"],
  topFilter: new TopFilter({
    topCount: 1,
    groupByFields: ["State"],
    orderByFields: ["TOTAL DESC"]
  })
});
featureLayer.queryTopFeatures(query)
  .then(function(response){
     // returns a feature set with features containing the most visited
     // national park in each state ordered by the number of visits.
     // The following attributes are returned as well: State, TOTAL, Park
   });

queryTopFeaturesExtent

Method

Signature: queryTopFeaturesExtent (topFeaturesQuery?: TopFeaturesQueryProperties, options?: RequestOptions): Promise<{ count: number; extent: Extent | null; }>

Since: ArcGIS Maps SDK for JavaScript 4.20

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

Known Limitations

Currently, the queryTopFeaturesExtent is only supported with server-side FeatureLayers.

See also

Parameters

Parameter	Type	Description	Required
topFeaturesQuery	`TopFeaturesQueryProperties`	Specifies the attributes, spatial, temporal, and top filter of the query. The TopFeaturesQuery.topFilter parameter must be set.
options	`RequestOptions`	An object with the following properties.

Returns

Promise<{ count: number; extent: Extent | null; }>

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 query.
extent	Extent \| null	The extent of features that satisfy the query.

Example

// Get the count and extent of the three highest magnitude earthquakes
// in each region.
const query = new TopFeaturesQuery({
  where: "mag >= 6",
  geometry: studyExtent,
  topFilter: new TopFilter({
    topCount: 3,
    groupByFields: ["region"],
    orderByFields: ["mag DESC"]
  })
});
featureLayer.queryTopFeaturesExtent(query)
  .then(function(response){
     // returns the count and extent of top three earthquakes within each region
   });

queryTopObjectIds

Method

Signature: queryTopObjectIds (topFeaturesQuery?: TopFeaturesQueryProperties, options?: RequestOptions): Promise<number[]>

Since: ArcGIS Maps SDK for JavaScript 4.20

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

Known Limitations

Currently, the queryTopObjectIds is only supported with server-side FeatureLayers.

See also

Parameters

Parameter	Type	Description	Required
topFeaturesQuery	`TopFeaturesQueryProperties`	Specifies the attributes, spatial, temporal, and top filter of the query. The TopFeaturesQuery.topFilter parameter must be set.
options	`RequestOptions`	An object with the following properties.

Returns: Promise<number[]>
When resolved, returns an array of numbers representing the object IDs of features satisfying the query.

Example

// Get the objectIds top three earthquakes
// grouped by regions and ordered by their magnitude levels
// top query will only run against earthquakes that have mag >=6.
const query = new TopFeaturesQuery({
  where: "mag >= 6",
  topFilter: new TopFilter({
    topCount: 3,
    groupByFields: ["region"],
    orderByFields: ["mag DESC"]
  })
});
featureLayer.queryTopObjectIds(query)
  .then(function(response){
     // returns an array of object ids of top three earthquakes within each region
   });

refresh

Method

Signature: refresh (): void

Since: ArcGIS Maps SDK for JavaScript 4.6

Fetches all the data for the layer. The data is only updated if the lastEditDate in the layer's metadata is different from the lastEditDate field. If the lastEditDate metadata info is not available, the FeatureLayer refreshes unconditionally.

See also

Returns: void

save

Method

Signature: save (options?: LayerSaveOptions): Promise<PortalItem>

Since: ArcGIS Maps SDK for JavaScript 4.24

Saves the layer to its existing portal item in the Portal authenticated within the user's current session. If the layer is not saved to a PortalItem, then you should use saveAs().

Known Limitations

You can only save service-backed FeatureLayers. Client-side layers cannot be saved.

Parameters

Parameter	Type	Description	Required
options	`LayerSaveOptions`	Various options for saving the layer.

Returns: Promise<PortalItem>
When resolved, returns the portal item to which the layer is saved.

Example

const portalItem = await layer.save();

saveAs

Method

Signature: saveAs (portalItem: PortalItemProperties, options?: LayerSaveAsOptions): Promise<PortalItem>

Since: ArcGIS Maps SDK for JavaScript 4.24

Saves the layer to a new portal item in the Portal authenticated within the user's current session.

Known Limitations

You can only save service-backed FeatureLayers. Client-side layers cannot be saved.

Parameters

Parameter	Type	Description	Required
portalItem	`PortalItemProperties`	The portal item to which the layer will be saved.
options	`LayerSaveAsOptions`	Various options for saving the layer.

Returns: Promise<PortalItem>
When resolved, returns the portal item to which the layer is saved.

Example

const portalItem = new PortalItem();
await layer.saveAs(portalItem);

updateAttachment

Method

Signature: updateAttachment (feature: Graphic, attachmentId: number, attachment: HTMLFormElement | FormData): Promise<FeatureEditResult>

Since: ArcGIS Maps SDK 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.

See also

capabilities.data.supportsAttachment

Parameters

Parameter	Type	Description
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: 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.

when

inherited Method

Signature: when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>

Type parameters: <TResult1 = this, TResult2 = never>

Inherited from: EsriPromiseMixin

Since: ArcGIS Maps SDK for JavaScript 4.6

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

Parameters

Parameter	Type	Description	Required
onFulfilled	`OnFulfilledCallback<this, TResult1> \| null \| undefined`	The function to call when the promise resolves.
onRejected	`OnRejectedCallback \| null \| undefined`	The function to execute when the promise fails.

Returns: Promise<TResult1 | TResult2>
Returns a new promise for the result of onFulfilled that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let 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
});

Events

Name	Type
`edits` inherited	CustomEvent<EditsResultEvent>
`layerview-create` inherited	CustomEvent<LayerLayerviewCreateEvent>
`layerview-create-error` inherited	CustomEvent<LayerLayerviewCreateErrorEvent>
`layerview-destroy` inherited	CustomEvent<LayerLayerviewDestroyEvent>
`refresh` inherited	CustomEvent<RefreshEvent>

edits

inherited Event

edits: CustomEvent<EditsResultEvent>

Inherited from: EditBusLayerEvents

Fires after FeatureLayer.applyEdits() is completed successfully. The event payload includes only successful edits, not the failed edits. applyEdits() will pass in a sessionId during an active edit session.

See also

FeatureLayer.applyEdits()

Example

// This function will fire each time applyEdits() is completed successfully
layer.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-create

inherited Event

layerview-create: CustomEvent<LayerLayerviewCreateEvent>

Inherited from: LayerEvents

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

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-error

inherited Event

layerview-create-error: CustomEvent<LayerLayerviewCreateErrorEvent>

Inherited from: LayerEvents

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

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-destroy

inherited Event

layerview-destroy: CustomEvent<LayerLayerviewDestroyEvent>

Inherited from: LayerEvents

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

refresh

inherited Event

refresh: CustomEvent<RefreshEvent>

Inherited from: RefreshableLayerEvents

Since: ArcGIS Maps SDK for JavaScript 4.21

Fires if the layer has the refreshInterval set or when refresh() method is called. The event payload indicates if the layer's data has changed.

See also

Examples

// listen to layer's refresh event to fetch the attachments
// for the updated features.
layer.on("refresh", async (event) =>{
  if (!event.dataChanged){
    return;
  }

  try {
    const query = layer.createQuery();
    const objectIds = await layer.queryObjectIds(query);
    let attachmentQuery = {
      objectIds: objectIds,
      definitionExpression: layer.definitionExpression,
      attachmentTypes: ["image/jpeg"]
    };

    const attachments = await layer.queryAttachments(attachmentQuery);

    attachmentQuery.objectIds.forEach(function (objectId) {
      if (attachments[objectId]) {
        // process the updated attachments
        let attachment = attachments[objectId];
        console.log("Attachments for objectId ", objectId, attachment);
      }
    });
  } catch (error) {
    console.log("attachment query error", error);
  }
});

// listen to layer's refresh event to fetch object ids of completed features
layer.on("refresh", function(event){
  if (event.dataChanged){
    const query = layer.createQuery();
    query.where = "Status = 'Completed'";
    layer.queryObjectIds(query).then((objectIds) => {
     // process returned features
    });
  }
});