@arcgis/map-components 5.2.0-next.122 → 5.2.0-next.124

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

@@ -11,26 +11,29 @@ 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.
+ * The `Selection List` component displays selected features in a hierarchical list organized by group and layer. It is intended for applications that need to present the current selection and support browsing, filtering, and interaction with selected features.
  *
+ * The component can be used with the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component and reflects selections made through a [selection manager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/), including the [view](https://developers.arcgis.com/javascript/latest/references/core/views/View/#selectionManager), the [Selection Toolbar](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/), or the [selection manager API](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/).
+ *
+ * @see [Sample - Selection List Component](https://developers.arcgis.com/javascript/latest/sample-code/selection-list/)
  * @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.
+   * Reference to a single [layer item](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) being displayed in the
+   * list, if the [layer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-list/#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.
+   * An optional function that runs when a user selects a feature, layer, or group item in the selection list itself. It does not run when a feature becomes selected through the [arcgis-selection-toolbar](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/), map click, or [selection manager API](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/).
    *
    * @since 5.2
    */
   accessor afterListItemSelect: ListItemSelectCallback | undefined;
   /**
-   * Items representing all individual layers and group layers with an active selection.
+   * Items representing all individual [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) and [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) layers with an active selection.
    *
    * @since 5.2
    */
@@ -67,17 +70,17 @@ export abstract class ArcgisSelectionList extends LitElement {
    */
   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.
+   * Controls how the list is displayed. If this value is set to `"group"`, the list displays [feature](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) and [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) items nested under
+   * their associated [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) and [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) items. If this value is set to `"layer"`, the list displays [feature](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) items nested under
+   * their associated [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) item, while excluding [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) items. If this value is set to `"feature"` the list only displays
+   * [feature](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) items, while excluding [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) and [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) items.
    *
    * @default "group"
    * @since 5.2
    */
   accessor displayMode: "feature" | "group" | "layer";
   /**
-   * Reference to the SelectionManager being represented by the component.
+   * Reference to the [selection manager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) being represented by the component.
    *
    * @since 5.2
    */
@@ -220,7 +223,7 @@ export abstract class ArcgisSelectionList extends LitElement {
   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'
+   * the selection being greater than the current value of the [maxVisibleFeatureCountPerLayer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-list/#maxVisibleFeatureCountPerLayer)
    * property. This value also accounts for any active filters.
    *
    * @default false
@@ -228,7 +231,8 @@ export abstract class ArcgisSelectionList extends LitElement {
    */
   get maxVisibleFeatureCountExceeded(): boolean;
   /**
-   * Maximum number of selected feature items displayed per layer.
+   * x
+   * Maximum number of selected [feature items](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) displayed per layer.
    * Does not limit or restrict the selection itself.
    *
    * @since 5.2
@@ -302,13 +306,18 @@ export abstract class ArcgisSelectionList extends LitElement {
    */
   accessor referenceElement: ArcgisReferenceElement | string | undefined;
   /**
-   * A reference to a custom selection manager to use instead of the view's default selection manager.
+   * A reference to a custom [selection manager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) to use instead of the view's default [selection manager](https://developers.arcgis.com/javascript/latest/references/core/views/View/#selectionManager).
    *
    * @since 5.2
    */
   accessor selectionManager: SelectionManager | null | undefined;
   /**
    * Reflects the component's current state.
+   * Possible values are:
+   * - `"disabled"`: The component is not interactive.
+   * - `"error"`: The component has encountered an error.
+   * - `"loading"`: The component is in a loading state.
+   * - `"ready"`: The component is ready for interaction.
    *
    * @since 5.2
    */
@@ -319,20 +328,20 @@ export abstract class ArcgisSelectionList extends LitElement {
    */
   accessor view: SelectableViewUnion | null | undefined;
   /**
-   * Total number of visible feature items in the list.
+   * Total number of visible [feature items](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) 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.
+   * Current number of visible [feature items](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) in the list, accounting for [maxVisibleFeatureCountPerLayer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-list/#maxVisibleFeatureCountPerLayer).
+   * Excludes [feature items](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) 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.
+   * Count for total number of visible [layer items](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) in the list, excluding [group layer items](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/).
    *
    * @since 5.2
    */
@@ -380,10 +389,10 @@ export abstract class ArcgisSelectionList extends LitElement {
    */
   findLayerItem(layer: SelectableLayer): Promise<LayerItem | null | undefined>;
   /**
-   * Utility method for finding the corresponding ParentItem for a given layer.
+   * Utility method for finding the corresponding parent item for a given layer.
    *
-   * @param layer - The layer for which to find the corresponding ParentItem.
-   * @returns The ParentItem associated with the provided layer.
+   * @param layer - The layer for which to find the corresponding parent item.
+   * @returns The parent item associated with the provided layer.
    * @since 5.2
    */
   findParentItem(layer: SelectableLayer): Promise<null | undefined | ParentItem>;