import "@arcgis/map-components/components/arcgis-layer-list";
The Layer List component provides a way to display a list of layers, and switch on/off their visibility.
Demo
Properties
Property | Attribute | Type |
---|---|---|
auto-destroy-disabled | boolean | |
catalogLayerList readonly |
| |
| LayerListCatalogOptions | |
collapsed | boolean | |
drag-enabled | boolean | |
filter-placeholder | string | |
| (((item: ListItem) => void)) | |
filter-text | string | |
heading-level | number | |
hide-catalog-layer-list | boolean | |
hide-flow | boolean | |
hide-status-indicators | boolean | |
icon | string | |
| LayerListKnowledgeGraphOptions | |
label | string | |
| (((event: any) => void)) | |
min-drag-enabled-items | number | |
min-filter-items | number | |
openedLayers readonly |
| |
operationalItems readonly |
| |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
| ||
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" |
tableList readonly |
| |
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
catalogLayerList
catalogLayerList: CatalogLayerList
The CatalogLayerList that displays a catalog layer's dynamic group layer.
catalogOptions
catalogOptions: LayerListCatalogOptions
CatalogLayer specific properties.
- Default value
- null
collapsed
collapsed: boolean
Indicates whether the widget is collapsed.
- Attribute
- collapsed
- Default value
- false
dragEnabled
dragEnabled: boolean
Indicates whether list items may be reordered within the list by dragging and dropping.
- Attribute
- drag-enabled
- 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
hideCatalogLayerList
hideCatalogLayerList: boolean
- Attribute
- hide-catalog-layer-list
- Default value
- false
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). Search Calcite Icons for possible values.
- Attribute
- icon
- Default value
- "layers"
knowledgeGraphOptions
knowledgeGraphOptions: LayerListKnowledgeGraphOptions
KnowledgeGraphLayer specific properties.
- Default value
- null
listItemCreatedFunction
listItemCreatedFunction: (((event: any) => void))
A function that executes each time a ListItem is created.
- Default value
- null
minDragEnabledItems
minDragEnabledItems: number
The minimum number of list items required to enable drag and drop reordering with dragEnabled.
- Attribute
- min-drag-enabled-items
- Default value
- 2
minFilterItems
minFilterItems: number
The minimum number of list items required to display the visibleElements.filter input box.
- Attribute
- min-filter-items
- Default value
- 10
openedLayers
openedLayers: Collection<Layer>
A collection of Layers that are opened in a catalogLayerList or tableList flow item.
- Default value
- []
operationalItems
operationalItems: Collection<ListItem>
A collection of ListItems representing operational layers.
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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
selectedItems
selectedItems: Collection<ListItem>
A collection of selected ListItems representing operational layers 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 view model's state.
- Attribute
- state
- Default value
- "disabled"
tableList
tableList: TableList
The TableList that displays the tables associated with a KnowledgeGraphLayer.
visibilityAppearance
visibilityAppearance: "checkbox" | "default"
Determines the icons used to indicate visibility.
- Attribute
- visibility-appearance
- Default value
- "default"
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
triggerAction
triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): Promise<void>
Parameters
Parameter | Type | Optional? |
---|---|---|
action | ||
item |
- Returns
- Promise<void>
Events
Event | Type |
---|---|
{ name: "state"; } | |
undefined | |
LayerListTriggerActionEvent |