AnnotationFeatureLayer | References | ArcGIS Maps SDK for JavaScript

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

const AnnotationFeatureLayer = await $arcgis.import("@arcgis/core/layers/AnnotationFeatureLayer.js");

Inheritance: AnnotationFeatureLayer→Layer→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.1

beta

An AnnotationFeatureLayer displays text as features in a 2D map. An annotation is a type of feature that consists of text with position, layout, and style attributes. Initially, the AnnotationFeatureLayer will display all sublayers from the service, but you can configure the visibility of each AnnotationFeatureSublayer using the visible property on each sublayer. Annotation features are not supported by the Legend component and the printed legend (it does print, but will not display in the printed legend). Example of an annotation feature (see Annotation in ArcGIS Pro for more information on creating and publishing annotation features):

AnnotationFeatureLayers may be created from a url. AnnotationFeatureLayers are published with specific fonts and symbols to be used for display. Annotation features text use the same client-side rendering engine as labels. If the font specified by the service is not available, a default font will be used instead. See the Labeling guide for more information on how to configure labeling and text symbols.

// get a reference to arcgis-map
const viewElement = document.querySelector("arcgis-map");
// Create an annotation feature layer from a feature service layer URL
const layer = new AnnotationFeatureLayer({
 url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/RiversAnnotation/FeatureServer/0"
});
// add the layer to the map
viewElement.map.add(layer);

Known Limitations The following features are not currently supported at this release. Future releases will see increased functionality and support for additional features.

Editing

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	AnnotationFeatureLayerProperties

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

Example

// Create an annotation layer from a feature service layer URL.

const layer = new AnnotationFeatureLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/RiversAnnotation/FeatureServer/0"
});

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
blendMode inherited	BlendMode	BlendLayer
capabilities readonly inherited	FeatureLayerCapabilities	FeatureLayerBase
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
editFieldsInfo readonly inherited	EditFieldsInfo \| null \| undefined	FeatureLayerBase
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
effectiveUniqueIdFields readonly inherited	string[]	FeatureLayerBase
elevationInfo inherited	ElevationInfo \| null \| undefined	FeatureLayerBase
fields readonly	Field[]
fieldsIndex readonly inherited	FieldsIndex<Field>	FeatureLayerBase
floorInfo inherited	LayerFloorInfo \| null \| undefined	FeatureLayerBase
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
layerId inherited	number	FeatureLayerBase
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
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
refreshInterval inherited	number	RefreshableLayer
relationships readonly inherited	Relationship[] \| null \| undefined	FeatureLayerBase
returnM inherited	boolean \| null \| undefined	FeatureLayerBase
returnZ inherited	boolean \| null \| undefined	FeatureLayerBase
serviceDefinitionExpression readonly inherited	string \| null \| undefined	FeatureLayerBase
serviceItemId readonly inherited	string \| null \| undefined	FeatureLayerBase
sourceJSON inherited	Record<string, any> \| null \| undefined	FeatureLayerBase
spatialReference inherited	SpatialReference	FeatureLayerBase
sublayers	Collection<AnnotationFeatureSublayer>
subtypeField readonly inherited	string	FeatureLayerBase
subtypes readonly inherited	Subtype[] \| null \| undefined	FeatureLayerBase
timeExtent inherited	TimeExtent \| null \| undefined	TemporalLayer
timeInfo inherited	TimeInfo \| null \| undefined	TemporalLayer
timeOffset inherited	TimeInterval \| null \| undefined	TemporalLayer
title inherited	string \| null \| undefined	FeatureLayerBase
type readonly	"annotation-feature"
uid readonly inherited	string	IdentifiableMixin
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"
});

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

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.

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.

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.

effectiveUniqueIdFields

readonlyinherited Property

Type: string[]

Inherited from: FeatureLayerBase

effectiveUniqueIdFields is a convenience property that returns either the layer's FeatureLayer.uniqueIdFields, if defined, or the layer's FeatureLayer.objectIdField as an array.

Example

const query = layer.createQuery();
query.outFields = layer.effectiveUniqueIdFields;

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.

fields

readonly Property

Type: Field[]

An array of fields in the layer.

See also

objectIdField

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.

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 layer has m aware geometries. Use the supportsM property in the layer's DataCapabilities to verify if m-values are supported by the layer.

When true: The layer has m aware features. M-values are part of the geometry.
When false: The layer does not have m aware features. M-values are not part of the geometry.

See also

returnM for details regarding fetching m-values with features from a layer
Linear referencing

hasZ

inherited Property

Type: boolean

Inherited from: FeatureLayerBase

Indicates whether the layer has z aware geometries. Use the supportsZ property in the layer's DataCapabilities to verify if z-values are supported by the layer.

When true: The layer has z aware features. Z-values are part of the geometry.
When false: The layer does not have z aware features. Z-values are not part of the geometry.

Refer to elevationInfo for details regarding placement and rendering of features with z-values in 3D SceneViews.

See also

