Layer List

Use dark colors for code blocksCopy
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
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`catalogLayerList` readonly		`CatalogLayerList`
`catalogOptions`		`LayerListCatalogOptions`
`collapsed`	`collapsed`	`boolean`
`dragEnabled`	`drag-enabled`	`boolean`
`filterPlaceholder`	`filter-placeholder`	`string`
`filterPredicate`		`(((item: ListItem) => void))`
`filterText`	`filter-text`	`string`
`headingLevel`	`heading-level`	`number`
`hideCatalogLayerList`	`hide-catalog-layer-list`	`boolean`
`hideFlow`	`hide-flow`	`boolean`
`hideStatusIndicators`	`hide-status-indicators`	`boolean`
`icon`	`icon`	`string`
`knowledgeGraphOptions`		`LayerListKnowledgeGraphOptions`
`label`	`label`	`string`
`listItemCreatedFunction`		`(((event: any) => void))`
`minDragEnabledItems`	`min-drag-enabled-items`	`number`
`minFilterItems`	`min-filter-items`	`number`
`openedLayers` readonly		`Collection<Layer>`
`operationalItems` readonly		`Collection<ListItem>`
`position`	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`ArcgisLinkChart \| ArcgisMap \| ArcgisScene \| string`
`selectedItems`		`Collection<ListItem>`
`selectionMode`	`selection-mode`	`"multiple" \| "none" \| "single" \| "single-persist"`
`showCloseButton`	`show-close-button`	`boolean`
`showCollapseButton`	`show-collapse-button`	`boolean`
`showErrors`	`show-errors`	`boolean`
`showFilter`	`show-filter`	`boolean`
`showHeading`	`show-heading`	`boolean`
`showTemporaryLayerIndicators`	`show-temporary-layer-indicators`	`boolean`
`state` readonly	`state`	`"disabled" \| "loading" \| "ready"`
`tableList` readonly		`TableList`
`visibilityAppearance`	`visibility-appearance`	`"checkbox" \| "default"`

autoDestroyDisabled

Property

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

readonlyProperty

catalogLayerList: CatalogLayerList

The CatalogLayerList that displays a catalog layer's dynamic group layer.

catalogOptions

Property

catalogOptions: LayerListCatalogOptions

CatalogLayer specific properties.

Method	Signature
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`destroy(): Promise<void>`
`triggerAction`	`triggerAction(action: __esri.ActionButton \| __esri.ActionToggle, item: __esri.ListItem): Promise<void>`

Parameter	Type	Optional?
action	`ActionButton \| ActionToggle`
item	`ListItem`

Event	Type
`arcgisPropertyChange`	`{ name: "state"; }`
`arcgisReady`	`undefined`
`arcgisTriggerAction`	`LayerListTriggerActionEvent`

Layer List

Demo

Properties

Methods

Parameters

Events