import "@arcgis/map-components/components/arcgis-catalog-layer-list";
The Catalog Layer List component provides a way to display and interact with CatalogLayers.
Demo
Properties
Property | Attribute | Type |
---|---|---|
auto-destroy-disabled | boolean | |
catalogItems readonly |
| |
| ||
closed | boolean | |
collapsed | boolean | |
filter-placeholder | string | |
| (((item: ListItem) => void)) | |
filter-text | string | |
heading-level | number | |
hide-flow | boolean | |
hide-status-indicators | boolean | |
icon | string | |
label | string | |
| (((event: CatalogLayerListListItemCreatedHandlerEvent) => void)) | |
min-filter-items | number | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
| ||
selection-mode | "multiple" | "none" | "single" | "single-persist" | |
show-close-button | boolean | |
show-collapse-button | boolean | |
show-errors | boolean | |
show-filter | boolean | |
show-heading | boolean | |
show-temporary-layer-indicators | boolean | |
state readonly | state | "disabled" | "loading" | "ready" |
visibility-appearance | "checkbox" | "default" |
autoDestroyDisabled
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.
- Attribute
- auto-destroy-disabled
- Default value
- false
catalogItems
catalogItems: Collection<ListItem>
A collection of ListItems representing the catalogLayers dynamicGroupLayer.
catalogLayer
catalogLayer: CatalogLayer
The CatalogLayer to display in the widget.
- Default value
- null
closed
closed: boolean
Indicates whether a component is closed. When true
, the component will be hidden.
- Attribute
- closed
- Default value
- false
collapsed
collapsed: boolean
Indicates whether the widget is collapsed.
- Attribute
- collapsed
- Default value
- false
filterPlaceholder
filterPlaceholder: string
Placeholder text used in the filter input if visibleElements.filter is true.
- Attribute
- filter-placeholder
- Default value
- ""
filterPredicate
filterPredicate: (((item: ListItem) => void))
Specifies a function to handle filtering list items.
- Default value
- null
filterText
filterText: string
The value of the filter input if visibleElements.filter is true.
- Attribute
- filter-text
- Default value
- ""
headingLevel
headingLevel: number
Indicates the heading level to use for the heading of the widget.
- Attribute
- heading-level
- Default value
- 2
hideStatusIndicators
hideStatusIndicators: boolean
- Attribute
- hide-status-indicators
- Default value
- false
icon
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
- Default value
- "catalog-dataset"
listItemCreatedFunction
listItemCreatedFunction: (((event: CatalogLayerListListItemCreatedHandlerEvent) => void))
A function that executes each time a ListItem is created.
- Default value
- null
minFilterItems
minFilterItems: number
The minimum number of list items required to display the visibleElements.filter input box.
- Attribute
- min-filter-items
- Default value
- 10
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
- Attribute
- position
- Default value
- "bottom-left"
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string
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.
- Attribute
- reference-element
selectedItems
selectedItems: Collection<ListItem>
A collection of selected ListItems representing catalogItems selected by the user.
selectionMode
selectionMode: "multiple" | "none" | "single" | "single-persist"
Specifies the selection mode.
- Attribute
- selection-mode
- Default value
- "none"
showCollapseButton
showCollapseButton: boolean
- Attribute
- show-collapse-button
- Default value
- false
showTemporaryLayerIndicators
showTemporaryLayerIndicators: boolean
- Attribute
- show-temporary-layer-indicators
- Default value
- false
state
state: "disabled" | "loading" | "ready"
The current state of the component.
- Attribute
- state
- Default value
- "disabled"
visibilityAppearance
visibilityAppearance: "checkbox" | "default"
Determines the icons used to indicate visibility.
- Attribute
- visibility-appearance
- Default value
- "default"
Slots
Events
Event | Type |
---|---|
CustomEvent<void> | |
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> | |
CatalogLayerListTriggerActionEvent |
arcgisClose
arcgisClose: CustomEvent<void>
Emitted when the component's close button is clicked.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisTriggerAction
arcgisTriggerAction: CatalogLayerListTriggerActionEvent
Emitted when an action is triggered on the component.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
Example
const arcgisCatalogLayerList = document.querySelector("arcgis-catalog-layer-list");
document.body.append(arcgisCatalogLayerList);
await arcgisCatalogLayerList.componentOnReady();
console.log("arcgis-catalog-layer-list is ready to go!");
- Returns
- Promise<void>