ListItem

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

In the TableList widget UI, the ListItem represents a layer's table added to the widget. It provides access to the associated properties and allows the developer to configure actions related to the table, and allows the developer to add content to the item related to the table.

See also

Property Overview

Name Type Summary Class
Boolean

Indicates whether the actions panel is open in the TableList.

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

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

more details
ListItem
Error

The Error object returned if an error occurred.

more details
ListItem
Boolean

When true, hides the layer from the TableList instance.

more details
ListItem
Layer

The layer associated with the triggered action.

more details
ListItem
Boolean

Value is true when the layer is being published.

more details
ListItem
String

The title of the table.

more details
ListItem

Property Details

actionsOpen Boolean

Indicates whether the actions panel is open in the TableList.

Default Value:false
Autocasts from Object[][]

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

error Errorreadonly

The Error object returned if an error occurred.

hidden Boolean
Since: ArcGIS API for JavaScript 4.24

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

Default Value:false
Example
listItem.hidden = true;
layer Layer

The layer associated with the triggered action. This must be a FeatureLayer whose isTable property returns true. For more information regarding working with tables, please refer to Map.tables.

Default Value:null
See also
publishing Booleanreadonly
Since: ArcGIS API for JavaScript 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
title String

The title of the table.

Method Overview

Name Return Type Summary Class
ListItem

Creates a deep clone of this object.

more details
ListItem

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.