import "@arcgis/map-components/components/arcgis-basemap-layer-list";BasemapLayerList component provides a way to display a list of Basemap layers and switch on/off their visibility. Base layers and reference layers are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
| (((item: ListItem) => void)) | |
base-filter-text | string | |
baseItemsreadonly | | |
| (((event: any) => void)) | |
basemap-title | string | |
catalogLayerListreadonly | | |
| BasemapLayerListCatalogOptions | |
collapsed | boolean | |
drag-enabled | boolean | |
editing-title | boolean | |
filter-placeholder | string | |
heading-level | number | |
hide-base-layers | boolean | |
hide-flow | boolean | |
hide-heading | boolean | |
hide-reference-layers | boolean | |
hide-status-indicators | boolean | |
icon | string | |
label | string | |
min-filter-items | number | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
| (((item: ListItem) => void)) | |
reference-filter-text | string | |
referenceItemsreadonly | | |
| (((event: any) => void)) | |
| ||
selection-mode | "multiple" | "none" | "single" | "single-persist" | |
show-close-button | boolean | |
show-collapse-button | boolean | |
show-edit-title-button | boolean | |
show-errors | boolean | |
show-filter | boolean | |
show-temporary-layer-indicators | boolean | |
statereadonly | state | "disabled" | "loading" | "ready" |
visibility-appearance | "checkbox" | "default" |
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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
baseFilterPredicate
baseFilterPredicate: (((item: ListItem) => void))Specifies a function to handle filtering base layer list items.
- Default value
- null
baseFilterText
baseFilterText: stringThe value of the filter input text string if visibleElements.filter is true.
- Attribute
- base-filter-text
- Default value
- ""
baseItems
baseItems: Collection<ListItem>A collection of ListItems representing the baseLayers.
baseListItemCreatedFunction
baseListItemCreatedFunction: (((event: any) => void))Specifies a function that accesses each ListItem representing a base layer.
catalogLayerList
catalogLayerList: CatalogLayerListThe CatalogLayerList that displays a catalog layer's dynamic group layer.
catalogOptions
catalogOptions: BasemapLayerListCatalogOptionsCatalogLayer specific properties.
- Default value
- null
collapsed
collapsed: booleanIndicates whether the widget is collapsed.
- Attribute
- collapsed
- Default value
- false
dragEnabled
dragEnabled: booleanIndicates whether list items may be reordered within the list by dragging and dropping.
- Attribute
- drag-enabled
- Default value
- false
editingTitle
editingTitle: booleanIndicates whether the form to edit the basemap's title is currently visible.
- Attribute
- editing-title
- Default value
- false
filterPlaceholder
filterPlaceholder: stringPlaceholder text used in the filter input if visibleElements.filter is true.
- Attribute
- filter-placeholder
- Default value
- ""
headingLevel
headingLevel: numberIndicates the heading level to use for the widget title (i.e.
- Attribute
- heading-level
- Default value
- 2
hideReferenceLayers
hideReferenceLayers: boolean- Attribute
- hide-reference-layers
- Default value
- false
hideStatusIndicators
hideStatusIndicators: boolean- Attribute
- hide-status-indicators
- Default value
- false
icon
icon: stringIcon 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"
minFilterItems
minFilterItems: numberThe 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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string- Attribute
- reference-element
referenceFilterPredicate
referenceFilterPredicate: (((item: ListItem) => void))Specifies a function to handle filtering reference layer list items.
- Default value
- null
referenceFilterText
referenceFilterText: stringThe value of the filter input text string if visibleElements.filter is true.
- Attribute
- reference-filter-text
- Default value
- ""
referenceItems
referenceItems: Collection<ListItem>A collection of ListItems representing the referenceLayers.
referenceListItemCreatedFunction
referenceListItemCreatedFunction: (((event: any) => void))Specifies a function that accesses each ListItem representing a reference layer.
selectedItems
selectedItems: Collection<ListItem>A collection of selected ListItems representing basemap 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
showEditTitleButton
showEditTitleButton: boolean- Attribute
- show-edit-title-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"
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> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
| Event | Type |
|---|---|
{ name: "state"; } | |
undefined | |
BasemapLayerListTriggerActionEvent |
arcgisPropertyChange
arcgisPropertyChange: { name: "state"; }Fired 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: undefinedEvents 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: BasemapLayerListTriggerActionEventEvents 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.