@arcgis/map-components
Version:
ArcGIS Map Components
217 lines (215 loc) • 9.38 kB
TypeScript
/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/lumina/controllers';
import { default as LayerList } from '@arcgis/core/widgets/LayerList.js';
import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { ArcgisReferenceElement } from '../../utils/component-utils';
declare const useLayerListWidget: (component: LitElement & Pick<LayerList, "icon" | "label" | "viewModel" | "headingLevel" | "collapsed" | "dragEnabled" | "filterPlaceholder" | "filterPredicate" | "filterText" | "listItemCreatedFunction" | "minDragEnabledItems" | "minFilterItems" | "selectedItems" | "selectionMode" | "catalogOptions" | "knowledgeGraphOptions" | "visibilityAppearance"> & {
state?: unknown;
viewModel?: __esri.LayerListViewModel | 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>;
}) => LayerList;
/**
* The Layer List component provides a way to display a list of layers, and switch on/off their visibility.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-layer-list/)
*/
export declare class ArcgisLayerList 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-layer-list/#destroy) method when you are done to
* prevent memory leaks.
*
* @default false
*/
autoDestroyDisabled: boolean;
/** The CatalogLayerList that displays a catalog layer's dynamic group layer. */
get catalogLayerList(): __esri.CatalogLayerList | nullish;
/**
* [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) specific properties.
*
* @default null
*/
catalogOptions: nullish | __esri.LayerListCatalogOptions;
/**
* 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-LayerList-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-LayerList.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-LayerList-ListItem.html).
*
* @default null
*/
filterPredicate: nullish | __esri.LayerListFilterPredicate;
/**
* The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true.
*
* @default ""
*/
filterText: string;
/**
* Indicates the heading level to use for the heading of the widget.
*
* @default 2
*/
headingLevel: number;
/** @default false */
hideCatalogLayerList: boolean;
/** @default false */
hideFlow: boolean;
/** @default false */
hideStatusIndicators: boolean;
/**
* 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 "layers"
*/
icon: string;
/**
* [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html) specific properties.
*
* @default null
*/
knowledgeGraphOptions: nullish | __esri.LayerListKnowledgeGraphOptions;
/**
* The widget's default label.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#label)
*/
label: string;
/**
* A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) is created.
*
* @default null
*/
listItemCreatedFunction: nullish | __esri.LayerListListItemCreatedHandler;
/**
* 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-LayerList.html#dragEnabled).
*
* @default 2
*/
minDragEnabledItems: number;
/**
* The minimum number of list items required to display the visibleElements.filter input box.
*
* @default 10
*/
minFilterItems: number;
/**
* A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that are opened
* in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList) or [tableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#tableList) flow item.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#openedLayers)
*
* @default []
*/
readonly openedLayers: __esri.Collection<__esri.Layer>;
/** A collection of ListItems representing operational layers. */
get operationalItems(): __esri.Collection<__esri.ListItem>;
/** @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-LayerList-ListItem.html)s representing operational layers
* selected by the user.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectedItems)
*/
selectedItems: __esri.Collection<__esri.ListItem>;
/**
* Specifies the selection mode.
*
* @default "none"
*/
selectionMode: "single" | "multiple" | "none" | "single-persist";
/** @default false */
showCloseButton: boolean;
/** @default false */
showCollapseButton: boolean;
/** @default false */
showErrors: boolean;
/** @default false */
showFilter: boolean;
/** @default false */
showHeading: boolean;
/** @default false */
showTemporaryLayerIndicators: boolean;
/**
* The current state of the component.
*
* @default "disabled"
*/
readonly state: "ready" | "loading" | "disabled";
/** The TableList that displays the tables associated with a KnowledgeGraphLayer. */
get tableList(): __esri.TableList | nullish;
/**
* Determines the icons used to indicate visibility.
*
* @default "default"
*/
visibilityAppearance: "default" | "checkbox";
/** Permanently destroy the component. */
destroy(): Promise<void>;
triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): 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.LayerListTriggerActionEvent>;
}
export {};