require(["esri/widgets/LayerList/ListItemPanel"], (LayerListItemPanel) => { /* code goes here */ });
import LayerListItemPanel from "@arcgis/core/widgets/LayerList/ListItemPanel.js";
esri/widgets/LayerList/ListItemPanel
This class allows you to display custom content for each ListItem in the LayerList widget. ListItemPanel objects typically aren't constructed. Rather, they are modified using the listItemCreatedFunction property in the LayerList widget.
A common scenario for using ListItemPanel is to display a Legend widget within each list item. This allows users to create a legend for each layer in the map simply by adding the string "legend" as the content.
- See also
const layerList = new LayerList({
view: view,
listItemCreatedFunction: function(event){
const { item } = event;
// displays the legend for each layer list item
item.panel = {
content: "legend"
};
}
});
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Adds a CSS class used to style a node that represents the panel. | ListItemPanel | ||
The ID or node representing the DOM element containing the widget. | Widget | ||
The content displayed in the ListItem panel. | ListItemPanel | ||
The name of the class. | Accessor | ||
If | ListItemPanel | ||
Indicates whether the panel's content should be rendered as a Calcite Flow Item. | ListItemPanel | ||
Icon which represents the panel. | ListItemPanel | ||
The unique ID assigned to the widget when the widget is created. | Widget | ||
The URL or data URI of an image used to represent the panel. | ListItemPanel | ||
The widget's label. | Widget | ||
The panel's parent ListItem that represents a layer in the map. | ListItemPanel | ||
Indicates if the panel's content is open and visible to the user. | ListItemPanel | ||
The title of the panel. | ListItemPanel | ||
Indicates if the node containing the image or className is visible to the user. | ListItemPanel |
Property Details
-
container
InheritedPropertycontainer String |HTMLElement
Inherited from Widget -
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
Examples// Create the HTML div element programmatically at runtime and set to the widget's container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
// Specify an already-defined HTML div element in the widget's container const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" }); // HTML markup <body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div> </body>
// Specify the widget while adding to the view's UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
-
content
content LayerListItemPanelContent |LayerListItemPanelContent[]
-
The content displayed in the ListItem panel. This can be a String, a Widget instance, an HTMLElement, or an Array of any of those elements.
If the string
legend
is used, then an instance of the Legend widget is placed in the content.Exampleconst layerList = new LayerList({ view: view, listItemCreatedFunction: function(event){ const { item } = event; // displays the legend for each layer list item item.panel = { content: "legend" }; } });
-
disabled
disabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.25ListItemPanel since 4.7, disabled added at 4.25. -
If
true
, disables the ListItem's panel so the user cannot open or interact with it. The panel will be disabled by default if it does not have content or if it contains a legend with no active content in it.Exampleconst layerList = new LayerList({ view: view, listItemCreatedFunction: function(event){ const item = event.item; if (!item.layer.visible){ item.panel.disabled = true; } } });
-
flowEnabled
flowEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.29ListItemPanel since 4.7, flowEnabled added at 4.29. -
Indicates whether the panel's content should be rendered as a Calcite Flow Item. By default, the panel's content is rendered in the content-bottom slot. Flow is a calcite component that allows for drilling in and out of panels.
- Default Value:false
-
icon
icon String
Since: ArcGIS Maps SDK for JavaScript 4.27ListItemPanel since 4.7, icon added at 4.27. -
Icon which represents the panel.
- Default Value:null
- See also
-
image
image String
-
The URL or data URI of an image used to represent the panel. This property will be used as a background image for the node. If neither
image
norclassName
, noricon
are specified, a default icon will display.
-
listItem
listItem ListItem
-
The panel's parent ListItem that represents a layer in the map.
-
open
open Boolean
-
Indicates if the panel's content is open and visible to the user. This is different from the visible property, which is used for toggling the visibility of the icon used to control whether the content is expanded or collapsed.
- Default Value:false
Exampleconst layerList = new LayerList({ view: view, listItemCreatedFunction: function(event){ const item = event.item; // displays the legend for each layer list item // The legend is open by default, but the user // is prevented from collapsing that content item.panel = { content: "legend", open: true, visible: false }; } });
-
title
title String
-
The title of the panel. By default, this title matches the ListItem's title. Changing this value will not change the title of the ListItem in the LayerList.
-
visible
visible Boolean
-
Indicates if the node containing the image or className is visible to the user. Setting this value to
false
will prevent the user from toggling the visibility of the panel's content. Use open to programmatically set the visibility of the panel's content.- Default Value:true
Exampleconst layerList = new LayerList({ view: view, listItemCreatedFunction: function(event){ const item = event.item; // displays the legend for each layer list item // The legend is open by default, but the user // is prevented from collapsing that content item.panel = { content: "legend", open: true, visible: false }; } });
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
A utility method used for building the value for a widget's | Widget | ||
Destroys the widget instance. | Widget | ||
Emits an event on the instance. | Widget | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | Widget | ||
Returns true if a named group of handles exist. | Accessor | ||
| Widget | ||
| Widget | ||
| Widget | ||
Registers an event handler on the instance. | Widget | ||
Adds one or more handles which are to be tied to the lifecycle of the widget. | Widget | ||
Executes after widget is ready for rendering. | Widget | ||
Removes a group of handles owned by the object. | Accessor | ||
This method is implemented by subclasses for rendering. | Widget | ||
Renders widget to the DOM immediately. | Widget | ||
Schedules widget rendering. | Widget | ||
| Widget |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]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.
-
classes
InheritedMethodclasses(classNames){String}
Inherited from Widget -
A utility method used for building the value for a widget's
class
property. This aids in simplifying css class setup.ReturnsType Description String The computed class name. Example// .tsx syntax showing how to set css classes while rendering the widget render() { const dynamicClasses = { [css.flip]: this.flip, [css.primary]: this.primary }; return ( <div class={classes(css.root, css.mixin, dynamicClasses)} /> ); }
-
Inherited from Widget
-
Destroys the widget instance.
-
hasEventListener
InheritedMethodhasEventListener(type){Boolean}
Inherited from Widget -
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
isFulfilled
InheritedMethodisFulfilled(){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, isFulfilled added at 4.19. -
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected
InheritedMethodisRejected(){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, isRejected added at 4.19. -
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved
InheritedMethodisResolved(){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, isResolved added at 4.19. -
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
on
InheritedMethodon(type, listener){Object}
Inherited from Widget -
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType Description Object Returns an event handler with a remove()
method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
Inherited from Widget
Since: ArcGIS Maps SDK for JavaScript 4.24Widget since 4.2, own added at 4.24. Deprecated since 4.28 Use addHandles() instead. -
Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.
const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true} ); this.own(handle); // Handle gets removed when the widget is destroyed.
ParameterhandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
Inherited from Widget
-
Executes after widget is ready for rendering.
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from Widget
-
Renders widget to the DOM immediately.
-
Inherited from Widget
-
Schedules widget rendering. This method is useful for changes affecting the UI.
-
when
InheritedMethodwhen(callback, errback){Promise}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, when added at 4.19. -
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.ParametersReturnsType Description Promise Returns a new Promise for the result of callback
.Example// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way let bmGallery = new BasemapGallery(); bmGallery.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });
Type Definitions
-
LayerListItemPanelContent
LayerListItemPanelContent Widget |HTMLElement |String
-
The content displayed in the ListItem panel. This can be a String, a Widget instance, or an HTMLElement.
If the string
legend
is used, then an instance of the Legend widget is placed in the content.