@arcgis/core 5.2.0-next.61 → 5.2.0-next.63

package/widgets/support/SelectionList/FeatureItem.d.ts

@@ -0,0 +1,116 @@
+import type Graphic from "../../../Graphic.js";
+import type ItemBase from "./ItemBase.js";
+import type LayerItem from "./LayerItem.js";
+import type { ObjectId } from "../../../views/types.js";
+import type { SelectableLayer, SelectionIdentifier } from "../../../views/selection/types.js";
+import type { ItemBaseProperties } from "./ItemBase.js";
+
+/**
+ * Properties used to construct a FeatureItem instance.
+ *
+ * @internal
+ */
+export interface FeatureItemProperties extends ItemBaseProperties, Partial<Pick<FeatureItem, "graphic" | "layerItem" | "thumbnailSize">> {
+  /**
+   * Layer associated with the item.
+   *
+   * @internal
+   */
+  layer?: SelectableLayer;
+}
+
+/**
+ * Required properties used to construct a FeatureItem instance.
+ *
+ * @internal
+ */
+export type RequiredConstructProperties = Pick<FeatureItem, "graphic" | "layerItem">;
+
+/**
+ * An item representing a feature in the selection list.
+ *
+ * @internal
+ */
+export default class FeatureItem extends ItemBase {
+  /** @internal */
+  constructor(properties: FeatureItemProperties);
+  /**
+   * Reference to the feature this item represents.
+   *
+   * @internal
+   */
+  accessor graphic: Graphic;
+  /**
+   * Unique identifier used for this item in the store.
+   *
+   * @internal
+   */
+  get identifier(): SelectionIdentifier;
+  /**
+   * Unique identifier used for this item.
+   *
+   * @internal
+   */
+  get key(): string;
+  /**
+   * Layer associated with the item.
+   *
+   * @internal
+   */
+  accessor layer: SelectableLayer;
+  /**
+   * Reference to the layer item containing this feature item.
+   *
+   * @internal
+   */
+  accessor layerItem: LayerItem;
+  /**
+   * Reference to the object id for the associated feature.
+   * This value may be null or undefined when viewing selections from layers that do not support object ids.
+   * In that case, 'identifier' is typically used to track the selection.
+   *
+   * @internal
+   */
+  get objectId(): ObjectId | null | undefined;
+  /**
+   * Reference to the thumbnail element icon used to represent this feature.
+   *
+   * @internal
+   */
+  get thumbnail(): HTMLElement | null | undefined;
+  /**
+   * Unique identifier for a thumbnail representing the feature. Used by the list to
+   * request a new thumbnail when the 'graphic' property changes to a newer version of the feature,
+   * usually after the associated layer has been edited.
+   *
+   * @internal
+   */
+  get thumbnailKey(): string;
+  /**
+   * Max size of the thumbnail in pixels.
+   *
+   * @default 24
+   * @internal
+   */
+  accessor thumbnailSize: number;
+  /**
+   * Text used in the interface for the item.
+   *
+   * @internal
+   */
+  get title(): string | null | undefined;
+  /**
+   * Indicates the list item is visible and not being filtered.
+   *
+   * @internal
+   */
+  get visible(): boolean;
+  /**
+   * Method used to lazily load the associated feature thumbnail.
+   *
+   * @param options - Optional parameters for fetching the thumbnail.
+   * @returns Promise resolving to the thumbnail element or null if no thumbnail could be generated.
+   * @internal
+   */
+  fetchThumbnail(options?: { ariaLabel?: string; }): Promise<HTMLElement | null | undefined>;
+}

package/widgets/support/SelectionList/GroupLayerItem.d.ts

