@arcgis/core 5.2.0-next.79 → 5.2.0-next.80

package/layers/list/Item.d.ts

@@ -0,0 +1,262 @@
+import type Accessor from "../../core/Accessor.js";
+import type Collection from "../../core/Collection.js";
+import type EsriError from "../../core/Error.js";
+import type Layer from "../Layer.js";
+import type SubtypeGroupLayer from "../SubtypeGroupLayer.js";
+import type ItemPanel from "./ItemPanel.js";
+import type Sublayer from "../support/Sublayer.js";
+import type SubtypeSublayer from "../support/SubtypeSublayer.js";
+import type LayerView from "../../views/layers/LayerView.js";
+import type { IdentifiableMixin, IdentifiableMixinProperties } from "../../core/Identifiable.js";
+import type { Action, State } from "./types.js";
+import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
+import type { StreamLayerViewConnectionStatus } from "../../views/layers/StreamLayerView.js";
+import type { ActionToggleProperties } from "../../support/actions/ActionToggle.js";
+import type { ActionButtonProperties } from "../../support/actions/ActionButton.js";
+import type { ReadonlyArrayOrCollection } from "../../core/Collection.js";
+import type { ItemPanelProperties } from "./ItemPanel.js";
+
+export interface ItemProperties extends IdentifiableMixinProperties, Partial<Pick<Item, "actionsExpanded" | "actionsOpen" | "checkPublishStatusEnabled" | "childrenSortable" | "expanded" | "hidden" | "layer" | "listModeDisabled" | "open" | "parent" | "sortable" | "view" | "visible">> {
+  /** A nested 2-dimensional collection of actions that could be triggered on the item. */
+  actionsSections?: ReadonlyArrayOrCollection<ReadonlyArrayOrCollection<((ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }))>>;
+  /** When a layer contains sublayers, this property is a Collection of Item objects belonging to the given layer. */
+  children?: ReadonlyArrayOrCollection<ItemProperties>;
+  /**
+   * Additional panel state associated with this list item.
+   *
+   * @since 5.2
+   */
+  panel?: ItemPanelProperties;
+  /** The title of the layer. */
+  title?: string | null;
+}
+
+/**
+ * Represents a layer view that supports spatial referencing. Used to indicate whether the
+ * associated layer view can operate with a spatial reference in the current view context.
+ *
+ * @since 5.2
+ * @see [layerView](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#layerView)
+ */
+export interface SpatiallyReferencedLayerView extends LayerView {
+  /**
+   * Indicates if the layer view supports the current spatial reference.
+   *
+   * @since 5.2
+   */
+  spatialReferenceSupported: boolean;
+}
+
+/**
+ * Represents a layer view for stream layers that provides connection status information.
+ * Used to determine the current connection state of a stream layer in the view.
+ *
+ * @since 5.2
+ * @see [connectionStatus](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#connectionStatus)
+ */
+export interface ConnectedLayerView extends LayerView {
+  /**
+   * The current connection status of the stream layer view.
+   *
+   * @since 5.2
+   */
+  connectionStatus: StreamLayerViewConnectionStatus;
+}
+
+/**
+ * Defines how the visibility of child layers is managed within a list item.
+ *
+ * - `independent`: Each child layer's visibility is controlled separately.
+ * - `inherited`: Child layers inherit the visibility from their parent layer.
+ * - `exclusive`: Only one child layer can be visible at a time.
+ *
+ * @see [visibilityMode](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#visibilityMode)
+ */
+export type ItemVisibilityMode = "independent" | "inherited" | "exclusive";
+
+/**
+ * Represents state for a single layer entry in a list-oriented workflow.
+ *
+ * This class provides access to associated layer properties, supports nested child items,
+ * and stores action and panel state that can be consumed by separate UI components.
+ *
+ * To hide a layer entry based on layer configuration, set [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
+ * to `hide` on the corresponding layer.
+ *
+ * @since 5.2
+ * @see [ItemPanel](https://developers.arcgis.com/javascript/latest/references/core/layers/list/ItemPanel/)
+ */
+export default class Item extends ItemSuperclass {
+  constructor(properties?: ItemProperties);
+  /**
+   * Whether the actions state is expanded.
+   *
+   * @default false
+   */
+  accessor actionsExpanded: boolean;
+  /** Backward-compatible alias of [actionsExpanded](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#actionsExpanded). */
+  accessor actionsOpen: boolean;
+  /** A nested 2-dimensional collection of actions that could be triggered on the item. */
+  get actionsSections(): Collection<Collection<Action>>;
+  set actionsSections(value: ReadonlyArrayOrCollection<ReadonlyArrayOrCollection<((ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }))>>);
+  /**
+   * Enables publish-status checks used by [publishing](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#publishing).
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor checkPublishStatusEnabled: boolean;
+  /** When a layer contains sublayers, this property is a Collection of Item objects belonging to the given layer. */
+  get children(): Collection<Item>;
+  set children(value: ReadonlyArrayOrCollection<ItemProperties>);
+  /**
+   * Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered.
+   *
+   * @default true
+   * @since 5.2
+   * @example
+   * // disables the children of a parent list item from being sorted
+   * listItem.childrenSortable = false;
+   */
+  accessor childrenSortable: boolean;
+  /**
+   * Only valid when the list item represents a [StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer/). Indicates
+   * the [StreamLayerView.connectionStatus](https://developers.arcgis.com/javascript/latest/references/core/views/layers/StreamLayerView/#connectionStatus) of the stream layer connection.
+   * This overrides [updating](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#updating).
+   *
+   * @since 5.2
+   */
+  get connectionStatus(): ConnectedLayerView["connectionStatus"] | null | undefined;
+  /** The Error object returned if an error occurred. */
+  get error(): EsriError | null | undefined;
+  /**
+   * Whether this list item's details are expanded.
+   *
+   * @default false
+   */
+  accessor expanded: boolean;
+  /**
+   * When `true`, marks this list item as hidden for consumer UIs.
+   *
+   * This is an alternative to [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode), which hides a layer
+   * based on layer configuration.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hidden: boolean;
+  /**
+   * Whether the layer is unsupported by the view.
+   *
+   * @default false
+   * @since 5.2
+   */
+  get incompatible(): boolean;
+  /** The layer associated with the triggered action. */
+  accessor layer: Layer | Sublayer | SubtypeSublayer | SubtypeGroupLayer | null;
+  /**
+   * The [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) displaying data for the
+   * associated [layer](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#layer).
+   */
+  get layerView(): LayerView | SpatiallyReferencedLayerView | ConnectedLayerView | null | undefined;
+  /**
+   * Specifies whether to ignore the [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property of the child layers in the list item.
+   * Use this when child inclusion should be controlled externally instead of by each child's
+   * `listMode` value.
+   *
+   * @default false
+   * @since 5.2
+   * @see [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
+   */
+  accessor listModeDisabled: boolean;
+  /** Backward-compatible alias of [expanded](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#expanded). */
+  accessor open: boolean;
+  /**
+   * Additional panel state associated with this list item.
+   *
+   * @since 5.2
+   */
+  get panel(): ItemPanel;
+  set panel(value: ItemPanelProperties);
+  /**
+   * The parent of this item
+   *
+   * @since 5.2
+   */
+  accessor parent: Item | null | undefined;
+  /**
+   * Value is `true` when [layer](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#layer) is being published.
+   * Value is `false` when the layer is not publishing or
+   * [checkPublishStatusEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#checkPublishStatusEnabled) is `false`.
+   *
+   * @default false
+   * @since 5.2
+   */
+  get publishing(): boolean;
+  /**
+   * Indicates if the list item (or layer in the map) can be sorted or moved/reordered.
+   *
+   * @default true
+   * @since 5.2
+   * @example
+   * // disables the list item from being sorted
+   * listItem.sortable = false;
+   */
+  accessor sortable: boolean;
+  /**
+   * Overall state of this item for consumer UIs.
+   *
+   * @since 5.2
+   */
+  get state(): State;
+  /** The title of the layer. */
+  get title(): string;
+  set title(value: string | null | undefined);
+  /**
+   * Value is `true` when the layer is updating; for example, if it is in the process of fetching data.
+   *
+   * @default false
+   */
+  get updating(): boolean;
+  /** The view context for this list item. */
+  accessor view: MapViewOrSceneView | null | undefined;
+  /** Indicates how to manage the visibility of the children layers. */
+  get visibilityMode(): ItemVisibilityMode;
+  /**
+   * Indicates if the Item is visible.
+   *
+   * @default true
+   */
+  accessor visible: boolean;
+  /**
+   * Whether the layer is visible at the current scale or not.
+   *
+   * @default true
+   */
+  get visibleAtCurrentScale(): boolean;
+  /**
+   * Whether the layer is visible at the current time extent or not.
+   *
+   * @default true
+   * @since 5.2
+   */
+  get visibleAtCurrentTimeExtent(): boolean;
+  /**
+   * Creates a deep clone of this object.
+   *
+   * @returns A clone of the new [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) instance.
+   */
+  clone(): Item;
+  /**
+   * Toggles the visibility state of the associated layer.
+   *
+   * If `value` is provided, visibility is set to that value.
+   * Otherwise, visibility is inverted.
+   *
+   * @param value - Optional target visibility value.
+   * @returns The resulting visibility value.
+   * @since 5.2
+   */
+  toggleVisibility(value?: boolean): boolean;
+}
+declare const ItemSuperclass: typeof Accessor & typeof IdentifiableMixin