returnZ for details regarding fetching z-values with features from a layer
Point.z for more information on how z-values are represented in geometries

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

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

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;

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 ["*"]. Set this property to include the fields that will be used for client-side queries if the fields are not part of required fields.

See also

Examples

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

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

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 an AnnotationFeatureLayer.

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://next.gha.afd.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.

refreshInterval

inherited Property

Type: number

Inherited from: RefreshableLayer

Since: ArcGIS Maps SDK for JavaScript 4.6

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

See also

Default value: 0

Example

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

returnM

inherited Property

Type: boolean | null | undefined

Inherited from: FeatureLayerBase

Determines whether m-values (measure) are returned in feature geometries. For 2D views, support was added at version 5.1 and the behavior is as follows:

When undefined (default): Fetches m-values if they are needed for rendering or labeling, or layer property interacts with the geometry. Otherwise, m-values are excluded from feature queries.
When true: Fetches m-values with the geometry, ensuring they are available on the client.
When false: Excludes m-values from feature queries. M-values are not part of geometries.

3D views do not support m-values. They will not be fetched or returned in 3D scene queries, regardless of this setting.

See also

FeatureLayerBase.hasM

returnZ

inherited Property

Type: boolean | null | undefined

Inherited from: FeatureLayerBase

Determines whether z-values (elevation) are returned in feature geometries. For 3D views, z-values are always fetched regardless of the returnZ setting. For 2D views, support was added at version 5.1 and the behavior is as follows:

When undefined (default): Fetches z-values if they are needed for rendering or labeling, or layer property interacts with the geometry. Otherwise, z-values are excluded from feature queries.
When true: Fetches z-values with the geometry, ensuring they are available on the client.
When false: Excludes z-values from feature queries. Z-values are not part of geometries.

See also

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

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

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.

sublayers

autocast Property

Type: Collection<AnnotationFeatureSublayer>

A Collection of AnnotationFeatureSublayer objects that allow you to alter the visibility of one or more sublayers of the AnnotationFeatureLayer. If this property is not specified, all the sublayers from the feature service are displayed as defined in the service.

All sublayers must be referenced using the AnnotationFeatureSublayer.subtypeCode to identify the sublayer. The sublayers may be added, removed, or reordered using the Collection methods. Because AnnotationFeatureSublayer extends Accessor, its properties may be watched.

Example

// Only includes the first AnnotationFeatureSublayer from the AnnotationFeatureLayer
let layer = new AnnotationFeatureLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/RiversAnnotation/FeatureServer/0",
  sublayers: [{
    subtypeCode: 0,
    visible: true
  }]
});

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

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, OGCFeatureLayer 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.

type

readonly Property

Type: "annotation-feature"

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

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.

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
cancelLoad inherited	cancelLoad(): this	LoadableMixin
clone inherited	clone(): this	ClonableMixin
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
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
findSublayerForFeature	findSublayerForFeature(feature: Graphic): AnnotationFeatureSublayer \| null \| undefined
findSublayerForSubtypeCode	findSublayerForSubtypeCode(subtypeCode: number): AnnotationFeatureSublayer \| null \| undefined
getField inherited	getField(fieldName: string): Field \| null \| undefined	FeatureLayerBase
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
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[]>
refresh inherited	refresh(): void	RefreshableLayer
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, IntegratedMesh3DTilesLayer, IntegratedMeshLayer, GaussianSplatLayer, 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);
    }
  });
});

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.

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

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 a query object that respects the layer's current filters.

Returns: Query
A query object initialized from the layer configuration.

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.

findSublayerForFeature

Method

Signature: findSublayerForFeature (feature: Graphic): AnnotationFeatureSublayer | null | undefined

Returns the sublayer to which the given feature belongs.

Parameters

Parameter	Type	Description	Required
feature	Graphic	The feature whose sublayer will be returned.

Returns: AnnotationFeatureSublayer | null | undefined
The sublayer from the AnnotationFeatureLayer to which the feature belongs to.

findSublayerForSubtypeCode

Method

Signature: findSublayerForSubtypeCode (subtypeCode: number): AnnotationFeatureSublayer | null | undefined

Returns the sublayer with the SubtypeSublayer.subtypeCode that matches the number passed as an argument.

Parameters

Parameter	Type	Description	Required
subtypeCode	number	The subtype coded value.

Returns: AnnotationFeatureSublayer | null | undefined
The sublayer from the AnnotationFeatureLayer to which the feature belongs to.

Example

// Updates the visibility of a sublayer after first finding
// the sublayer from the subtypeCode.
const subtypeCode = 5;
const sublayer = annotationFeatureLayer.findSublayerForSubtypeCode(subtypeCode);

sublayer.visible = true;

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

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

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

Example

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

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

Example

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

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 AnnotationFeatureLayerView.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 AnnotationFeatureLayer({
  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
});

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

Example

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

refresh

inherited Method

Signature: refresh (): void

Inherited from: RefreshableLayer

Since: ArcGIS Maps SDK for JavaScript 4.6

Fetches all the data for the layer.

See also

Returns: void

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

Constructors

Parameters

Properties

Methods

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Events

Type definitions