@@ -0,0 +1,94 @@
+import type Layer from "../../../layers/Layer.js";
+import type SubtypeSublayer from "../../../layers/support/SubtypeSublayer.js";
+import type ItemBase from "./ItemBase.js";
+import type { ItemBaseProperties } from "./ItemBase.js";
+import type { ParentItem, SelectionListParentLayer, SyncOptions } from "./types.js";
+
+/**
+ * Properties used to construct a GroupLayerItem instance.
+ *
+ * @internal
+ */
+export interface GroupLayerItemProperties extends ItemBaseProperties, Partial<Pick<GroupLayerItem, "items">> {
+  /**
+   * Layer containing the sublayer that contains the selected features.
+   *
+   * @internal
+   */
+  layer?: SelectionListParentLayer;
+}
+
+/**
+ * Required properties used to construct a GroupLayerItem instance.
+ *
+ * @internal
+ */
+export type RequiredConstructProperties = Pick<GroupLayerItem, "layer">;
+
+/**
+ * An item representing a group layer in the selection list.
+ *
+ * @internal
+ */
+export default class GroupLayerItem extends ItemBase {
+  /** @internal */
+  constructor(properties: GroupLayerItemProperties);
+  /**
+   * Set of child layer items. Can also be another GroupLayerItem in the case of SubtypeGroupLayer or KnowledgeGraphLayer.
+   *
+   * @internal
+   */
+  accessor items: ParentItem[];
+  /**
+   * Layer containing the sublayer that contains the selected features.
+   *
+   * @internal
+   */
+  accessor layer: SelectionListParentLayer;
+  /**
+   * Convenience property for all child layers and tables on the parent group layer.
+   *
+   * @internal
+   */
+  get layers(): Layer[] | SubtypeSublayer[];
+  /**
+   * Indicates this group item contains at least one layer item that is displaying a
+   * subset of selected features due to an upper maximum limit.
+   *
+   * @internal
+   */
+  get maxVisibleFeatureCountExceeded(): boolean;
+  /**
+   * Count representing the number of selected features. This value includes features hidden by
+   * local filters, but are still selected according to the associated selection manager.
+   *
+   * @internal
+   */
+  get total(): number;
+  /**
+   * Indicates this item is visible in the list, due to one or more child items being visible.
+   *
+   * @internal
+   */
+  get visible(): boolean;
+  /**
+   * Total number of visible features accounting for any filters, and 'maxVisibleFeatureCountPerLayer'.
+   *
+   * @internal
+   */
+  get visibleTotal(): number;
+  /**
+   * Empties current feature item caches on child layer items.
+   *
+   * @internal
+   */
+  reset(): void;
+  /**
+   * Method used to load or resync relevant item data.
+   *
+   * @param options - Options used to control the sync operation.
+   * @returns Promise resolving when the sync operation is complete.
+   * @internal
+   */
+  sync(options: SyncOptions): Promise<void>;
+}

package/widgets/support/SelectionList/ItemBase.d.ts

@@ -0,0 +1,70 @@
+import type Accessor from "../../../core/Accessor.js";
+import type SelectionListViewModel from "./SelectionListViewModel.js";
+import type { Icon } from "@esri/calcite-components/components/calcite-icon";
+import type { SelectableLayer, SelectableLayerView, SelectableViewUnion } from "../../../views/selection/types.js";
+import type { SelectionListParentLayer } from "./types.js";
+
+/**
+ * Properties used to construct an ItemBase instance.
+ *
+ * @internal
+ */
+export interface ItemBaseProperties extends Partial<Pick<ItemBase, "layer" | "viewModel">> {}
+
+/**
+ * Base class for selection list items.
+ *
+ * @internal
+ */
+export default class ItemBase extends Accessor {
+  /** @internal */
+  constructor(properties: ItemBaseProperties);
+  /**
+   * Icon used to represent the item.
+   *
+   * @internal
+   */
+  get iconName(): Icon["icon"];
+  /**
+   * Unique identifier used for the item.
+   *
+   * @internal
+   */
+  get key(): string;
+  /**
+   * Layer associated with the item.
+   *
+   * @internal
+   */
+  accessor layer: SelectableLayer | SelectionListParentLayer;
+  /**
+   * Indicates the layer and its selected features are visible on the map.
+   *
+   * @internal
+   */
+  get layerIsVisible(): boolean;
+  /**
+   * Companion layer view of the associated layer.
+   *
+   * @internal
+   */
+  get layerView(): SelectableLayerView | null | undefined;
+  /**
+   * Text used in the interface for the item.
+   *
+   * @internal
+   */
+  get title(): string | null | undefined;
+  /**
+   * Convenience property for the view associated with the view model.
+   *
+   * @internal
+   */
+  get view(): SelectableViewUnion | null | undefined;
+  /**
+   * Used to look up information about the selections.
+   *
+   * @internal
+   */
+  accessor viewModel: SelectionListViewModel;
+}