package/layers/list/Item.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as e}from"tslib";import t from"../../core/Accessor.js";import{isSome as i}from"../../core/arrayUtils.js";import s from"../../core/Collection.js";import{IdentifiableMixin as l}from"../../core/Identifiable.js";import{watch as r,initial as n}from"../../core/reactiveUtils.js";import{property as o,cast as a,subclass as d}from"../../core/accessorSupport/decorators.js";import{get as h}from"../../core/accessorSupport/get.js";import p from"./ItemPanel.js";import{isLayerOutsideScaleRange as c,findLayerVisibilityMode as u,findLayerListMode as y,canDisplayLayer as b,getNormalizedChildLayerProperty as m}from"./support/layerListUtils.js";import v from"../../support/actions/ActionBase.js";import g from"../../support/actions/ActionButton.js";import f from"../../support/actions/ActionToggle.js";var C;const w=s.ofType({key:"type",defaultKeyValue:"button",base:v,typeMap:{button:g,toggle:f}}),_=s.ofType(w),S="layer",E="child-list-mode",x="hide";let M=C=class extends(l(t)){constructor(e){super(e),this.actionsSections=new _,this.actionsExpanded=!1,this.checkPublishStatusEnabled=!1,this.children=new(s.ofType(C)),this.childrenSortable=!0,this.hidden=!1,this.layer=null,this.listItemCreatedFunction=null,this.listModeDisabled=!1,this.expanded=!1,this.parent=null,this.view=null}initialize(){if(this.addHandles([r(()=>[this.layer,this.layer?.listMode,this.listModeDisabled],()=>this._watchLayerProperties(this.layer),n),r(()=>this.checkPublishStatusEnabled,e=>this._updateChildrenPublishing(e),n),r(()=>this.view,e=>this._updateChildrenView(e),n),r(()=>this.panel,e=>this._setItemOnPanel(e),n)]),"function"==typeof this.listItemCreatedFunction){const e={item:this};this.listItemCreatedFunction.call(null,e)}}destroy(){this.panel?.destroy(),this.children.destroyAll(),this.view=null}get actionsOpen(){return this.actionsExpanded}set actionsOpen(e){this.actionsExpanded=e}get connectionStatus(){const{layerView:e,publishing:t}=this;if(!t&&e&&"connectionStatus"in e)return e.connectionStatus}get error(){return this.layer?.loadError}get incompatible(){const{layerView:e}=this;return!(!e||!("spatialReferenceSupported"in e))&&!e.spatialReferenceSupported}get layerView(){const{layer:e,view:t}=this;if(!e||!t||"sublayer"===e.type)return null;const i="subtype-sublayer"===e.type?e.parent:e;return t.allLayerViews.find(e=>e.layer===i)??null}get open(){return this.expanded}set open(e){this.expanded=e}set panel(e){const t=this._get("panel");e!==t&&e&&t?.destroy(),this._set("panel",e)}castPanel(e){return this.expanded&&!e.hasOwnProperty("open")&&(e.open=!0),e?new p(e):null}get sortable(){return"knowledge-graph-sublayer"!==this.layer?.type&&this._get("sortable")}set sortable(e){this._set("sortable",e)}get state(){return!this.layer||this.hidden||this.incompatible?"disabled":this.updating?"loading":"ready"}get title(){const e=h(this,"layer.layer");return(!e||e&&h(this,"layer.layer.loaded"))&&h(this,"layer.title")||h(this,"layer.attributes.title")||""}set title(e){this._override("title",e)}get publishing(){const{layer:e,checkPublishStatusEnabled:t}=this;return!!(t&&e&&"publishingInfo"in e&&"publishing"===e.publishingInfo?.status)}get updating(){const{layerView:e,connectionStatus:t,layer:i,publishing:s}=this;return!s&&!t&&(e?e.updating:"loading"===i?.loadStatus||!1)}get visible(){return!!this.layer?.visible}set visible(e){const t=this.layer;t&&(t.visible=e)}get visibleAtCurrentScale(){return this.layerView?.visibleAtCurrentScale??!c(this.layer,this.view?.scale)}get visibleAtCurrentTimeExtent(){return this.layerView?.visibleAtCurrentTimeExtent??!0}get visibilityMode(){return u(this.layer)}clone(){return new C({actionsExpanded:this.actionsExpanded,actionsSections:this.actionsSections.clone(),checkPublishStatusEnabled:this.checkPublishStatusEnabled,children:this.children.clone(),childrenSortable:this.childrenSortable,expanded:this.expanded,hidden:this.hidden,layer:this.layer,listItemCreatedFunction:this.listItemCreatedFunction,listModeDisabled:this.listModeDisabled,panel:this.panel,parent:this.parent,sortable:this.sortable,title:this.title,view:this.view,visible:this.visible})}toggleVisibility(e){if(!this.layer)return!1;const t=e??!this.visible;return this.visible=t,this.visible}_setItemOnPanel(e){e&&(e.listItem=this)}_updateChildrenPublishing(e){this.children?.forEach(t=>t.checkPublishStatusEnabled=e)}_updateChildrenView(e){const t=this.children;t&&t.forEach(t=>t.view=e)}_createChildren(e){const{listModeDisabled:t,children:i}=this,s=e.filter(e=>!i.some(t=>t.layer===e));i.addMany(this._createChildItems(s,t).toArray())}_destroyChildren(e){const{children:t}=this,i=t.filter(t=>!!t.layer&&!e.includes(t.layer));t.destroyMany(i.toArray())}_sortChildren(e){this.children.sort((t,i)=>e.indexOf(i.layer)-e.indexOf(t.layer))}_destroyAllChildren(){this.removeHandles(E),this.children.destroyAll()}_watchChildLayerListMode(e){this.removeHandles(E),this.listModeDisabled||this.addHandles(e.toArray().map(t=>r(()=>t.listMode,()=>this._compileChildren(e))),E)}_compileChildren(e){const t=this.listModeDisabled?e:e?.filter(e=>y(e)!==x);e?.length?(this._createChildren(t),this._destroyChildren(t),this._sortChildren(t),this._watchChildLayerListMode(e)):this._destroyAllChildren()}_watchSublayerChanges(e){e&&this.addHandles(e.on("change",()=>this._compileChildren(e)),S)}_initializeChildLayers(e){this._compileChildren(e),this._watchSublayerChanges(e)}_createChildItems(e,t){return e.reverse().map(e=>t||b(e)?new C({layer:e,checkPublishStatusEnabled:this.checkPublishStatusEnabled,listItemCreatedFunction:this.listItemCreatedFunction,listModeDisabled:this.listModeDisabled,parent:this,view:this.view}):null).filter(i)}_watchLayerProperties(e){if(this.removeHandles(S),this.removeHandles(E),!e)return;if("hide-children"===(!this.listModeDisabled&&y(e)))return void this.children.destroyAll();const t=m(e);t&&this.addHandles(r(()=>e[t],i=>{const s=i;e.hasOwnProperty(t)&&s&&this._initializeChildLayers(s)},n),S)}};e([o({type:_})],M.prototype,"actionsSections",void 0),e([o()],M.prototype,"actionsExpanded",void 0),e([o()],M.prototype,"actionsOpen",null),e([o()],M.prototype,"checkPublishStatusEnabled",void 0),e([o({type:s.ofType(C)})],M.prototype,"children",void 0),e([o()],M.prototype,"childrenSortable",void 0),e([o({readOnly:!0})],M.prototype,"connectionStatus",null),e([o({readOnly:!0})],M.prototype,"error",null),e([o()],M.prototype,"hidden",void 0),e([o({readOnly:!0})],M.prototype,"incompatible",null),e([o()],M.prototype,"layer",void 0),e([o({readOnly:!0})],M.prototype,"layerView",null),e([o()],M.prototype,"listItemCreatedFunction",void 0),e([o({nonNullable:!0})],M.prototype,"listModeDisabled",void 0),e([o()],M.prototype,"expanded",void 0),e([o()],M.prototype,"open",null),e([o({type:p})],M.prototype,"panel",null),e([a("panel")],M.prototype,"castPanel",null),e([o()],M.prototype,"parent",void 0),e([o({value:!0})],M.prototype,"sortable",null),e([o({readOnly:!0})],M.prototype,"state",null),e([o()],M.prototype,"title",null),e([o({readOnly:!0})],M.prototype,"publishing",null),e([o({readOnly:!0})],M.prototype,"updating",null),e([o()],M.prototype,"view",void 0),e([o()],M.prototype,"visible",null),e([o({readOnly:!0})],M.prototype,"visibleAtCurrentScale",null),e([o({readOnly:!0})],M.prototype,"visibleAtCurrentTimeExtent",null),e([o({readOnly:!0})],M.prototype,"visibilityMode",null),M=C=e([d("esri.layers.list.Item")],M);const P=M;export{P as default};

