Property Overview

Property Details

actionsOpenBoolean

Whether the actional panel is open in the LayerList.

Default Value:false

actionsSectionsCollection<Collection<Action>>autocast

Autocasts from Object[][]

A nested 2-dimensional collection of actions that could be triggered on the item.

See also:

• Sample - LayerList widget with actions

childrenCollection<ListItem>

When a layer contains sublayers, this property is a Collection of ListItem objects belonging to the given layer.

errorErrorreadonly

The Error object returned if an error occurred.

layerLayer

The layer associated with the triggered action.

Default Value:null

layerViewLayerViewreadonly

The LayerView displaying data for the associated layer.

openBoolean

Whether the layer is open in the LayerList.

Default Value:false

panelListItemPanel

Since: ArcGIS API for JavaScript 4.7

Allows you to display custom content for each ListItem in the LayerList widget.

A common scenario for using ListItemPanel is to display a Legend widget within each list item. The legend keyword can be used in the content property of the panel to display a legend for each layer in the LayerList.

Examples:

// displays the legend for each layer list item
const layerList = new LayerList({
  view: view,
  listItemCreatedFunction: function(event){
    const item = event.item;
    item.panel = {
      content: "legend"
    };
  }
});

// displays content from the DOM in the LayerList
const layerList = new LayerList({
  view: view,
  listItemCreatedFunction: function(event){
    const item = event.item;
    item.panel = {
      content: document.getElementById("myDiv"),
      className: "esri-icon-chart",
      open: item.visible
    };
  }
});

parentListItem

Since: ArcGIS API for JavaScript 4.5

The parent of this item

Default Value:null

titleString

The title of the layer.

updatingBooleanreadonly

Value is true when the layer is updating; for example, if it is in the process of fetching data.

Default Value:false

viewMapView|SceneView

The view from which the widget will operate.

visibilityModeStringreadonly

Indicates how to manage the visibility of the children layers.

visibleBoolean

Indicates if the ListItem is visible.

Default Value:true

visibleAtCurrentScaleBooleanreadonly

Whether the layer is visible at the current scale or not.

Default Value:true

Method Overview

Method Details

clone(){ListItem}

Creates a deep clone of this object.

Returns:

Type	Description
ListItem	A clone of the new ListItem instance.