package/widgets/support/SelectionList/LayerItem.d.ts

@@ -0,0 +1,140 @@
+import type FeatureItem from "./FeatureItem.js";
+import type GroupLayerItem from "./GroupLayerItem.js";
+import type ItemBase from "./ItemBase.js";
+import type { ObjectId } from "../../../views/types.js";
+import type { SelectableLayer, SelectionIdentifier } from "../../../views/selection/types.js";
+import type { ItemBaseProperties } from "./ItemBase.js";
+import type { SyncOptions } from "./types.js";
+
+/** @internal */
+export interface LayerItemProperties extends ItemBaseProperties, Partial<Pick<LayerItem, "featureItems" | "groupLayerItem">> {
+  /**
+   * Companion layer view of the associated layer.
+   *
+   * @internal
+   */
+  layer?: SelectableLayer;
+}
+
+/** @internal */
+export type RequiredConstructProperties = Pick<LayerItem, "groupLayerItem">;
+
+/**
+ * An item representing a layer in the selection list.
+ *
+ * @internal
+ */
+export default class LayerItem extends ItemBase {
+  /** @internal */
+  constructor(properties: LayerItemProperties);
+  /**
+   * Set of object Ids for selected features. Includes filtered features
+   *
+   * @internal
+   */
+  get effectiveObjectIds(): ObjectId[];
+  /**
+   * The effective selection for this layer item, which is a subset of the full selection based on the
+   * value of 'maxVisibleFeatureCountPerLayer'.
+   *
+   * @internal
+   */
+  get effectiveSelection(): SelectionIdentifier[];
+  /**
+   * Set of items representing individual selected features. This will only contain a maximum number of
+   * features based on the value of 'maxVisibleFeatureCountExceeded'.
+   *
+   * @internal
+   */
+  accessor featureItems: FeatureItem[];
+  /**
+   * Reference to the parent GroupLayerItem, if one exists.
+   *
+   * @internal
+   */
+  accessor groupLayerItem: GroupLayerItem | null | undefined;
+  /**
+   * Companion layer view of the associated layer.
+   *
+   * @internal
+   */
+  accessor layer: SelectableLayer;
+  /**
+   * Indicates the list is only showing a subset of selected feature items managed
+   * by this particular layer item, due to the selection being greater than the current
+   * value of the 'maxVisibleFeatureCountPerLayer' property. This value also accounts for
+   * any active filter, meaning this value will be false when a filter is applied and some
+   * items have been hidden.
+   *
+   * @internal
+   */
+  get maxVisibleFeatureCountExceeded(): boolean;
+  /**
+   * Maximum number of selected features visible for each layer item.
+   * This does not prevent selection or affect bulk actions on the
+   * selection set.
+   *
+   * @internal
+   */
+  get maxVisibleFeatureCountPerLayer(): number;
+  /**
+   * Array of selected features represented by their object Ids.
+   *
+   * @internal
+   */
+  get objectIds(): ObjectId[];
+  /**
+   * Array of selected features.
+   *
+   * @internal
+   */
+  get selection(): SelectionIdentifier[];
+  /**
+   * Count representing the number of selected features. This value includes features hidden by
+   * local filters, but are still selected according to the associated selection manager.
+   *
+   * @internal
+   */
+  get total(): number;
+  /**
+   * Indicates this item is visible in the list, due to one or more child items being visible.
+   *
+   * @internal
+   */
+  get visible(): boolean;
+  /**
+   * Total number of visible features accounting for any filters, and 'maxVisibleFeatureCountPerLayer'.
+   *
+   * @internal
+   */
+  get visibleTotal(): number;
+  /**
+   * Cancels any active operation.
+   *
+   * @internal
+   */
+  cancel(): void;
+  /**
+   * Empties current feature item cache.
+   *
+   * @internal
+   */
+  reset(): void;
+  /**
+   * Method used to load or resync relevant item data.
+   *
+   * @param options - Options used to control the sync operation.
+   * @returns Promise resolving when the sync operation is complete.
+   * @internal
+   */
+  sync(options: SyncOptions): Promise<void>;
+  /**
+   * Method used to fetch up-to-date titles for all feature items.
+   * Syncs titles for all feature items if no parameter is provided.
+   *
+   * @param items - Optional array of feature items to sync titles for. If not provided, all feature items will be synced.
+   * @returns Promise resolving when the title sync operation is complete.
+   * @internal
+   */
+  syncTitles(items?: FeatureItem[]): Promise<void>;
+}

