ListItem

AMD: require(["esri/widgets/LayerList/ListItem"], (ListItem) => { /* code goes here */ });
ESM: import ListItem from "@arcgis/core/widgets/LayerList/ListItem";
Class: esri/widgets/LayerList/ListItem
Inheritance: ListItem Accessor
Since: ArcGIS API for JavaScript 4.2

The ListItem class represents one of the operationalItems in the LayerListViewModel. In the LayerList widget UI, the list item represents a layer displayed in the view. It provides access to the associated layer's properties, allows the developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.

To hide list items in the LayerList widget, you must set the listMode property on the desired layers to hide. You cannot hide list items using this class or the LayerList class.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Booleanmore details

Whether the actions panel is open in the LayerList.

more detailsListItem
Collection<Collection<(ActionButton|ActionToggle)>>more details

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

more detailsListItem
Collection<ListItem>more details

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

more detailsListItem
Booleanmore details

Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered.

more detailsListItem
Stringmore details

The name of the class.

more detailsAccessor
Errormore details

The Error object returned if an error occurred.

more detailsListItem
Layermore details

The layer associated with the triggered action.

more detailsListItem
LayerViewmore details

The LayerView displaying data for the associated layer.

more detailsListItem
Booleanmore details

Whether the layer is open in the LayerList.

more detailsListItem
ListItemPanelmore details

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

more detailsListItem
ListItemmore details

The parent of this item

more detailsListItem
Booleanmore details

Indicates if the list item (or layer in the map) can be sorted or moved/reordered.

more detailsListItem
Stringmore details

The title of the layer.

more detailsListItem
Booleanmore details

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

more detailsListItem
MapView|SceneViewmore details

The view from which the widget will operate.

more detailsListItem
Stringmore details

Indicates how to manage the visibility of the children layers.

more detailsListItem
Booleanmore details

Indicates if the ListItem is visible.

more detailsListItem
Booleanmore details

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

more detailsListItem

Property Details

actionsOpen Boolean

Whether the actions 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:
children Collection<ListItem>

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

childrenSortable Boolean
Since: ArcGIS API for JavaScript 4.16

Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered.

Default Value:true
Example:
// disables the children of a parent list item from being sorted
listItem.childrenSortable = false;
declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

error Errorreadonly

The Error object returned if an error occurred.

layer Layer

The layer associated with the triggered action.

Default Value:null
layerView LayerViewreadonly

The LayerView displaying data for the associated layer.

open Boolean

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
    };
  }
});
parent ListItem
Since: ArcGIS API for JavaScript 4.5

The parent of this item

Default Value:null
sortable Boolean
Since: ArcGIS API for JavaScript 4.16

Indicates if the list item (or layer in the map) can be sorted or moved/reordered.

Default Value:true
Example:
// disables the list item from being sorted
listItem.sortable = false;
title String

The title of the layer.

updating Booleanreadonly

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.

visibilityMode Stringreadonly

Indicates how to manage the visibility of the children layers.

visible Boolean

Indicates if the ListItem is visible.

Default Value:true
visibleAtCurrentScale Booleanreadonly

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

Default Value:true

Method Overview

Name Return Type Summary Class
ListItemmore details

Creates a deep clone of this object.

more detailsListItem

Method Details

clone(){ListItem}

Creates a deep clone of this object.

Returns:
Type Description
ListItem A clone of the new ListItem instance.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.