ListItem

Property Overview

Property Details

actionsOpen Boolean

Whether the actions panel is open in the LayerList.

Default Value:false

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 Collection<ListItem>

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

childrenSortable Boolean

Since: ArcGIS Maps SDK 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;

connectionStatus Stringreadonly

Since: ArcGIS Maps SDK for JavaScript 4.24

Only valid when the list item represents a StreamLayer. Indicates the status of the stream layer connection. This overrides the updating property. When a stream layer is connected, a green circle will appear next to the list item title. When it is disconnected a hollow red ring will display next to the list item title.

Possible Values:"connected"|"disconnected"

declaredClass Stringreadonly inherited

Since: ArcGIS Maps SDK 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.

hidden Boolean

Since: ArcGIS Maps SDK for JavaScript 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;
    }
  }
});

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

panel ListItemPanel

Since: ArcGIS Maps SDK 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 Maps SDK for JavaScript 4.5

The parent of this item

Default Value:null

publishing Booleanreadonly

Since: ArcGIS Maps SDK 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

sortable Boolean

Since: ArcGIS Maps SDK 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

view MapView|SceneView

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

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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(){ListItem}

Creates a deep clone of this object.

Returns

Type	Description
ListItem	A clone of the new ListItem instance.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 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(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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");