@arcgis/map-components 5.2.0-next.11 → 5.2.0-next.110

package/dist/components/arcgis-selection-list/customElement.d.ts

@@ -0,0 +1,421 @@
+/// <reference path="../../index.d.ts" />
+import type SelectionManager from "@arcgis/core/views/SelectionManager.js";
+import type FeatureItem from "@arcgis/core/widgets/support/SelectionList/FeatureItem.js";
+import type LayerItem from "@arcgis/core/widgets/support/SelectionList/LayerItem.js";
+import type { SelectableLayer, SelectionIdentifier, SelectableViewUnion } from "@arcgis/core/views/selection/types.js";
+import type { ListItem, ParentItem } from "@arcgis/core/widgets/support/SelectionList/types.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { Action } from "@esri/calcite-components/components/calcite-action";
+import type { ListItemActionConfiguration, ListItemUnavailableFunction, ListItemSelectCallback } from "./types.js";
+import type { ArcgisReferenceElement, IconName } from "../types.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+
+/**
+ * The selection list component can be used to display a list of selected features from a selection manager.
+ *
+ * @since 5.2
+ */
+export abstract class ArcgisSelectionList extends LitElement {
+  /**
+   * Reference to a single LayerItem being displayed in the list, if the
+   * 'layer' property is set and that layer has selected features.
+   *
+   * @since 5.2
+   */
+  get activeLayerItem(): LayerItem | null | undefined;
+  /**
+   * A callback function to be called when a list item is selected.
+   *
+   * @since 5.2
+   */
+  accessor afterListItemSelect: ListItemSelectCallback | undefined;
+  /**
+   * Items representing all individual layers and group layers with an active selection.
+   *
+   * @since 5.2
+   */
+  get allLayerItems(): ParentItem[];
+  /**
+   * 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/components/arcgis-selection-list/#destroy) method when you are done to
+   * prevent memory leaks.
+   *
+   * @default false
+   * @example
+   * ```html
+   * <arcgis-selection-list auto-destroy-disabled></arcgis-selection-list>
+   * ```
+   *
+   * ```js
+   * selectionListElement.autoDestroyDisabled = true;
+   * ```
+   * 
+   */
+  accessor autoDestroyDisabled: boolean;
+  /**
+   * Total number of selected features.
+   *
+   * @since 5.2
+   */
+  get count(): number;
+  /**
+   * When true, the component is visually withdrawn and cannot receive user interaction.
+   *
+   * @default false
+   */
+  accessor disabled: boolean;
+  /**
+   * Controls how the list is displayed. If this value is set to "group", the list displays feature and layer items nested under
+   * their associated layer and group items. If this value is set to "layer", the list displays feature items nested under
+   * their associated layer item, while excluding group items. If this value is set to "feature" the list only displays
+   * feature items, while excluding group and layer items.
+   *
+   * @default "group"
+   * @since 5.2
+   */
+  accessor displayMode: "feature" | "group" | "layer";
+  /**
+   * Reference to the SelectionManager being represented by the component.
+   *
+   * @since 5.2
+   */
+  get effectiveSelectionManager(): null | undefined | SelectionManager;
+  /**
+   * Current value of the list's text filter.
+   *
+   * @since 5.2
+   */
+  accessor filterText: string | undefined;
+  /**
+   * Indicates that the filter should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideFilter: boolean;
+  /**
+   * Indicates that the filter notice should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideFilterNotice: boolean;
+  /**
+   * Indicates that the header should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideHeader: boolean;
+  /**
+   * Indicates that the close actions for individual list items should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideItemCloseActions: boolean;
+  /**
+   * Indicates that the count for individual list items should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideItemCount: boolean;
+  /**
+   * Indicates that the icons for individual list items should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideItemIcons: boolean;
+  /**
+   * Indicates that the menus for individual list items should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideItemMenus: boolean;
+  /**
+   * Indicates that the layer filter should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideLayerFilter: boolean;
+  /**
+   * Indicates that the primary menu should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideMenu: boolean;
+  /**
+   * Indicates that the total count should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideTotalCount: boolean;
+  /**
+   * Indicates that the 'zoom to' button should be hidden.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideZoomToButton: boolean;
+  /**
+   * Property controlling whether corresponding features on the view should be highlighted when
+   * hovering over the associated list item. Only applies to list items representing individual features.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor highlightOnHoverDisabled: boolean;
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @default "selection"
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: IconName | undefined;
+  /** The component's default label. */
+  accessor label: string | undefined;
+  /**
+   * Setting this property causes the list to only display features from this layer.
+   * If there are no selected features from this layer, the full list will appear.
+   * This value also reflects when a layer is selected from the layer dropdown.
+   *
+   * @since 5.2
+   */
+  accessor layer: SelectableLayer | null | undefined;
+  /**
+   * Items representing individual layers with an active selection.
+   *
+   * @since 5.2
+   */
+  get layerItems(): LayerItem[];
+  /**
+   * Used to display additional dropdown items in the dropdown associated with each list item.
+   *
+   * @since 5.2
+   */
+  accessor listItemActionConfigurations: ListItemActionConfiguration[] | undefined;
+  /**
+   * Used to set the unavailable property for each list item.
+   *
+   * @since 5.2
+   */
+  accessor listItemUnavailableFunction: ListItemUnavailableFunction | undefined;
+  /**
+   * Indicates the list is only showing a subset of selected feature items due to
+   * the selection being greater than the current value of the 'maxVisibleFeatureCountPerLayer'
+   * property. This value also accounts for any active filters.
+   *
+   * @default false
+   * @since 5.2
+   */
+  get maxVisibleFeatureCountExceeded(): boolean;
+  /**
+   * Maximum number of selected feature items displayed per layer.
+   * Does not limit or restrict the selection itself.
+   *
+   * @since 5.2
+   */
+  accessor maxVisibleFeatureCountPerLayer: number;
+  /**
+   * Default scale of all menus.
+   *
+   * @default "m"
+   * @since 5.2
+   */
+  accessor menuScale: Action["scale"];
+  /** @internal */
+  protected messages: Partial<{
+      componentLabel: string;
+      allLayersCount: string;
+      clear: string;
+      collapseAll: string;
+      deselectFeature: string;
+      deselectGroup: string;
+      deselectLayer: string;
+      featuresCount: string;
+      featuresCountShowing: string;
+      filter: string;
+      filterByLayer: string;
+      layerIsNotVisible: string;
+      menu: string;
+      noMatchingFeatures: string;
+      onlySelectFeature: string;
+      onlySelectThis: string;
+      preview: string;
+      previewTemplateAriaLabel: string;
+      selection: string;
+      selectionCount: string;
+      tooManyFeatures: string;
+      untitledLayer: string;
+      untitledFeature: string;
+      zoomTo: string;
+  }> & T9nMeta<{
+      componentLabel: string;
+      allLayersCount: string;
+      clear: string;
+      collapseAll: string;
+      deselectFeature: string;
+      deselectGroup: string;
+      deselectLayer: string;
+      featuresCount: string;
+      featuresCountShowing: string;
+      filter: string;
+      filterByLayer: string;
+      layerIsNotVisible: string;
+      menu: string;
+      noMatchingFeatures: string;
+      onlySelectFeature: string;
+      onlySelectThis: string;
+      preview: string;
+      previewTemplateAriaLabel: string;
+      selection: string;
+      selectionCount: string;
+      tooManyFeatures: string;
+      untitledLayer: string;
+      untitledFeature: string;
+      zoomTo: string;
+  }>;
+  /**
+   * 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)
+   */
+  accessor referenceElement: ArcgisReferenceElement | string | undefined;
+  /**
+   * A reference to a custom selection manager to use instead of the view's default selection manager.
+   *
+   * @since 5.2
+   */
+  accessor selectionManager: SelectionManager | null | undefined;
+  /**
+   * Reflects the component's current state.
+   *
+   * @since 5.2
+   */
+  get state(): "disabled" | "error" | "loading" | "ready";
+  /**
+   * 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 arcgis-selection-list component will be associated with a map or scene component rather than using the `view` property.
+   */
+  accessor view: SelectableViewUnion | null | undefined;
+  /**
+   * Total number of visible feature items in the list.
+   *
+   * @since 5.2
+   */
+  get visibleFeatureCount(): number;
+  /**
+   * Current number of visible feature list items, accounting for 'maxVisibleFeatureCountPerLayer'.
+   * Excludes feature list items hidden by the filter.
+   *
+   * @since 5.2
+   */
+  get visibleFeatureItems(): FeatureItem[];
+  /**
+   * Count for total number of visible layer items in the list, excluding group layer items.
+   *
+   * @since 5.2
+   */
+  get visibleLayerCount(): number;
+  /**
+   * Controls the visual scale of any rendered Calcite elements.
+   *
+   * @default "s"
+   * @since 5.2
+   */
+  accessor visualScale: Action["scale"];
+  /**
+   * Clears all active selections for all groups, layers and features.
+   *
+   * @since 5.2
+   */
+  clear(): Promise<void>;
+  /**
+   * Utility method for collapsing all parent list items.
+   *
+   * @since 5.2
+   */
+  collapseAll(): Promise<void>;
+  /**
+   * Utility method to deselect any group, layer or feature item.
+   *
+   * @param item
+   * @since 5.2
+   */
+  deselectItem(item: ListItem): Promise<void>;
+  /** Permanently destroy the component. */
+  destroy(): Promise<void>;
+  /**
+   * Utility method for expanding all parent list items.
+   *
+   * @since 5.2
+   */
+  expandAll(): Promise<void>;
+  /**
+   * Utility method for finding the corresponding LayerItem for a given layer.
+   *
+   * @param layer - The layer for which to find the corresponding LayerItem.
+   * @returns The LayerItem associated with the provided layer.
+   * @since 5.2
+   */
+  findLayerItem(layer: SelectableLayer): Promise<LayerItem | null | undefined>;
+  /**
+   * Utility method for finding the corresponding ParentItem for a given layer.
+   *
+   * @param layer - The layer for which to find the corresponding ParentItem.
+   * @returns The ParentItem associated with the provided layer.
+   * @since 5.2
+   */
+  findParentItem(layer: SelectableLayer): Promise<null | undefined | ParentItem>;
+  /**
+   * Repositions the view to center based on the chosen item.
+   *
+   * @param item
+   * @since 5.2
+   */
+  goToItem(item: ListItem): Promise<void>;
+  /**
+   * Removes specific features from the selection, based on the provided layer and object IDs.
+   *
+   * @param params
+   * @since 5.2
+   */
+  removeFromSelection(params: {
+      layer: SelectableLayer;
+      selection: SelectionIdentifier[];
+  }): Promise<void>;
+  /**
+   * Replaces an active selection, based on the provided layer and object IDs.
+   *
+   * @param params
+   * @since 5.2
+   */
+  replace(params: {
+      layer: SelectableLayer;
+      selection: SelectionIdentifier[];
+  }): Promise<void>;
+  /**
+   * Selects all features contextual to a given item. Deselects all other features.
+   *
+   * @param item
+   * @since 5.2
+   */
+  selectItem(item: ListItem): Promise<void>;
+  /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
+  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "state"; }>;
+  /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
+  readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly "@eventTypes": {
+    arcgisPropertyChange: ArcgisSelectionList["arcgisPropertyChange"]["detail"];
+    arcgisReady: ArcgisSelectionList["arcgisReady"]["detail"];
+  };
+}