import "@arcgis/map-components/components/arcgis-table-list";The Table List component provides a way to display a list of tables associated with a Map.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
collapsed | boolean | |
drag-enabled | boolean | |
filter-placeholder | string | |
| (((item: TableListListItem) => void)) | |
filter-text | string | |
hide-flow | boolean | |
hide-status-indicators | boolean | |
icon | string | |
label | string | |
| (((event: any) => void)) | |
min-drag-enabled-items | number | |
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 | |
| ||
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-table-indicators | boolean | |
statereadonly | state | "disabled" | "loading" | "ready" |
tableItemsreadonly | |
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
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
filterPlaceholder
filterPlaceholder: stringPlaceholder text used in the filter input if visibleElements.filter is true.
- Attribute
- filter-placeholder
- Default value
- ""
filterPredicate
filterPredicate: (((item: TableListListItem) => void))Specifies a function to handle filtering list items.
- Default value
- null
filterText
filterText: stringThe value of the filter input text string if visibleElements.filter is true.
- Attribute
- filter-text
- Default value
- ""
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
- "table"
listItemCreatedFunction
listItemCreatedFunction: (((event: any) => void))Specifies a function that accesses each ListItem.
minDragEnabledItems
minDragEnabledItems: numberThe minimum number of list items required to enable drag and drop reordering with dragEnabled.
- Attribute
- min-drag-enabled-items
- Default value
- 2
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
selectedItems
selectedItems: Collection<TableListListItem>A collection of selected ListItems representing table list items 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
showTemporaryTableIndicators
showTemporaryTableIndicators: boolean- Attribute
- show-temporary-table-indicators
- Default value
- false
state
state: "disabled" | "loading" | "ready"The view model's state.
- Attribute
- state
- Default value
- "disabled"
tableItems
tableItems: Collection<TableListListItem>The collection of table ListItems displayed within the component.
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 | |
TableListTriggerActionEvent |
arcgisPropertyChange
arcgisPropertyChange: { 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: undefinedEmitted when the component associated with a map 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: TableListTriggerActionEventEmitted 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.