@arcgis/map-components/dist/components/arcgis-table-list/customElement.d.ts

ArcGIS Map Components

/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/lumina/controllers';
import { default as TableList } from '@arcgis/core/widgets/TableList.js';
import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { ArcgisReferenceElement } from '../../utils/component-utils';

declare const useTableListWidget: (component: LitElement & Pick<TableList, "icon" | "label" | "viewModel" | "collapsed" | "dragEnabled" | "filterPlaceholder" | "filterPredicate" | "filterText" | "listItemCreatedFunction" | "minDragEnabledItems" | "minFilterItems" | "selectedItems" | "selectionMode"> & {
    state?: unknown;
    viewModel?: __esri.TableListViewModel | undefined;
    closed?: boolean;
    icon: import('@arcgis/components-utils').Nil | string;
    label: import('@arcgis/components-utils').Nil | string;
    referenceElement?: ArcgisReferenceElement | string;
    position: __esri.UIPosition;
    arcgisReady: import('@arcgis/lumina').EventEmitter;
    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
        name: string;
    }> | undefined;
    el: HTMLElement & {
        childElem?: HTMLElement & {
            ownedBy?: HTMLElement;
        };
        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
    };
    autoDestroyDisabled: boolean;
    destroy: () => Promise<void>;
}) => TableList;
/**
 * The Table List component provides a way to display a list of tables associated with a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html).
 *
 * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-table-list/)
 */
export declare class ArcgisTableList extends LitElement {
    /**
     * Emitted when the component's close button is clicked.
     *
     * @since 4.33
     */
    readonly arcgisClose: TargetedEvent<this>;
    /**
     * 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](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-table-list/#destroy) method when you are done to
     * prevent memory leaks.
     *
     * @default false
     */
    autoDestroyDisabled: boolean;
    /**
     * Indicates whether a component is closed. When `true`, the component will be hidden.
     *
     * @since 4.33
     * @default false
     */
    closed: boolean;
    /**
     * Indicates whether the widget is collapsed.
     *
     * @default false
     */
    collapsed: boolean;
    /**
     * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) may be reordered within the list by dragging and dropping.
     *
     * @default false
     */
    dragEnabled: boolean;
    /**
     * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.
     *
     * @default ""
     */
    filterPlaceholder: string;
    /**
     * Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html).
     *
     * @default null
     */
    filterPredicate: nullish | __esri.TableListFilterPredicate;
    /**
     * The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.
     *
     * @default ""
     */
    filterText: string;
    /**
     * Icon which represents the component.
     * Typically used when the component is controlled by another component (e.g. by the Expand component).
     *
     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
     * @default "table"
     */
    icon: string;
    /**
     * The widget's default label.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#label)
     */
    label: string;
    /**
     * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html).
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#listItemCreatedFunction)
     */
    listItemCreatedFunction: nullish | __esri.TableListListItemCreatedHandler;
    /**
     * The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#dragEnabled).
     *
     * @default 2
     */
    minDragEnabledItems: number;
    /**
     * The minimum number of list items required to display the visibleElements.filter input box.
     *
     * @default 10
     */
    minFilterItems: number;
    /** @default "bottom-left" */
    position: __esri.UIPosition;
    /**
     * 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 [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
     */
    referenceElement?: ArcgisReferenceElement | string;
    /**
     * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html)s representing table list items
     * selected by the user.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectedItems)
     */
    selectedItems: __esri.Collection<__esri.TableListListItem>;
    /**
     * Specifies the selection mode.
     *
     * @default "none"
     */
    selectionMode: "single" | "multiple" | "none" | "single-persist";
    /**
     * The current state of the component.
     *
     * @default "disabled"
     */
    readonly state: "ready" | "loading" | "disabled";
    /** The collection of table ListItems displayed within the component. */
    get tableItems(): __esri.Collection<__esri.TableListListItem>;
    /** @default false */
    showCloseButton: boolean;
    /** @default false */
    showCollapseButton: boolean;
    /** @default false */
    showErrors: boolean;
    /** @default false */
    showFilter: boolean;
    /** @default false */
    hideFlow: boolean;
    /** @default false */
    showHeading: boolean;
    /** @default false */
    hideStatusIndicators: boolean;
    /** @default false */
    showTemporaryTableIndicators: boolean;
    /** Permanently destroy the component. */
    destroy(): Promise<void>;
    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
    readonly arcgisPropertyChange: TargetedEvent<this, {
        name: "state";
    }>;
    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
    readonly arcgisReady: TargetedEvent<this, void>;
    /** Emitted when an action is triggered on the component. */
    readonly arcgisTriggerAction: TargetedEvent<this, __esri.TableListTriggerActionEvent>;
}
export {};