Class: esri/widgets/LayerList/ListItem
Since: ArcGIS API for JavaScript 4.2

The ListItem class represents one of the operationalItems in the LayerListViewModel.

See also:

Property Overview

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

Whether the actional panel is open in the LayerList.

more details
more detailsListItem
Collection<Collection<Action>>

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

more details
more detailsListItem
Collection<ListItem>

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

more details
more detailsListItem
Error

The Error object returned if an error occurred.

more details
more detailsListItem
Layer

The layer associated with the triggered action.

more details
more detailsListItem
LayerView

The LayerView displaying data for the associated layer.

more details
more detailsListItem
Boolean

Whether the layer is open in the LayerList.

more details
more detailsListItem
ListItemPanel

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

more details
more detailsListItem
ListItem

The parent of this item.

more details
more detailsListItem
String

The title of the layer.

more details
more detailsListItem
Boolean

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

more details
more detailsListItem
MapView | SceneView

The view from which the widget will operate.

more details
more detailsListItem
String

Indicates how to manage the visibility of the children layers.

more details
more detailsListItem
Boolean

Indicates if the ListItem is visible.

more details
more detailsListItem
Boolean

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

more details
more detailsListItem

Property Details

actionsOpenBoolean

Whether the actional panel is open in the LayerList.

Default Value:false
Autocasts from Object[][]

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

See also:

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.

Whether the layer is open in the LayerList.

Default Value:false
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

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

NameReturn TypeSummaryClass
ListItem

Creates a deep clone of this object.

more details
more detailsListItem

Method Details

clone(){ListItem}

Creates a deep clone of this object.

Returns:
TypeDescription
ListItemA clone of the new ListItem instance.
Searching...

API Reference search results

NameTypeModule

There were no match results from your search criteria.