package/layers/list/ItemPanel.d.ts

@@ -0,0 +1,75 @@
+import type Accessor from "../../core/Accessor.js";
+import type Item from "./Item.js";
+import type { IdentifiableMixin, IdentifiableMixinProperties } from "../../core/Identifiable.js";
+
+export interface ItemPanelProperties extends IdentifiableMixinProperties, Partial<Pick<ItemPanel, "content" | "disabled" | "flowEnabled" | "icon" | "image" | "listItem" | "open" | "title" | "visible">> {}
+
+/**
+ * Arbitrary data associated with the panel.
+ *
+ * @see [content](https://developers.arcgis.com/javascript/latest/references/core/layers/list/ItemPanel/#content)
+ */
+export type ItemPanelContent = "legend" | HTMLElement | string;
+
+/**
+ * Defines one or more panel content values.
+ *
+ * @see [content](https://developers.arcgis.com/javascript/latest/references/core/layers/list/ItemPanel/#content)
+ */
+export type ItemPanelContents = ItemPanelContent | ItemPanelContent[];
+
+/**
+ * Generic state container for additional list item details.
+ *
+ * This class does not render UI. It stores panel state that can be consumed by separate view components.
+ *
+ * @since 5.2
+ */
+export default class ItemPanel extends ItemPanelSuperclass {
+  constructor(properties?: ItemPanelProperties);
+  /** Arbitrary content metadata for the panel. */
+  accessor content: ItemPanelContents | null | undefined;
+  /**
+   * If `true`, panel interactions are disabled.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor disabled: boolean;
+  /**
+   * Indicates if panel content should be shown in a drill-in flow by a consumer UI.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor flowEnabled: boolean;
+  /**
+   * Identifier for an icon to represent this panel.
+   *
+   * @since 5.2
+   */
+  accessor icon: string | null | undefined;
+  /** URL or data URI used by consumer UIs to represent the panel. */
+  accessor image: string | null | undefined;
+  /** The parent list item associated with this panel. */
+  accessor listItem: Item | null | undefined;
+  /**
+   * Indicates if the panel is open.
+   *
+   * @default false
+   */
+  accessor open: boolean;
+  /**
+   * The title of the panel.
+   *
+   * @default ""
+   */
+  accessor title: string;
+  /**
+   * Indicates whether consumer UIs should show this panel.
+   *
+   * @default true
+   */
+  accessor visible: boolean;
+}
+declare const ItemPanelSuperclass: typeof Accessor & typeof IdentifiableMixin

