Catalog Layer List

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

A collection of ListItems representing the catalogLayers dynamicGroupLayer.

The CatalogLayer to display in the widget.

Default value

null

Indicates whether a component is closed. When true, the component will be hidden.

Attribute

closed

Default value

false

Indicates whether the widget is collapsed.

Attribute

collapsed

Default value

false

Placeholder text used in the filter input if visibleElements.filter is true.

Attribute

filter-placeholder

Default value

""

Specifies a function to handle filtering list items.

Default value

null

The value of the filter input if visibleElements.filter is true.

Attribute

filter-text

Default value

""

Indicates the heading level to use for the heading of the widget.

Attribute

heading-level

Default value

2

Attribute

hide-flow

Default value

false

Attribute

hide-status-indicators

Default value

false

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

Attribute

icon

Default value

"catalog-dataset"

The widget's default label.

Read more...

Attribute

label

A function that executes each time a ListItem is created.

Default value

null

The minimum number of list items required to display the visibleElements.filter input box.

Attribute

min-filter-items

Default value

10

Attribute

position

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.

See also

• Associate components with a Map or Scene component

Attribute

reference-element

A collection of selected ListItems representing catalogItems selected by the user.

Read more...

Specifies the selection mode.

Attribute

selection-mode

Default value

"none"

Attribute

show-close-button

Default value

false

Attribute

show-collapse-button

Default value

false

Attribute

show-errors

Default value

false

Attribute

show-filter

Default value

false

Attribute

show-heading

Default value

false

Attribute

show-temporary-layer-indicators

Default value

false

The current state of the component.

Attribute

state

Default value

"disabled"

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Catalog Layer List component will be associated with a map or scene component rather than using the view property.

Default value

null

Determines the icons used to indicate visibility.

Attribute

visibility-appearance

Default value

"default"

Create a promise that resolves once component is fully loaded.

Example

1
2
3
4
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>

Permanently destroy the component.

Returns

Promise<void>

Emitted when the component's close button is clicked.

Emitted when the value of a property is changed. Use this to listen to changes to properties.

Emitted when the component associated with a map or scene view is ready to be interacted with.

Emitted when an action is triggered on the component.