ESM: import LayerListItem from "@arcgis/core/widgets/LayerList/ListItem.js";
CDN: const LayerListItem = await $arcgis.import("@arcgis/core/widgets/LayerList/ListItem.js");
Class: @arcgis/core/widgets/LayerList/ListItem
Since: ArcGIS Maps SDK 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.
Show inherited properties Hide inherited properties
Property Details actionsOpen Boolean
Whether the actions panel is open in the LayerList.
A nested 2-dimensional collection of actions that could be triggered on the item.
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 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.
Example
// disables the children of a parent list item from being sorted
listItem.childrenSortable = false;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"
Inherited
Property declaredClass Stringreadonly
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.
The Error object returned if an error occurred.
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.
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 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.
The layer associated with the triggered action.
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.
Whether the layer is open in the LayerList.
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"),
icon: "pie-chart",
open: item.visible
};
}
});Since: ArcGIS Maps SDK for JavaScript 4.5 ListItem since 4.2, parent added at 4.5.
The parent of this item
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.
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.
Example
// disables the list item from being sorted
listItem.sortable = false; uid Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 ListItem since 4.2, uid added at 4.33.
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
updating Booleanreadonly
Value is true when the layer is updating; for example, if it is in the process of fetching data.
The view from which the widget will operate.
visibilityMode Stringreadonly
Indicates how to manage the visibility of the children layers.
Indicates if the ListItem is visible.
visibleAtCurrentScale Booleanreadonly
Whether the layer is visible at the current scale or not.
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.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
Creates a deep clone of this object.
Returns
Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4