Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-layer-list";No specific import is needed for this component.
The Layer List component provides a way to display a list of layers, and switch on/off their visibility.
Demo Properties autoDestroyDisabledProperty
autoDestroyDisabled: boolean
If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.
readonlyProperty
The CatalogLayerList that displays a catalog layer's dynamic group layer.
Property
catalogOptions: LayerListCatalogOptions
CatalogLayer specific properties.
Property
closed: boolean
Indicates whether a component is closed. When true, the component will be hidden.
collapsed: boolean
Indicates whether the widget is collapsed.
Property
dragEnabled: boolean
Indicates whether list items may be reordered within the list by dragging and dropping.
Property
filterPlaceholder: string
Placeholder text used in the filter input if visibleElements.filter is true.
Property
filterPredicate: (((item: ListItem) => void))
Specifies a function to handle filtering list items.
Property
filterText: string
The value of the filter input if visibleElements.filter is true.
Property
headingLevel: number
Indicates the heading level to use for the heading of the widget.
Property
hideCatalogLayerList: boolean
Property
hideFlow: boolean
Property
hideStatusIndicators: boolean
Property
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
Property
knowledgeGraphOptions: LayerListKnowledgeGraphOptions
KnowledgeGraphLayer specific properties.
Property
label: string
The widget's default label.
Property
listItemCreatedFunction: (((event: LayerListListItemCreatedHandlerEvent) => void))
A function that executes each time a ListItem is created.
Property
minDragEnabledItems: number
The minimum number of list items required to enable drag and drop reordering with dragEnabled.
Property
minFilterItems: number
The minimum number of list items required to display the visibleElements.filter input box.
readonlyProperty
A collection of Layers that are opened in a catalogLayerList or tableList flow item.
readonlyProperty
A collection of ListItems representing operational layers.
Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Property
By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
Property
A collection of selected ListItems representing operational layers selected by the user.
Property
selectionMode: "multiple" | "none" | "single" | "single-persist"
Specifies the selection mode.
Property
showCloseButton: boolean
Property
showCollapseButton: boolean
Property
showErrors: boolean
Property
showFilter: boolean
Property
showHeading: boolean
Property
showTemporaryLayerIndicators: boolean
state: "disabled" | "loading" | "ready"
The current state of the component.
readonlyProperty
The TableList that displays the tables associated with a KnowledgeGraphLayer.
Property
visibilityAppearance: "checkbox" | "default"
Determines the icons used to indicate visibility.
No slots to display.
Events arcgisCloseEvent
arcgisClose: CustomEvent<void>
Emitted when the component's close button is clicked.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReadyEvent
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisTriggerActionEvent
arcgisTriggerAction: LayerListTriggerActionEvent
Emitted when an action is triggered on the component.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods Method SignaturecomponentOnReady
componentOnReady(): Promise<void>
destroy
destroy(): Promise<void>
triggerAction
triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): Promise<void>
Method
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
ExampleUse dark colors for code blocks Copy
1
2
3
4
const arcgisLayerList = document.querySelector("arcgis-layer-list");
document.body.append(arcgisLayerList);
await arcgisLayerList.componentOnReady();
console.log("arcgis-layer-list is ready to go!");Method
destroy(): Promise<void>
Permanently destroy the component.
Method
triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): Promise<void>
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