ListItem | API Reference | ArcGIS Maps SDK for JavaScript 4.32

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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Boolean	Whether the actions panel is open in the LayerList.	ListItem
Collection<Collection<(ActionButton\|ActionToggle)>>	A nested 2-dimensional collection of actions that could be triggered on the item.	ListItem
Collection<ListItem>	When a layer contains sublayers, this property is a Collection of ListItem objects belonging to the given layer.	ListItem
Boolean	Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered.	ListItem
String\|null\|undefined	Only valid when the list item represents a StreamLayer.	ListItem
String	The name of the class.	Accessor
Error\|null\|undefined	The Error object returned if an error occurred.	ListItem
Boolean	When `true`, hides the layer from the LayerList instance.	ListItem
Boolean	Whether the layer is unsupported by the view.	ListItem
Layer\|Sublayer\|SubtypeSublayer\|SubtypeGroupLayer\|null\|undefined	The layer associated with the triggered action.	ListItem
LayerView\|null\|undefined	The LayerView displaying data for the associated layer.	ListItem
Boolean	Specifies whether to ignore the listMode property of the child layers in the list item.	ListItem
Boolean	Whether the layer is open in the LayerList.	ListItem
ListItemPanel	Allows you to display custom content for each ListItem in the LayerList widget.	ListItem
ListItem\|null\|undefined	The parent of this item	ListItem
Boolean	Value is `true` when the layer is being published.	ListItem
Boolean	Indicates if the list item (or layer in the map) can be sorted or moved/reordered.	ListItem
String	The title of the layer.	ListItem
Boolean	Value is `true` when the layer is updating; for example, if it is in the process of fetching data.	ListItem
MapView\|SceneView\|null\|undefined	The view from which the widget will operate.	ListItem
String	Indicates how to manage the visibility of the children layers.	ListItem
Boolean	Indicates if the ListItem is visible.	ListItem
Boolean	Whether the layer is visible at the current scale or not.	ListItem
Boolean	Whether the layer is visible at the current time extent or not.	ListItem

Property Details

actionsOpen Property actionsOpen Boolean

Whether the actions panel is open in the LayerList.

Default Value:false

actionsSections Property actionsSections Collection<Collection<(ActionButton|ActionToggle)>>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

children Property children Collection<ListItem>autocast

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

childrenSortable Property childrenSortable Boolean Since: ArcGIS Maps SDK for JavaScript 4.16 ListItem since 4.2, childrenSortable added at 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;

connectionStatus Property connectionStatus String |null |undefinedreadonly Since: ArcGIS Maps SDK for JavaScript 4.24 ListItem since 4.2, connectionStatus added at 4.24.

Only valid when the list item represents a StreamLayer. Indicates the connectionStatus of the stream layer connection. This overrides the updating property.

Starting at version 4.27, a green beacon icon will appear next to the list item title when a stream layer is connected. Prior to version 4.27, when a stream layer is connected a green calcite check-circle icon will appear next to the list item title.

When a stream layer is disconnected an orange calcite offline icon will display next to the list item title.

Starting at version 4.26, the connectionStatus can be paused. This also results in displaying an orange offline icon next to the list item title.

Possible Values:"connected" |"disconnected" |"paused"

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

error Property error Error |null |undefinedreadonly

The Error object returned if an error occurred.

hidden Property hidden Boolean Since: ArcGIS Maps SDK for JavaScript 4.24 ListItem since 4.2, hidden added at 4.24.

When true, hides the layer from the LayerList instance. This is an alternative to Layer.listMode, which hides a layer from all instances of LayerList that include the layer.

Default Value:false

Example

let layerList1 = new LayerList({
  view,
  container: layerList1Container,
  listItemCreatedFunction: (event) => {
    // hides the USA - Highway layer from the
    // layerList1 instance of layerlist
    if(event.item.title === "USA - Highways") {
      event.item.hidden = true;
    }
  }
});

incompatible Property incompatible Booleanreadonly Since: ArcGIS Maps SDK for JavaScript 4.32 ListItem since 4.2, incompatible added at 4.32.

Whether the layer is unsupported by the view.

Default Value:false

The layer associated with the triggered action.

Default Value:null

layerView Property layerView LayerView |null |undefinedreadonly

The LayerView displaying data for the associated layer.

listModeDisabled Property listModeDisabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.30 ListItem since 4.2, listModeDisabled added at 4.30.

Specifies whether to ignore the listMode property of the child layers in the list item. A common use case for listModeDisabled is when you want to use the LayerList or BasemapLayerList to manage and configure a layer's listMode value.

Default Value:false

See also

Layer.listMode

open Property open Boolean

Whether the layer is open in the LayerList.

Default Value:false

panel Property panel ListItemPanelautocast Since: ArcGIS Maps SDK for JavaScript 4.7 ListItem since 4.2, panel added at 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 Property parent ListItem |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.5 ListItem since 4.2, parent added at 4.5.

The parent of this item

Default Value:null

publishing Property publishing Booleanreadonly Since: ArcGIS Maps SDK for JavaScript 4.25 ListItem since 4.2, publishing added at 4.25.

Value is true when the layer is being published. Value will be false if the layer is not being published or checkPublishStatusEnabled is false.

Default Value:false

sortable Property sortable Boolean Since: ArcGIS Maps SDK for JavaScript 4.16 ListItem since 4.2, sortable added at 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 Property title String

The title of the layer.

updating Property updating Booleanreadonly

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

Default Value:false

view Property view MapView |SceneView |null |undefined

The view from which the widget will operate.

visibilityMode Property visibilityMode Stringreadonly

Indicates how to manage the visibility of the children layers.

visible Property visible Boolean

Indicates if the ListItem is visible.

Default Value:true

visibleAtCurrentScale Property visibleAtCurrentScale Booleanreadonly

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

Default Value:true

visibleAtCurrentTimeExtent Property visibleAtCurrentTimeExtent Booleanreadonly Since: ArcGIS Maps SDK for JavaScript 4.30 ListItem since 4.2, visibleAtCurrentTimeExtent added at 4.30.

Whether the layer is visible at the current time extent or not.

Default Value:true

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
ListItem	Creates a deep clone of this object.	ListItem
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone Method clone(){ListItem}

Creates a deep clone of this object.

Returns

Type	Description
ListItem	A clone of the new ListItem instance.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");