package/layers/list/ItemPanel.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as t}from"tslib";import o from"../../core/Accessor.js";import{IdentifiableMixin as e}from"../../core/Identifiable.js";import{property as i,subclass as s}from"../../core/accessorSupport/decorators.js";let r=class extends(e(o)){constructor(t){super(t),this.content=null,this.disabled=!1,this.flowEnabled=!1,this.icon=null,this.image=null,this.listItem=null,this.open=!1,this.title="",this.visible=!0}};t([i()],r.prototype,"content",void 0),t([i()],r.prototype,"disabled",void 0),t([i()],r.prototype,"flowEnabled",void 0),t([i()],r.prototype,"icon",void 0),t([i()],r.prototype,"image",void 0),t([i()],r.prototype,"listItem",void 0),t([i()],r.prototype,"open",void 0),t([i()],r.prototype,"title",void 0),t([i()],r.prototype,"visible",void 0),r=t([s("esri.layers.list.ItemPanel")],r);const l=r;export{l as default};

package/layers/list/LayerItemCollection.d.ts

@@ -0,0 +1,106 @@
+import type Collection from "../../core/Collection.js";
+import type Item from "./Item.js";
+import type { EventedAccessor } from "../../core/Evented.js";
+import type { Action, ItemModifier, State } from "./types.js";
+import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
+
+export interface LayerItemCollectionProperties extends Partial<Pick<LayerItemCollection, "checkPublishStatusEnabled" | "listItemCreatedFunction" | "listModeDisabled" | "view">> {}
+
+export interface LayerItemCollectionEvents {
+  /**
+   * Emitted when the user clicks an [action](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionButton/) or
+   * [action toggle](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionToggle/) in a layer list.
+   * Use this event to run custom logic when a specific action is triggered.
+   *
+   * @see [@trigger-action](https://developers.arcgis.com/javascript/latest/references/core/layers/list/LayerItemCollection/#event-trigger-action)
+   */
+  "trigger-action": LayerItemCollectionTriggerActionEvent;
+}
+
+/**
+ * The event object for the `trigger-action` event in the layer lists.
+ *
+ * @see [@trigger-action](https://developers.arcgis.com/javascript/latest/references/core/layers/list/LayerItemCollection/#event-trigger-action)
+ */
+export interface LayerItemCollectionTriggerActionEvent {
+  /** The action that was clicked by the user. */
+  action: Action;
+  /** The list item associated with the action. */
+  item: Item;
+}
+
+/**
+ * Provides list-item orchestration logic for layer-list workflows.
+ * To hide layers from the list, set the [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
+ * property on the layer(s) to `hide`.
+ *
+ * @since 5.2
+ */
+export default class LayerItemCollection extends EventedAccessor {
+  /**
+   * @deprecated
+   * Do not directly reference this property.
+   * Use EventNames and EventTypes helpers from \@arcgis/core/Evented
+   */
+  "@eventTypes": LayerItemCollectionEvents;
+  constructor(properties?: LayerItemCollectionProperties);
+  /**
+   * Whether to provide an indication if a layer is being published.
+   * The [Item.publishing](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#publishing) property
+   * will be `false` if `checkPublishStatusEnabled` is `false`.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor checkPublishStatusEnabled: boolean;
+  /**
+   * Specifies a function that accesses each [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/).
+   * Each list item can be modified according to its modifiable properties.
+   * Actions can be added to list items using the
+   * [Item.actionsSections](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#actionsSections) property.
+   *
+   * @since 5.2
+   */
+  accessor listItemCreatedFunction: ItemModifier | null | undefined;
+  /**
+   * Specifies whether to ignore the [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers.
+   *
+   * @default false
+   * @since 5.2
+   * @see [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
+   */
+  accessor listModeDisabled: boolean;
+  /**
+   * A collection of [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/)s representing operational layers.
+   * To hide layers from the list, set [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) to `hide`.
+   *
+   * @see [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
+   */
+  get operationalItems(): Collection<Item>;
+  /**
+   * The view model's state.
+   *
+   * @default "disabled"
+   */
+  get state(): State;
+  /** The view context for this view model. */
+  accessor view: MapViewOrSceneView | null | undefined;
+  /**
+   * Moves a list item from one position to another.
+   *
+   * @param targetItem - The list item to move.
+   * @param fromParentItem - The current parent list item, if any.
+   * @param toParentItem - The target parent list item, if any.
+   * @param newIndex - The new index for the target item.
+   * @since 5.2
+   */
+  moveItem(targetItem: Item | null | undefined, fromParentItem: Item | null | undefined, toParentItem: Item | null | undefined, newIndex: number): void;
+  /**
+   * Triggers the [@trigger-action](https://developers.arcgis.com/javascript/latest/references/core/layers/list/LayerItemCollection/#event-trigger-action) event and executes
+   * the given [action](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionButton/) or [action toggle](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionToggle/).
+   *
+   * @param action - The action to execute.
+   * @param item - An item associated with the action.
+   */
+  triggerAction(action: Action, item: Item): void;
+}

