@arcgis/map-components
Version:
ArcGIS Map Components
88 lines (86 loc) • 3.93 kB
TypeScript
/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/components-controllers';
import { Nil } from '@arcgis/components-utils';
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: import('@arcgis/components-controllers').StencilLifecycles & {
manager: import('@arcgis/components-controllers').ControllerManager;
el: HTMLElement;
autoDestroyDisabled?: boolean;
destroy?: () => Promise<void>;
} & Pick<TableList, never> & {
reactiveUtils?: typeof __esri.reactiveUtils;
state?: unknown;
viewModel?: __esri.TableListViewModel | undefined;
icon: Nil | string;
label: Nil | string;
referenceElement: ArcgisReferenceElement | Nil | string;
position: __esri.UIPosition;
arcgisReady: import('@arcgis/components-controllers').EventEmitter;
arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
name: string;
}> | undefined;
el: HTMLElement & {
childElem?: HTMLElement & {
ownedBy?: HTMLElement;
};
view?: __esri.MapView | __esri.SceneView | Nil;
};
autoDestroyDisabled: boolean;
destroy: () => Promise<void>;
}, options?: {
editConstructorProperties(props: __esri.TableListProperties | undefined): __esri.TableListProperties | Promise<__esri.TableListProperties | undefined> | undefined;
} | undefined) => 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).
*/
export declare class ArcgisTableList extends LitElement {
/**
* 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.
*/
autoDestroyDisabled: boolean;
collapsed: boolean;
dragEnabled: boolean;
filterPlaceholder: string;
filterPredicate: nullish | __esri.TableListFilterPredicate;
filterText: string;
/**
* Icon which represents the component.
* Typically used when the component is controlled by another component (e.g. by the Expand component).
* Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
*/
icon: string;
/** The component's default label. */
label: string;
listItemCreatedFunction: nullish | __esri.TableListListItemCreatedHandler;
minDragEnabledItems: number;
minFilterItems: number;
position: __esri.UIPosition;
referenceElement: ArcgisReferenceElement | Nil | string;
selectedItems: __esri.Collection<__esri.TableListListItem>;
selectionMode: "none" | "single" | "multiple" | "single-persist";
readonly state: "ready" | "loading" | "disabled";
/** The collection of table ListItems displayed within the component. */
get tableItems(): __esri.Collection<__esri.TableListListItem>;
showCloseButton: boolean;
showCollapseButton: boolean;
showErrors: boolean;
showFilter: boolean;
hideFlow: boolean;
showHeading: boolean;
hideStatusIndicators: boolean;
showTemporaryTableIndicators: boolean;
/** Permanently destroy the component */
destroy(): Promise<void>;
readonly arcgisPropertyChange: TargetedEvent<this, {
name: "state";
}>;
readonly arcgisReady: TargetedEvent<this, undefined>;
readonly arcgisTriggerAction: TargetedEvent<this, __esri.TableListTriggerActionEvent>;
}
export {};