package/widgets/support/SelectionList/LayerItem.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{__decorate as e}from"tslib";import{countIf as t,addMany as r,isSome as s}from"../../../core/arrayUtils.js";import i from"../../../core/ReactiveMap.js";import{property as o,subclass as a}from"../../../core/accessorSupport/decorators.js";import{getDisplayFieldNameFromFields as l}from"../../../layers/support/fieldUtils.js";import{isSelectableLayerWithObjectIds as n,isSelectableLayerViewWithObjectIds as c}from"../../../views/support/selectionUtils.js";import u from"./FeatureItem.js";import p from"./ItemBase.js";import{getSuggestedQueryOutFields as f}from"../Selector2D/selectorUtils.js";let m=class extends p{constructor(e){super(e),this._onChangeController=null,this.featureItems=[],this.featureTitleMap=new i,this.groupLayerItem=null,this.layer=null}get effectiveObjectIds(){return this.objectIds.slice(0,this.maxVisibleFeatureCountPerLayer)}get effectiveSelection(){return this.selection.slice(0,this.maxVisibleFeatureCountPerLayer)}get maxVisibleFeatureCountExceeded(){const{viewModel:e}=this;return this.selection.length>e.maxVisibleFeatureCountPerLayer&&this.visibleTotal===e.maxVisibleFeatureCountPerLayer}get maxVisibleFeatureCountPerLayer(){return this.viewModel.maxVisibleFeatureCountPerLayer}get objectIds(){const e=this.layer;return n(e)?this.selection:[]}get selection(){return this.viewModel.effectiveSelectionManager?.getSelection(this.layer)??[]}get total(){return this.selection.length}get visible(){return this.featureItems.some(e=>e.visible)}get visibleTotal(){return t(this.featureItems,e=>e.visible)}cancel(){this._onChangeController?.abort()}reset(){this.featureItems.forEach(e=>e.destroy()),this.featureItems=[]}async sync({controller:e,promises:t}){const{effectiveSelection:i,layer:o}=this;this.cancel();const a=new Map(this.featureItems.map(e=>[e.identifier,e])),l=new Map,c=[],u=[];for(const r of i){const e=a.get(r);e?l.set(r,e):(c.push(r),l.set(r,null))}if(this._onChangeController=e,c.length>0){n(o)?r(u,await this._createFeatureItemsFromIds(o,c,e)):r(u,this._createFeatureItemsFromGraphics(c));for(const e of u)null!=e.identifier&&l.set(e.identifier,e)}e.signal.aborted||(this.featureItems=Array.from(l.values()).filter(s),t.push(this.syncTitles(u)))}async syncTitles(e=this.featureItems){const{layer:t}=this,r=e.map(e=>e.graphic);if("getFeatureTitles"in t&&t.getFeatureTitles){(await t.getFeatureTitles(r,{fetchMissingFields:!0,removeHTML:!0})).forEach((e,t)=>this.featureTitleMap.set(t,e))}else if(n(t)){const e=t.displayField||l(t.fields);e&&r.forEach(t=>{const r=t.getObjectId(),s=t.attributes[e];null!=r&&s&&this.featureTitleMap.set(r,s)})}}_createFeatureItemsFromGraphics(e){const{layer:t,viewModel:r}=this;return e.map(e=>new u({graphic:e,layer:t,layerItem:this,viewModel:r}))}async _createFeatureItemsFromIds(e,t,r){const{layerView:s,viewModel:i}=this,o=new Map;if(c(s)){const e=s.createQuery();e.objectIds=t,e.outFields=["*"],e.returnGeometry=!0;const i=await s.queryFeatures(e,r);for(const t of i.features){const e=t.getObjectId();null!=e&&o.set(e,t)}}if(r.signal.aborted)return[];const a=t.filter(e=>!o.has(e));if(a.length){const{view:t}=this,s=e.createQuery();s.objectIds=a,s.outSpatialReference=t?.spatialReference,s.outFields=t?f(e,t,!0):["*"],s.returnGeometry=!0;const i=await e.queryFeatures(s,r);for(const e of i.features){const t=e.getObjectId();null!=t&&o.set(t,e)}}return Array.from(o.values()).map(t=>new u({graphic:t,layer:e,layerItem:this,viewModel:i}))}};e([o()],m.prototype,"_onChangeController",void 0),e([o()],m.prototype,"effectiveObjectIds",null),e([o()],m.prototype,"effectiveSelection",null),e([o()],m.prototype,"featureItems",void 0),e([o()],m.prototype,"featureTitleMap",void 0),e([o()],m.prototype,"groupLayerItem",void 0),e([o()],m.prototype,"layer",void 0),e([o()],m.prototype,"maxVisibleFeatureCountExceeded",null),e([o()],m.prototype,"maxVisibleFeatureCountPerLayer",null),e([o()],m.prototype,"objectIds",null),e([o()],m.prototype,"selection",null),e([o()],m.prototype,"total",null),e([o()],m.prototype,"visible",null),e([o()],m.prototype,"visibleTotal",null),m=e([a("esri.widgets.support.SelectionList.LayerItem")],m);const h=m;export{h as default};
+import{__decorate as e}from"tslib";import{countIf as t,addMany as r,isSome as s}from"../../../core/arrayUtils.js";import i from"../../../core/ReactiveMap.js";import{property as o,subclass as a}from"../../../core/accessorSupport/decorators.js";import{getDisplayFieldNameFromFields as l}from"../../../layers/support/fieldUtils.js";import{isSelectableLayerWithObjectIds as n,isSelectableLayerViewWithObjectIds as c}from"../../../views/support/selectionUtils.js";import u from"./FeatureItem.js";import p from"./ItemBase.js";import{getSuggestedQueryOutFields as f}from"../Selector2D/selectorUtils.js";let m=class extends p{constructor(e){super(e),this._onChangeController=null,this.featureItems=[],this.featureTitleMap=new i,this.groupLayerItem=null,this.layer=null}get effectiveObjectIds(){return this.objectIds.slice(0,this.maxVisibleFeatureCountPerLayer)}get effectiveSelection(){return this.selection.slice(0,this.maxVisibleFeatureCountPerLayer)}get maxVisibleFeatureCountExceeded(){const{viewModel:e}=this;return this.selection.length>e.maxVisibleFeatureCountPerLayer&&this.visibleTotal===e.maxVisibleFeatureCountPerLayer}get maxVisibleFeatureCountPerLayer(){return this.viewModel.maxVisibleFeatureCountPerLayer}get objectIds(){const e=this.layer;return n(e)?this.selection:[]}get selection(){return this.viewModel.effectiveSelectionManager?.getSelection(this.layer)??[]}get total(){return this.selection.length}get visible(){return this.featureItems.some(e=>e.visible)}get visibleTotal(){return t(this.featureItems,e=>e.visible)}cancel(){this._onChangeController?.abort()}reset(){this.featureItems.forEach(e=>e.destroy()),this.featureItems=[]}async sync({controller:e,promises:t}){const{effectiveSelection:i,layer:o}=this;this.cancel();const a=new Map(this.featureItems.map(e=>[e.identifier,e])),l=new Map,c=[],u=[];for(const r of i){const e=a.get(r);e?l.set(r,e):(c.push(r),l.set(r,null))}if(this._onChangeController=e,c.length>0){n(o)?r(u,await this._createFeatureItemsFromIds(o,c,e)):r(u,this._createFeatureItemsFromGraphics(c));for(const e of u)null!=e.identifier&&l.set(e.identifier,e)}e.signal.aborted||(this.featureItems=Array.from(l.values()).filter(s),t.push(this.syncTitles(u)))}async syncTitles(e){const{layer:t}=this,r=(e??this.featureItems).map(e=>e.graphic);if("getFeatureTitles"in t&&t.getFeatureTitles){(await t.getFeatureTitles(r,{fetchMissingFields:!0,removeHTML:!0})).forEach((e,t)=>this.featureTitleMap.set(t,e))}else if(n(t)){const e=t.displayField||l(t.fields);e&&r.forEach(t=>{const r=t.getObjectId(),s=t.attributes[e];null!=r&&s&&this.featureTitleMap.set(r,s)})}}_createFeatureItemsFromGraphics(e){const{layer:t,viewModel:r}=this;return e.map(e=>new u({graphic:e,layer:t,layerItem:this,viewModel:r}))}async _createFeatureItemsFromIds(e,t,r){const{layerView:s,viewModel:i}=this,o=new Map;if(c(s)){const e=s.createQuery();e.objectIds=t,e.outFields=["*"],e.returnGeometry=!0;const i=await s.queryFeatures(e,r);for(const t of i.features){const e=t.getObjectId();null!=e&&o.set(e,t)}}if(r.signal.aborted)return[];const a=t.filter(e=>!o.has(e));if(a.length){const{view:t}=this,s=e.createQuery();s.objectIds=a,s.outSpatialReference=t?.spatialReference,s.outFields=t?f(e,t,!0):["*"],s.returnGeometry=!0;const i=await e.queryFeatures(s,r);for(const e of i.features){const t=e.getObjectId();null!=t&&o.set(t,e)}}return Array.from(o.values()).map(t=>new u({graphic:t,layer:e,layerItem:this,viewModel:i}))}};e([o()],m.prototype,"_onChangeController",void 0),e([o()],m.prototype,"effectiveObjectIds",null),e([o()],m.prototype,"effectiveSelection",null),e([o()],m.prototype,"featureItems",void 0),e([o()],m.prototype,"featureTitleMap",void 0),e([o()],m.prototype,"groupLayerItem",void 0),e([o()],m.prototype,"layer",void 0),e([o()],m.prototype,"maxVisibleFeatureCountExceeded",null),e([o()],m.prototype,"maxVisibleFeatureCountPerLayer",null),e([o()],m.prototype,"objectIds",null),e([o()],m.prototype,"selection",null),e([o()],m.prototype,"total",null),e([o()],m.prototype,"visible",null),e([o()],m.prototype,"visibleTotal",null),m=e([a("esri.widgets.support.SelectionList.LayerItem")],m);const h=m;export{h as default};