package/layers/list/LayerItemCollection.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as e}from"tslib";import t from"../../core/Collection.js";import{EventedAccessor as s}from"../../core/Evented.js";import{watch as i,initial as a}from"../../core/reactiveUtils.js";import{property as r,subclass as l}from"../../core/accessorSupport/decorators.js";import o from"./Item.js";import{getItemLayers as n,findLayerListMode as d}from"./support/layerListUtils.js";import{isLinkChartView as h}from"../../linkChart/guards.js";const m={view:"view",viewLayers:"view-layers",mapLayers:"map-layers",layerViews:"layer-views",layerListMode:"layer-list-mode"},c="hide",p=t.ofType(o);let y=class extends s{constructor(e){super(e),this.checkPublishStatusEnabled=!1,this.listItemCreatedFunction=null,this.listModeDisabled=!1,this.operationalItems=new p,this.view=null}initialize(){this.addHandles([i(()=>!0===this.view?.ready,()=>this._viewHandles(),a),i(()=>[this.listItemCreatedFunction,this.checkPublishStatusEnabled,this.listModeDisabled],()=>this._recompileList()),i(()=>h(this.view)?this.view.inGeographicLayout:null,()=>this._compileList())],m.view)}destroy(){this._removeAllItems(),this.view=null}get state(){const{view:e}=this;return e?.ready?"ready":e?"loading":"disabled"}get totalItems(){return this.operationalItems.flatten(e=>e.children).length}triggerAction(e,t){e&&!e.disabled&&this.emit("trigger-action",{action:e,item:t})}moveItem(e,t,s,i){const a=e?.layer;if(!a||"subtype-sublayer"===a.type||"sublayer"===a.type)return;const r=this.view?.map?.layers,l=t?n(t):r,o=s?n(s):r;if(!l||!o)return;const{operationalItems:d}=this,h=t?.children||d,m=s?.children||d,c=o.length-i;e.parent=s||null,h.remove(e),l.remove(a),m.includes(e)||m.add(e,c),o.includes(a)||o.add(a,c),this._compileList()}_createLayerViewHandles(e){this.removeHandles(m.layerViews),this._compileList(),e&&this.addHandles(e.on("change",()=>this._compileList()),m.layerViews)}_createMapLayerHandles(e){this.removeHandles(m.mapLayers),this._compileList(),e&&this.addHandles(e.on("change",()=>this._compileList()),m.mapLayers)}_createItem(e){const{view:t,listItemCreatedFunction:s,checkPublishStatusEnabled:i,listModeDisabled:a}=this;return new o({checkPublishStatusEnabled:i,listModeDisabled:a,layer:e,listItemCreatedFunction:s,view:t})}_removeAllItems(){this.operationalItems.destroyAll()}_getViewableLayers(e){return e?this.listModeDisabled?e:e.filter(e=>d(e)!==c):void 0}_watchLayersListMode(e){this.removeHandles(m.layerListMode),e&&!this.listModeDisabled&&this.addHandles(i(()=>e.filter(e=>"listMode"in e).map(e=>e.listMode).toArray(),()=>this._compileList()),m.layerListMode)}_compileList(){const e=this.view?.map?.layers,t=h(this.view)&&!this.view.inGeographicLayout?e?.filter(({type:e})=>"link-chart"===e):e;this._watchLayersListMode(t);const s=this._getViewableLayers(t);s?.length?(this._createNewItems(s),this._removeItems(s),this._sortItems(s)):this._removeAllItems()}_createNewItems(e){const{operationalItems:t}=this;e.forEach(e=>{t.some(t=>t.layer===e)||t.add(this._createItem(e))})}_removeItems(e){const{operationalItems:t}=this,s=[];t.forEach(t=>{t&&e&&e.includes(t.layer)||s.push(t)}),t.destroyMany(s)}_sortItems(e){const{operationalItems:t}=this;t.sort((t,s)=>{const i=e.indexOf(t.layer),a=e.indexOf(s.layer);return i>a?-1:i<a?1:0})}_recompileList(){this._removeAllItems(),this._compileList()}_viewHandles(){const{view:e}=this;this.removeHandles([m.mapLayers,m.layerViews,m.viewLayers]),e?.ready?this.addHandles([i(()=>this.view?.map?.allLayers,e=>this._createMapLayerHandles(e),a),i(()=>this.view?.allLayerViews,e=>this._createLayerViewHandles(e),a)],m.viewLayers):this._removeAllItems()}};e([r()],y.prototype,"checkPublishStatusEnabled",void 0),e([r()],y.prototype,"listItemCreatedFunction",void 0),e([r({nonNullable:!0})],y.prototype,"listModeDisabled",void 0),e([r({type:p})],y.prototype,"operationalItems",void 0),e([r({readOnly:!0})],y.prototype,"state",null),e([r()],y.prototype,"totalItems",null),e([r()],y.prototype,"view",void 0),y=e([l("esri.layers.list.LayerItemCollection")],y);const v=y;export{v as default};

