@arcgis/core 5.2.0-next.111 → 5.2.0-next.113

package/layers/list/BasemapItemCollection.d.ts

@@ -5,28 +5,39 @@ import type { LayerItemCollectionEvents } from "./LayerItemCollection.js";
 import type { Action, ItemModifier, State } from "./types.js";
 import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
 
+/** @internal */
 export interface BasemapItemCollectionProperties extends Partial<Pick<BasemapItemCollection, "baseItemCreatedFunction" | "basemapTitle" | "checkPublishStatusEnabled" | "listModeDisabled" | "referenceItemCreatedFunction" | "view">> {}
 
+/** @internal */
 export interface BasemapItemCollectionEvents extends LayerItemCollectionEvents {}
 
 /**
  * Provides list orchestration logic for basemap base and reference layers.
  *
- * @since 5.2
+ * @internal
  */
 export default class BasemapItemCollection extends EventedAccessor {
-  /**
-   * @deprecated
-   * Do not directly reference this property.
-   * Use EventNames and EventTypes helpers from \@arcgis/core/Evented
-   */
+  /** @internal */
   "@eventTypes": BasemapItemCollectionEvents;
+  /** @internal */
   constructor(properties?: BasemapItemCollectionProperties);
-  /** Specifies a function that accesses each base-layer [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/). */
+  /**
+   * Specifies a function that accesses each base-layer [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/).
+   *
+   * @internal
+   */
   accessor baseItemCreatedFunction: ItemModifier | null | undefined;
-  /** A collection of [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/)s representing basemap base layers. */
+  /**
+   * A collection of [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/)s representing basemap base layers.
+   *
+   * @internal
+   */
   get baseItems(): Collection<Item>;
-  /** The current basemap title. */
+  /**
+   * The current basemap title.
+   *
+   * @internal
+   */
   accessor basemapTitle: string | null | undefined;
   /**
    * Whether to provide an indication if a layer is being published.
@@ -34,33 +45,47 @@ export default class BasemapItemCollection extends EventedAccessor {
    * is `false` if `checkPublishStatusEnabled` is `false`.
    *
    * @default false
-   * @since 5.2
+   * @internal
    */
   accessor checkPublishStatusEnabled: boolean;
   /**
    * Specifies whether to ignore the [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property of layers.
    *
    * @default false
-   * @since 5.2
+   * @internal
    * @see [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
    */
   accessor listModeDisabled: boolean;
-  /** Specifies a function that accesses each reference-layer [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/). */
+  /**
+   * Specifies a function that accesses each reference-layer [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/).
+   *
+   * @internal
+   */
   accessor referenceItemCreatedFunction: ItemModifier | null | undefined;
-  /** A collection of [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/)s representing basemap reference layers. */
+  /**
+   * A collection of [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/)s representing basemap reference layers.
+   *
+   * @internal
+   */
   get referenceItems(): Collection<Item>;
   /**
    * The view model's state.
    *
    * @default "disabled"
+   * @internal
    */
   get state(): State;
-  /** The view context for this view model. */
+  /**
+   * The view context for this view model.
+   *
+   * @internal
+   */
   accessor view: MapViewOrSceneView | null | undefined;
   /**
    * Moves a list item between base and reference collections.
    *
    * @param options - Move options describing source, target, and destination index.
+   * @internal
    */
   moveItem(options: {
       targetItem: Item | null | undefined;
@@ -76,6 +101,7 @@ export default class BasemapItemCollection extends EventedAccessor {
    *
    * @param action - The action to execute.
    * @param item - An item associated with the action.
+   * @internal
    */
   triggerAction(action: Action, item: Item): void;
 }

package/layers/list/BasemapItemCollection.js

@@ -1,2 +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 n from"./Item.js";import{getItemLayers as o,findLayerListMode as m}from"./support/layerListUtils.js";const c={view:"view",basemap:"basemap",baseLayers:"base-layers",referenceLayers:"reference-layers",baseLayersListMode:"reference-layers-list-mode",referenceLayersListMode:"base-layers-list-mode",baseLayerViews:"base-layer-views",referenceLayerViews:"reference-layer-views",children:"children"},h="hide",d=t.ofType(n);let y=class extends s{constructor(e){super(e),this.baseItems=new d,this.baseItemCreatedFunction=null,this.checkPublishStatusEnabled=!1,this.listModeDisabled=!1,this.referenceItemCreatedFunction=null,this.referenceItems=new d,this.view=null,this._compileBaseList=this._compileBaseList.bind(this),this._compileReferenceList=this._compileReferenceList.bind(this)}initialize(){this.addHandles([i(()=>[this.view?.map?.basemap,!0===this.view?.ready,this.view?.basemapView],()=>this._watchBasemapLayers(),a),i(()=>[this.baseItemCreatedFunction,this.checkPublishStatusEnabled,this.listModeDisabled],()=>this._baseItemCreatedFunctionChanged()),i(()=>[this.referenceItemCreatedFunction,this.checkPublishStatusEnabled,this.listModeDisabled],()=>this._referenceItemCreatedFunctionChanged())],c.view)}destroy(){this.view=null,this._removeAllBaseItems(),this._removeAllReferenceItems()}get basemapTitle(){return this.view?.map?.basemap?.title??null}set basemapTitle(e){this._override("basemapTitle",e)}get state(){return this.view?.ready?"ready":this.view?"loading":"disabled"}get totalBaseItems(){return this.baseItems.flatten(e=>e.children).length}get totalReferenceItems(){return this.referenceItems.flatten(e=>e.children).length}triggerAction(e,t){e&&!e.disabled&&this.emit("trigger-action",{action:e,item:t})}moveItem({targetItem:e,fromParentItem:t,toParentItem:s,from:i,to:a,newIndex:r}){const l=e?.layer;if(!l||"subtype-sublayer"===l.type||"sublayer"===l.type)return;const n=this.view?.map?.basemap,m=n?.baseLayers,c=n?.referenceLayers,h=t?o(t):"base"===i?m:c,d=s?o(s):"base"===a?m:c;if(!h||!d)return;const{baseItems:y,referenceItems:p}=this,b="base"===i?y:p,f="base"===a?y:p,I=t?.children||b,u=s?.children||f,v=d.length-r;e.parent=s||null,I.remove(e),h.remove(l),u.includes(e)||u.add(e,v),d.includes(l)||d.add(l,v),this._compileLists()}_createItemChangeHandles({items:e,key:t,callback:s}){this.removeHandles(t),s(),e&&this.addHandles(e.on("change",()=>s()),t)}_createItem({layer:e,type:t}){const{view:s,baseItemCreatedFunction:i,referenceItemCreatedFunction:a,checkPublishStatusEnabled:r,listModeDisabled:l}=this;return new n({layer:e,checkPublishStatusEnabled:r,listItemCreatedFunction:"base"===t?i:a,listModeDisabled:l,view:s})}_watchLayersListMode({layers:e,key:t,callback:s}){this.removeHandles(t),e&&!this.listModeDisabled&&this.addHandles(i(()=>e.filter(e=>"listMode"in e).map(e=>e.listMode).toArray(),()=>s()),t)}_getViewableLayers(e){return e?this.listModeDisabled?e:e.filter(e=>m(e)!==h):void 0}_compileItems({layers:e,items:t,key:s,type:i,callback:a}){this._watchLayersListMode({layers:e,key:s,callback:a});const r=this._getViewableLayers(e);r?.length?(this._createNewItems({type:i,items:t,layers:r}),this._removeItems({items:t,layers:r}),this._sortItems(t,r)):"base"===i?this._removeAllBaseItems():this._removeAllReferenceItems()}_compileReferenceList(){const{referenceItems:e}=this,t=this.view?.map?.basemap?.referenceLayers;this._compileItems({type:"reference",layers:t,items:e,key:c.referenceLayersListMode,callback:this._compileReferenceList})}_compileBaseList(){const{baseItems:e}=this,t=this.view?.map?.basemap?.baseLayers;this._compileItems({type:"base",layers:t,items:e,key:c.baseLayersListMode,callback:this._compileBaseList})}_compileLists(){this._compileReferenceList(),this._compileBaseList()}_createNewItems({items:e,layers:t,type:s}){t?.forEach(t=>{e.some(e=>e.layer===t)||e.add(this._createItem({type:s,layer:t}))})}_removeItems({items:e,layers:t}){e&&e.forEach(s=>{if(!s)return;const i=t?.some(e=>s.layer===e);i||(this.removeHandles(`${c.children}-${s.uid}`),e.remove(s),s.destroy())})}_sortItems(e,t){e&&t&&e.sort((e,s)=>{const i=t.indexOf(e.layer),a=t.indexOf(s.layer);return i>a?-1:i<a?1:0})}_removeAllBaseItems(){this.baseItems.drain(e=>{this.removeHandles(`${c.children}-${e.uid}`),e.destroy()})}_removeAllReferenceItems(){this.referenceItems.drain(e=>{this.removeHandles(`${c.children}-${e.uid}`),e.destroy()})}_baseItemCreatedFunctionChanged(){this._removeAllBaseItems(),this._compileLists()}_referenceItemCreatedFunctionChanged(){this._removeAllReferenceItems(),this._compileLists()}_watchBasemapLayers(){const{view:e}=this;if(this.removeHandles([c.baseLayers,c.referenceLayers,c.basemap,c.baseLayerViews,c.referenceLayerViews]),!e?.ready)return this._removeAllBaseItems(),void this._removeAllReferenceItems();this._compileLists(),this.addHandles([i(()=>this.view?.map?.basemap?.baseLayers,e=>this._createItemChangeHandles({items:e,key:c.baseLayers,callback:this._compileBaseList}),a),i(()=>this.view?.map?.basemap?.referenceLayers,e=>this._createItemChangeHandles({items:e,key:c.referenceLayers,callback:this._compileReferenceList}),a),i(()=>this.view?.basemapView?.baseLayerViews,e=>this._createItemChangeHandles({items:e,key:c.baseLayerViews,callback:this._compileBaseList}),a),i(()=>this.view?.basemapView?.referenceLayerViews,e=>this._createItemChangeHandles({items:e,key:c.referenceLayerViews,callback:this._compileReferenceList}),a)],c.basemap)}};e([r({type:d,readOnly:!0})],y.prototype,"baseItems",void 0),e([r()],y.prototype,"basemapTitle",null),e([r()],y.prototype,"baseItemCreatedFunction",void 0),e([r()],y.prototype,"checkPublishStatusEnabled",void 0),e([r({nonNullable:!0})],y.prototype,"listModeDisabled",void 0),e([r()],y.prototype,"referenceItemCreatedFunction",void 0),e([r({type:d,readOnly:!0})],y.prototype,"referenceItems",void 0),e([r({readOnly:!0})],y.prototype,"state",null),e([r()],y.prototype,"totalBaseItems",null),e([r()],y.prototype,"totalReferenceItems",null),e([r()],y.prototype,"view",void 0),y=e([l("esri.layers.list.BasemapItemCollection")],y);const p=y;export{p as default};
+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 n from"./Item.js";import{getItemLayers as o,findLayerListMode as m}from"./support/layerListUtils.js";const c={view:"view",basemap:"basemap",baseLayers:"base-layers",referenceLayers:"reference-layers",baseLayersListMode:"reference-layers-list-mode",referenceLayersListMode:"base-layers-list-mode",baseLayerViews:"base-layer-views",referenceLayerViews:"reference-layer-views",children:"children"},h="hide",d=t.ofType(n);let y=class extends s{constructor(e){super(e),this.baseItemCreatedFunction=null,this.baseItems=new d,this.checkPublishStatusEnabled=!1,this.listModeDisabled=!1,this.referenceItemCreatedFunction=null,this.referenceItems=new d,this.view=null,this._compileBaseList=this._compileBaseList.bind(this),this._compileReferenceList=this._compileReferenceList.bind(this)}initialize(){this.addHandles([i(()=>[this.view?.map?.basemap,!0===this.view?.ready,this.view?.basemapView],()=>this._watchBasemapLayers(),a),i(()=>[this.baseItemCreatedFunction,this.checkPublishStatusEnabled,this.listModeDisabled],()=>this._baseItemCreatedFunctionChanged()),i(()=>[this.referenceItemCreatedFunction,this.checkPublishStatusEnabled,this.listModeDisabled],()=>this._referenceItemCreatedFunctionChanged())],c.view)}destroy(){this.view=null,this._removeAllBaseItems(),this._removeAllReferenceItems()}get basemapTitle(){return this.view?.map?.basemap?.title??null}set basemapTitle(e){this._override("basemapTitle",e)}get state(){return this.view?.ready?"ready":this.view?"loading":"disabled"}get totalBaseItems(){return this.baseItems.flatten(e=>e.children).length}get totalReferenceItems(){return this.referenceItems.flatten(e=>e.children).length}moveItem({targetItem:e,fromParentItem:t,toParentItem:s,from:i,to:a,newIndex:r}){const l=e?.layer;if(!l||"subtype-sublayer"===l.type||"sublayer"===l.type)return;const n=this.view?.map?.basemap,m=n?.baseLayers,c=n?.referenceLayers,h=t?o(t):"base"===i?m:c,d=s?o(s):"base"===a?m:c;if(!h||!d)return;const{baseItems:y,referenceItems:p}=this,b="base"===i?y:p,f="base"===a?y:p,I=t?.children||b,u=s?.children||f,v=d.length-r;e.parent=s||null,I.remove(e),h.remove(l),u.includes(e)||u.add(e,v),d.includes(l)||d.add(l,v),this._compileLists()}triggerAction(e,t){e&&!e.disabled&&this.emit("trigger-action",{action:e,item:t})}_baseItemCreatedFunctionChanged(){this._removeAllBaseItems(),this._compileLists()}_compileBaseList(){const{baseItems:e}=this,t=this.view?.map?.basemap?.baseLayers;this._compileItems({type:"base",layers:t,items:e,key:c.baseLayersListMode,callback:this._compileBaseList})}_compileItems({layers:e,items:t,key:s,type:i,callback:a}){this._watchLayersListMode({layers:e,key:s,callback:a});const r=this._getViewableLayers(e);r?.length?(this._createNewItems({type:i,items:t,layers:r}),this._removeItems({items:t,layers:r}),this._sortItems(t,r)):"base"===i?this._removeAllBaseItems():this._removeAllReferenceItems()}_compileLists(){this._compileReferenceList(),this._compileBaseList()}_compileReferenceList(){const{referenceItems:e}=this,t=this.view?.map?.basemap?.referenceLayers;this._compileItems({type:"reference",layers:t,items:e,key:c.referenceLayersListMode,callback:this._compileReferenceList})}_createItem({layer:e,type:t}){const{view:s,baseItemCreatedFunction:i,referenceItemCreatedFunction:a,checkPublishStatusEnabled:r,listModeDisabled:l}=this;return new n({checkPublishStatusEnabled:r,layer:e,listItemCreatedFunction:"base"===t?i:a,listModeDisabled:l,view:s})}_createItemChangeHandles({items:e,key:t,callback:s}){this.removeHandles(t),s(),e&&this.addHandles(e.on("change",()=>s()),t)}_createNewItems({items:e,layers:t,type:s}){t?.forEach(t=>{e.some(e=>e.layer===t)||e.add(this._createItem({type:s,layer:t}))})}_getViewableLayers(e){return e?this.listModeDisabled?e:e.filter(e=>m(e)!==h):void 0}_referenceItemCreatedFunctionChanged(){this._removeAllReferenceItems(),this._compileLists()}_removeAllBaseItems(){this.baseItems.drain(e=>{this.removeHandles(`${c.children}-${e.uid}`),e.destroy()})}_removeAllReferenceItems(){this.referenceItems.drain(e=>{this.removeHandles(`${c.children}-${e.uid}`),e.destroy()})}_removeItems({items:e,layers:t}){e&&e.forEach(s=>{if(!s)return;const i=t?.some(e=>s.layer===e);i||(this.removeHandles(`${c.children}-${s.uid}`),e.remove(s),s.destroy())})}_sortItems(e,t){e&&t&&e.sort((e,s)=>{const i=t.indexOf(e.layer),a=t.indexOf(s.layer);return i>a?-1:i<a?1:0})}_watchBasemapLayers(){const{view:e}=this;if(this.removeHandles([c.baseLayers,c.referenceLayers,c.basemap,c.baseLayerViews,c.referenceLayerViews]),!e?.ready)return this._removeAllBaseItems(),void this._removeAllReferenceItems();this._compileLists(),this.addHandles([i(()=>this.view?.map?.basemap?.baseLayers,e=>this._createItemChangeHandles({items:e,key:c.baseLayers,callback:this._compileBaseList}),a),i(()=>this.view?.map?.basemap?.referenceLayers,e=>this._createItemChangeHandles({items:e,key:c.referenceLayers,callback:this._compileReferenceList}),a),i(()=>this.view?.basemapView?.baseLayerViews,e=>this._createItemChangeHandles({items:e,key:c.baseLayerViews,callback:this._compileBaseList}),a),i(()=>this.view?.basemapView?.referenceLayerViews,e=>this._createItemChangeHandles({items:e,key:c.referenceLayerViews,callback:this._compileReferenceList}),a)],c.basemap)}_watchLayersListMode({layers:e,key:t,callback:s}){this.removeHandles(t),e&&!this.listModeDisabled&&this.addHandles(i(()=>e.filter(e=>"listMode"in e).map(e=>e.listMode).toArray(),()=>s()),t)}};e([r()],y.prototype,"baseItemCreatedFunction",void 0),e([r({type:d,readOnly:!0})],y.prototype,"baseItems",void 0),e([r()],y.prototype,"basemapTitle",null),e([r()],y.prototype,"checkPublishStatusEnabled",void 0),e([r({nonNullable:!0})],y.prototype,"listModeDisabled",void 0),e([r()],y.prototype,"referenceItemCreatedFunction",void 0),e([r({type:d,readOnly:!0})],y.prototype,"referenceItems",void 0),e([r({readOnly:!0})],y.prototype,"state",null),e([r()],y.prototype,"totalBaseItems",null),e([r()],y.prototype,"totalReferenceItems",null),e([r()],y.prototype,"view",void 0),y=e([l("esri.layers.list.BasemapItemCollection")],y);const p=y;export{p as default};

package/layers/list/CatalogItemCollection.d.ts

@@ -3,41 +3,47 @@ import type CatalogLayer from "../CatalogLayer.js";
 import type Item from "./Item.js";
 import type { EventedAccessor } from "../../core/Evented.js";
 import type { LayerItemCollectionEvents } from "./LayerItemCollection.js";
-import type { Action, ItemModifier, State } from "./types.js";
+import type { Action, ItemModifier, State, ItemProperties } from "./types.js";
 import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
-import type { ItemProperties } from "./Item.js";
 import type { ReadonlyArrayOrCollection } from "../../core/Collection.js";
 
+/** @internal */
 export interface CatalogItemCollectionProperties extends Partial<Pick<CatalogItemCollection, "catalogLayer" | "checkPublishStatusEnabled" | "listItemCreatedFunction" | "listModeDisabled" | "view">> {
   /**
    * The collection of [Items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) representing the
    * catalog layer's dynamic-group layers.
+   *
+   * @internal
    */
   catalogItems?: ReadonlyArrayOrCollection<ItemProperties>;
 }
 
+/** @internal */
 export interface CatalogItemCollectionEvents extends LayerItemCollectionEvents {}
 
 /**
  * Provides list orchestration logic for catalog-layer list workflows.
  *
- * @since 5.2
+ * @internal
  */
 export default class CatalogItemCollection extends EventedAccessor {
-  /**
-   * @deprecated
-   * Do not directly reference this property.
-   * Use EventNames and EventTypes helpers from \@arcgis/core/Evented
-   */
+  /** @internal */
   "@eventTypes": CatalogItemCollectionEvents;
+  /** @internal */
   constructor(properties?: CatalogItemCollectionProperties);
   /**
    * The collection of [Items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) representing the
    * catalog layer's dynamic-group layers.
+   *
+   * @internal
    */
   get catalogItems(): Collection<Item>;
   set catalogItems(value: ReadonlyArrayOrCollection<ItemProperties>);
-  /** The [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) to display in the list. */
+  /**
+   * The [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) to display in the list.
+   *
+   * @internal
+   */
   accessor catalogLayer: CatalogLayer | null | undefined;
   /**
    * Whether to provide an indication if a layer is being published.
@@ -45,14 +51,20 @@ export default class CatalogItemCollection extends EventedAccessor {
    * is `false` if `checkPublishStatusEnabled` is `false`.
    *
    * @default false
+   * @internal
    */
   accessor checkPublishStatusEnabled: boolean;
-  /** A function that executes each time a [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) is created. */
+  /**
+   * A function that executes each time a [Item](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) is created.
+   *
+   * @internal
+   */
   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
+   * @internal
    * @since 5.2
    * @see [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
    */
@@ -61,9 +73,14 @@ export default class CatalogItemCollection extends EventedAccessor {
    * The view model's state.
    *
    * @default "disabled"
+   * @internal
    */
   get state(): State;
-  /** The view context for this view model. */
+  /**
+   * The view context for this view model.
+   *
+   * @internal
+   */
   accessor view: MapViewOrSceneView | null | undefined;
   /**
    * Triggers the `trigger-action` event and executes
@@ -71,6 +88,7 @@ export default class CatalogItemCollection extends EventedAccessor {
    *
    * @param action - The action to execute.
    * @param item - An item associated with the action.
+   * @internal
    */
   triggerAction(action: Action, item: Item): void;
 }

package/layers/list/CatalogItemCollection.js

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

package/layers/list/Item.d.ts

@@ -7,262 +7,206 @@ 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, ItemContent, State } from "./types.js";
+import type { IdentifiableMixin } from "../../core/Identifiable.js";
+import type { Action, ConnectedLayerView, ItemContent, ItemModifier, ItemProperties, ItemVisibilityMode, SpatiallyReferencedLayerView, State, ItemPanelProperties } 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" | "content" | "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" }))>>;
-  /** The child layer, track info, and telemetry display items belonging to this item. */
-  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.
+ * Represents the state of one entry in a layer-list workflow.
  *
- * - `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.
+ * An item can represent a layer, a track-info part, or a video telemetry-display element.
+ * It exposes associated layer and layer-view state, supports nested child items, and stores
+ * action and panel state for consumer UIs.
  *
  * 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.
  *
+ * @beta
  * @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.
+   * Indicates whether the item's action sections are expanded in a consumer UI.
    *
    * @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. */
+  /**
+   * A collection of action sections that can be triggered on the item.
+   * Each section is rendered as a separate group by consumer UIs.
+   */
   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).
+   * When enabled, the item observes the associated layer's publishing status.
    *
    * @default false
-   * @since 5.2
    */
   accessor checkPublishStatusEnabled: boolean;
-  /** The child layer, track info, and telemetry display items belonging to this item. */
+  /**
+   * The child items belonging to this item.
+   * Children can represent nested layers, track-info parts, or telemetry-display elements.
+   */
   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.
+   * Indicates whether the item's child layers can be sorted or moved within their parent collection.
+   * This does not affect track-info or telemetry-display children.
    *
    * @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
+   * The connection status of the associated [StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer/) when its layer view exposes
+   * [StreamLayerView.connectionStatus](https://developers.arcgis.com/javascript/latest/references/core/views/layers/StreamLayerView/#connectionStatus). This status takes precedence over
+   * [updating](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#updating) for stream layers.
    */
   get connectionStatus(): ConnectedLayerView["connectionStatus"] | null | undefined;
-  /**
-   * The content represented by this item.
-   *
-   * @beta
-   * @since 5.2
-   */
+  /** Identifies the content represented by this item: a layer, a track-info part, or a telemetry-display element. */
   accessor content: ItemContent;
-  /** The Error object returned if an error occurred. */
+  /** The error reported while loading the associated layer, if any. */
   get error(): EsriError | null | undefined;
   /**
-   * Whether this list item's details are expanded.
+   * Indicates whether this item's details are expanded in a consumer UI.
    *
    * @default false
    */
   accessor expanded: boolean;
   /**
-   * When `true`, marks this list item as hidden for consumer UIs.
+   * Indicates whether consumer UIs should hide this item.
    *
    * 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.
+   * Indicates whether the associated layer view does not support the current view's spatial reference.
    *
    * @default false
-   * @since 5.2
    */
   get incompatible(): boolean;
-  /** The layer associated with the triggered action. */
+  /** The layer represented by this item. */
   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).
+   * The [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) displaying the associated [layer](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#layer), if available.
+   * Subtype and sublayer items resolve to the layer view of their root layer where applicable.
    */
   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.
+   * A function called when the item is created.
+   * Use the callback to customize supported item properties or add actions and panel state.
+   *
+   * @param event - The event containing the item being created.
+   */
+  accessor listItemCreatedFunction: ItemModifier | null | undefined;
+  /**
+   * Indicates whether to ignore the [Layer.listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property of child layers.
+   * When `true`, child inclusion is 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
+   * Additional panel state associated with this item.
+   * The panel is stored as state and can be rendered by a separate consumer UI.
    */
   get panel(): ItemPanel;
   set panel(value: ItemPanelProperties);
-  /**
-   * The parent of this item
-   *
-   * @since 5.2
-   */
+  /** The parent item, if this item is nested. */
   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
+   * Indicates whether [layer](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/#layer) is being published.
+   * The 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.
+   * Indicates whether this item can be sorted or moved within its parent collection.
+   * Items that represent track-info or telemetry-display content are not sortable.
    *
    * @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
+   * The overall state of this item for consumer UIs.
+   * Returns `disabled` when the item has no layer, is hidden, or is incompatible with the view;
+   * `loading` while the layer or layer view is updating; and `ready` otherwise.
    */
   get state(): State;
-  /** The title of the layer. */
+  /**
+   * The title displayed for this item.
+   * Layer items use the associated layer title, while display items use a consumer-defined title.
+   */
   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.
+   * Indicates whether the layer or its layer view is updating, for example while data is being fetched.
+   * Publishing and stream connection status take precedence over the layer's updating state.
    *
    * @default false
    */
   get updating(): boolean;
-  /** The view context for this list item. */
+  /** The map or scene view that provides context for this item and its layer view. */
   accessor view: MapViewOrSceneView | null | undefined;
-  /** Indicates how to manage the visibility of the children layers. */
+  /** Specifies how visibility is managed for this item's child layers. */
   get visibilityMode(): ItemVisibilityMode;
   /**
-   * Indicates if the Item is visible.
+   * Indicates whether this item is visible.
+   * For layer items, this controls the associated layer. For track-info and telemetry-display items,
+   * it controls the represented display element.
    *
    * @default true
    */
   accessor visible: boolean;
   /**
-   * Whether the layer is visible at the current scale or not.
+   * Indicates whether the associated layer is visible at the current view scale.
    *
    * @default true
    */
   get visibleAtCurrentScale(): boolean;
   /**
-   * Whether the layer is visible at the current time extent or not.
+   * Indicates whether the associated layer is visible at the current time extent.
    *
    * @default true
-   * @since 5.2
    */
   get visibleAtCurrentTimeExtent(): boolean;
   /**
-   * Creates a deep clone of this object.
+   * Creates a deep clone of this item, including its child items and action sections.
    *
    * @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.
+   * Sets or toggles the visibility of the represented content.
+   * For layer items, this updates the associated layer. For track-info and telemetry-display items,
+   * it updates the represented display element.
    *
    * 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;
 }