package/layers/list/TableItem.d.ts

@@ -0,0 +1,136 @@
+import type Accessor from "../../core/Accessor.js";
+import type Collection from "../../core/Collection.js";
+import type EsriError from "../../core/Error.js";
+import type Layer from "../Layer.js";
+import type SubtypeGroupLayer from "../SubtypeGroupLayer.js";
+import type TableItemPanel from "./TableItemPanel.js";
+import type Sublayer from "../support/Sublayer.js";
+import type SubtypeSublayer from "../support/SubtypeSublayer.js";
+import type { IdentifiableMixin, IdentifiableMixinProperties } from "../../core/Identifiable.js";
+import type { Action } from "./types.js";
+import type { ActionToggleProperties } from "../../support/actions/ActionToggle.js";
+import type { ActionButtonProperties } from "../../support/actions/ActionButton.js";
+import type { ReadonlyArrayOrCollection } from "../../core/Collection.js";
+import type { TableItemPanelProperties } from "./TableItemPanel.js";
+
+export interface TableItemProperties extends IdentifiableMixinProperties, Partial<Pick<TableItem, "actionsOpen" | "checkPublishStatusEnabled" | "hidden" | "layer" | "listModeDisabled" | "open" | "parent">> {
+  /** A nested 2-dimensional collection of actions that can be triggered on the item. */
+  actionsSections?: ReadonlyArrayOrCollection<ReadonlyArrayOrCollection<((ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }))>>;
+  /**
+   * Child items when the associated layer contains sublayers.
+   *
+   * @since 5.2
+   */
+  children?: ReadonlyArrayOrCollection<TableItemProperties>;
+  /**
+   * Additional panel state associated with this item.
+   *
+   * @since 5.2
+   */
+  panel?: TableItemPanelProperties;
+  /** The title of the associated table. */
+  title?: string | null;
+}
+
+/** Event object passed to a table list item creation callback. */
+export interface TableItemModifierEvent {
+  /** The table list item being created. */
+  item: TableItem;
+}
+
+/**
+ * Function used to customize table list items during creation.
+ *
+ * @param event - The event containing the table list item being created.
+ */
+export type TableItemModifier = (event: TableItemModifierEvent) => void;
+
+/**
+ * Represents a table-related list item with support for child items, actions, and panel state.
+ *
+ * @since 5.2
+ */
+export default class TableItem extends TableItemSuperclass {
+  constructor(properties?: TableItemProperties);
+  /**
+   * Indicates whether the actions state is open.
+   *
+   * @default false
+   */
+  accessor actionsOpen: boolean;
+  /** A nested 2-dimensional collection of actions that can be triggered on the item. */
+  get actionsSections(): Collection<Collection<Action>>;
+  set actionsSections(value: ReadonlyArrayOrCollection<ReadonlyArrayOrCollection<((ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }))>>);
+  /**
+   * Enables publish-status checks used by [publishing](https://developers.arcgis.com/javascript/latest/references/core/layers/list/TableItem/#publishing).
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor checkPublishStatusEnabled: boolean;
+  /**
+   * Child items when the associated layer contains sublayers.
+   *
+   * @since 5.2
+   */
+  get children(): Collection<TableItem>;
+  set children(value: ReadonlyArrayOrCollection<TableItemProperties>);
+  /** The error object returned if an error occurred. */
+  get error(): EsriError | null | undefined;
+  /**
+   * When `true`, marks this item as hidden for consumer UIs.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hidden: boolean;
+  /** The layer associated with the triggered action. */
+  accessor layer: Layer | Sublayer | SubtypeSublayer | SubtypeGroupLayer;
+  /**
+   * Specifies whether to ignore the [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property of child layers.
+   *
+   * @default false
+   * @since 5.2
+   * @see [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
+   */
+  accessor listModeDisabled: boolean;
+  /**
+   * Indicates whether the item is open.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor open: boolean;
+  /**
+   * Additional panel state associated with this item.
+   *
+   * @since 5.2
+   */
+  get panel(): TableItemPanel;
+  set panel(value: TableItemPanelProperties);
+  /**
+   * The parent item.
+   *
+   * @since 5.2
+   */
+  accessor parent: TableItem | null | undefined;
+  /**
+   * Value is `true` when the [layer](https://developers.arcgis.com/javascript/latest/references/core/layers/list/TableItem/#layer) is being published.
+   * Value is `false` when not publishing or when
+   * [checkPublishStatusEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/list/TableItem/#checkPublishStatusEnabled) is `false`.
+   *
+   * @default false
+   * @since 5.2
+   */
+  get publishing(): boolean;
+  /** The title of the associated table. */
+  get title(): string;
+  set title(value: string | null | undefined);
+  /**
+   * Creates a deep clone of this object.
+   *
+   * @returns A clone of the new [TableItem](https://developers.arcgis.com/javascript/latest/references/core/layers/list/TableItem/) instance.
+   */
+  clone(): TableItem;
+}
+declare const TableItemSuperclass: typeof Accessor & typeof IdentifiableMixin

package/layers/list/TableItem.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as e}from"tslib";import t from"../../core/Accessor.js";import{isSome as i}from"../../core/arrayUtils.js";import s from"../../core/Collection.js";import{IdentifiableMixin as l}from"../../core/Identifiable.js";import{watch as r,initial as o}from"../../core/reactiveUtils.js";import{property as n,cast as a,subclass as h}from"../../core/accessorSupport/decorators.js";import{ensureType as d}from"../../core/accessorSupport/ensureType.js";import{get as p}from"../../core/accessorSupport/get.js";import c from"./TableItemPanel.js";import{canDisplayLayer as y,findLayerListMode as u,getNormalizedChildLayerProperty as m}from"./support/layerListUtils.js";import b from"../../support/actions/ActionBase.js";import f from"../../support/actions/ActionButton.js";import C from"../../support/actions/ActionToggle.js";var _;const v="layer",g="child-list-mode",P="hide",I=s.ofType({key:"type",defaultKeyValue:"button",base:b,typeMap:{button:f,toggle:C}}),S=s.ofType(I);let M=_=class extends(l(t)){constructor(e){super(e),this.actionsSections=new S,this.actionsOpen=!1,this.checkPublishStatusEnabled=!1,this.children=new(s.ofType(_)),this.hidden=!1,this.layer=null,this.listItemCreatedFunction=null,this.listModeDisabled=!1,this.open=!1,this.parent=null,this.sortable=!0}initialize(){if(this.addHandles([r(()=>[this.layer?.listMode,this.listModeDisabled],()=>this._watchLayerProperties(this.layer),o),r(()=>this.checkPublishStatusEnabled,e=>this._updateChildrenPublishing(e),o),r(()=>this.panel,e=>this._setItemOnPanel(e),o)]),"function"==typeof this.listItemCreatedFunction){const e={item:this};this.listItemCreatedFunction.call(null,e)}}destroy(){this.panel?.destroy(),this.children.destroyAll()}get error(){return this.layer?.loadError}set panel(e){const t=this._get("panel");e!==t&&e&&t?.destroy(),this._set("panel",e)}castPanel(e){return this.panel?.open&&!e.hasOwnProperty("open")&&(e.open=!0),d(c,e)}get publishing(){const{layer:e,checkPublishStatusEnabled:t}=this;return!!(t&&e&&"publishingInfo"in e&&"publishing"===e.publishingInfo?.status)}get title(){const e=p(this,"layer.layer");return(!e||e&&p(this,"layer.layer.loaded")?this.layer?.title:null)??""}set title(e){this._overrideIfSome("title",e)}clone(){return new _({actionsSections:this.actionsSections.clone(),actionsOpen:this.actionsOpen,checkPublishStatusEnabled:this.checkPublishStatusEnabled,children:this.children.clone(),hidden:this.hidden,layer:this.layer,listItemCreatedFunction:this.listItemCreatedFunction,listModeDisabled:this.listModeDisabled,open:this.open,panel:this.panel,parent:this.parent,sortable:this.sortable,title:this.title})}_updateChildrenPublishing(e){this.children?.forEach(t=>t.checkPublishStatusEnabled=e)}_setItemOnPanel(e){e&&(e.listItem=this)}_createChildItems(e,t){return e.reverse().map(e=>t||y(e)?new _({layer:e,checkPublishStatusEnabled:this.checkPublishStatusEnabled,listItemCreatedFunction:this.listItemCreatedFunction,listModeDisabled:this.listModeDisabled,parent:this}):null).filter(i)}_createChildren(e){const{listModeDisabled:t,children:i}=this,s=e.reverse().filter(e=>!i.some(t=>t.layer===e));i.addMany(this._createChildItems(s,t))}_destroyChildren(e){const{children:t}=this,i=t.filter(t=>!!t.layer&&!e.includes(t.layer));t.destroyMany(i)}_sortChildren(e){this.children.sort((t,i)=>e.indexOf(i.layer)-e.indexOf(t.layer))}_destroyAllChildren(){this.removeHandles(g),this.children.destroyAll()}_compileChildren(e){const t=this.listModeDisabled?e:e?.filter(e=>u(e)!==P);e?.length?(this._createChildren(t),this._destroyChildren(t),this._sortChildren(t),this._watchChildLayerListMode(e)):this._destroyAllChildren()}_watchChildLayerListMode(e){this.removeHandles(g),this.listModeDisabled||this.addHandles(e.toArray().map(t=>r(()=>t.listMode,()=>this._compileChildren(e))),g)}_watchSublayerChanges(e){e&&this.addHandles(e.on("change",()=>this._compileChildren(e)),v)}_initializeChildLayers(e){this._compileChildren(e),this._watchSublayerChanges(e)}_watchLayerProperties(e){if(this.removeHandles(v),this.removeHandles(g),!e)return;e.load().catch(()=>{});if("hide-children"===(!this.listModeDisabled&&u(e)))return void this.children.destroyAll();const t=m(e);t&&this.addHandles(r(()=>e[t],i=>{e.hasOwnProperty(t)&&this._initializeChildLayers(i)},o),v)}};e([n({type:S})],M.prototype,"actionsSections",void 0),e([n()],M.prototype,"actionsOpen",void 0),e([n()],M.prototype,"checkPublishStatusEnabled",void 0),e([n({type:s.ofType(_)})],M.prototype,"children",void 0),e([n({readOnly:!0})],M.prototype,"error",null),e([n()],M.prototype,"hidden",void 0),e([n()],M.prototype,"layer",void 0),e([n()],M.prototype,"listItemCreatedFunction",void 0),e([n({nonNullable:!0})],M.prototype,"listModeDisabled",void 0),e([n()],M.prototype,"open",void 0),e([n({type:c})],M.prototype,"panel",null),e([a("panel")],M.prototype,"castPanel",null),e([n()],M.prototype,"parent",void 0),e([n({readOnly:!0})],M.prototype,"publishing",null),e([n()],M.prototype,"sortable",void 0),e([n()],M.prototype,"title",null),M=_=e([h("esri.layers.list.TableItem")],M);const j=M;export{j as default};