@arcgis/core 5.0.0-next.70 → 5.0.0-next.72

package/widgets/FeatureTable/support/types.d.ts

@@ -24,29 +24,65 @@ import type { FieldValue } from "../../../layers/support/fieldUtils.js";
 import type { ObjectId } from "../../../views/types.js";
 import type { CellValue, Direction } from "../Grid/types.js";
 
+/** @since 5.0 */
 export interface FieldValueFormatFunctionParameters extends FormatFunctionParameters {}
 
+/** @since 5.0 */
 export interface FormatFunctionParameters {
-  /** _(Since 4.31)_ A reference to attachments for the associated feature. */
+  /**
+   * _(Since 4.31)_ A reference to attachments for the associated feature.
+   *
+   * @since 5.0
+   */
   attachments?: AttachmentInfo[] | null;
-  /** A reference to this specific Column. */
+  /**
+   * A reference to this specific Column.
+   *
+   * @since 5.0
+   */
   column: Column;
-  /** A reference to the feature represented by the associated row. */
+  /**
+   * A reference to the feature represented by the associated row.
+   *
+   * @since 5.0
+   */
   feature: Graphic;
-  /** The field associated with the column. */
+  /**
+   * The field associated with the column.
+   *
+   * @since 5.0
+   */
   field?: Field | null;
-  /** Index of the associated row being rendered. */
+  /**
+   * Index of the associated row being rendered.
+   *
+   * @since 5.0
+   */
   index: number;
-  /** _(Since 4.31)_ A reference to related records for the associated feature. */
+  /**
+   * _(Since 4.31)_ A reference to related records for the associated feature.
+   *
+   * @since 5.0
+   */
   relatedRecords?: RelatedRecordInfo[] | null;
-  /** Current projected value of the cell. */
+  /**
+   * Current projected value of the cell.
+   *
+   * @since 5.0
+   */
   value: CellValue;
-  /** _(Since 4.31)_ Virtual index of the associated row being rendered. Unlike `index`, a row's `virtualIndex` changes as the table scrolls. The first row in the DOM has a `virtualIndex` of 0. As rows are added/removed from the DOM, the virtual index adjusts before it renders. This can help with performance when rendering large datasets. */
+  /**
+   * _(Since 4.31)_ Virtual index of the associated row being rendered. Unlike `index`, a row's `virtualIndex` changes as the table scrolls. The first row in the DOM has a `virtualIndex` of 0. As rows are added/removed from the DOM, the virtual index adjusts before it renders. This can help with performance when rendering large datasets.
+   *
+   * @since 5.0
+   */
   virtualIndex: number;
 }
 
+/** @since 5.0 */
 export type FeatureTableSupportedLayer = CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | OrientedImageryLayer | ParquetLayer | Sublayer;
 
+/** @since 5.0 */
 export type FeatureTableSupportedColumn = Column;
 
 /**
@@ -54,6 +90,7 @@ export type FeatureTableSupportedColumn = Column;
  *
  * @param params - An object containing information about the associated row and feature.
  * @returns Formatted content to be displayed in the cell.
+ * @since 5.0
  */
 export type FormatFunction = (params: FormatFunctionParameters) => CellValue | HTMLElement;
 
@@ -62,46 +99,72 @@ export type FormatFunction = (params: FormatFunctionParameters) => CellValue | H
  *
  * @param params - An object containing information about the associated row and feature.
  * @returns Formatted content to be displayed in the cell.
+ * @since 5.0
  */
 export type FieldValueFormatFunction = (params: FieldValueFormatFunctionParameters) => FieldValue | HTMLElement;
 
+/** @since 5.0 */
 export type FeatureTableSupportedFilters = GeometryFilter | SelectionFilter;
 
 /**
  * Use this for spatial filtering, it is the [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) used to filter out data within the table.
  *
+ * @since 5.0
  * @see [FeatureTableViewModel#filterGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterGeometry)
  * @see [FeatureTableViewModel#activeFilters](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#activeFilters)
  * @see [Sample - FeatureTable using a map](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-map/)
  */
 export interface GeometryFilter extends TableFilter {
-  /** The geometry used to filter out the table's data. */
+  /**
+   * The geometry used to filter out the table's data.
+   *
+   * @since 5.0
+   */
   geometry: GeometryUnion;
-  /** The type of the filter used. This will always read as `"geometry"`. */
+  /**
+   * The type of the filter used. This will always read as `"geometry"`.
+   *
+   * @since 5.0
+   */
   type: "geometry";
 }
 
 /**
  * Use this for selecting rows within the table based off of their object ID.
  *
+ * @since 5.0
  * @see [FeatureTableViewModel#filterBySelection()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelection)
  * @see [FeatureTableViewModel#activeFilters](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#activeFilters)
  */
 export interface SelectionFilter extends TableFilter {
-  /** An array of numbers indicating the row's object IDs. */
+  /**
+   * An array of numbers indicating the row's object IDs.
+   *
+   * @since 5.0
+   */
   objectIds: ObjectId[];
-  /** The type of the filter used. This will always read as `"selection"`. */
+  /**
+   * The type of the filter used. This will always read as `"selection"`.
+   *
+   * @since 5.0
+   */
   type: "selection";
 }
 
+/** @since 5.0 */
 export interface TableFilter {
-  /** The type of the filter used. */
+  /**
+   * The type of the filter used.
+   *
+   * @since 5.0
+   */
   type: string;
 }
 
 /**
  * An array of objects containing a column's name and sort direction. This is used in conjunction with [FeatureTableViewModel#activeSortOrders](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#activeSortOrders) to help retain a column's sort order while querying.
  *
+ * @since 5.0
  * @see [FeatureTableViewModel#activeSortOrders](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#activeSortOrders)
  */
 export interface ColumnSortOrder {
@@ -113,18 +176,37 @@ export interface ColumnSortOrder {
    * asc | Sorts the column in ascending order.
    * desc | Sorts the column in descending order.
    * null | No sort is applied to the column.
+   *
+   * @since 5.0
    */
   direction: Direction;
-  /** The field name as defined by the layer. Set this property to indicate which column to sort. This should match the field name as defined at the feature service level. */
+  /**
+   * The field name as defined by the layer. Set this property to indicate which column to sort. This should match the field name as defined at the feature service level.
+   *
+   * @since 5.0
+   */
   fieldName: string;
 }
 
+/** @since 5.0 */
 export interface ActionColumnCallbackParameters {
-  /** A reference to the associated feature. */
+  /**
+   * A reference to the associated feature.
+   *
+   * @since 5.0
+   */
   feature: Graphic;
-  /** The index of the associated row. */
+  /**
+   * The index of the associated row.
+   *
+   * @since 5.0
+   */
   index: number;
-  /** A reference to the interaction event. */
+  /**
+   * A reference to the interaction event.
+   *
+   * @since 5.0
+   */
   native: MouseEvent | KeyboardEvent;
 }
 
@@ -132,12 +214,14 @@ export interface ActionColumnCallbackParameters {
  * Function called when an action is clicked or pressed.
  *
  * @param params - An object containing information about the associated row and feature.
+ * @since 5.0
  */
 export type ActionColumnCallback = (params: ActionColumnCallbackParameters) => void;
 
 /**
  * Configuration for the [FeatureTable's actionColumn](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#actionColumn).
  *
+ * @since 5.0
  * @example
  * // The following snippet demonstrates how to configure an action column that adds a button to each row which allows the user to zoom to the associated row's feature within the view.
  * featureTable.viewModel.actionColumnConfig = {
@@ -149,22 +233,51 @@ export type ActionColumnCallback = (params: ActionColumnCallbackParameters) => v
  * }
  */
 export interface ActionColumnConfig {
-  /** Callback function invoked when the action is clicked or activated via the keyboard. */
+  /**
+   * Callback function invoked when the action is clicked or activated via the keyboard.
+   *
+   * @since 5.0
+   */
   callback: ActionColumnCallback;
-  /** Indicates if a specific action should be conditionally disabled. */
+  /**
+   * Indicates if a specific action should be conditionally disabled.
+   *
+   * @since 5.0
+   */
   disabled?: ActionColumnDisabledFunction | boolean;
-  /** Indicates the column should be frozen to the end of the table. */
+  /**
+   * Indicates the column should be frozen to the end of the table.
+   *
+   * @since 5.0
+   */
   frozenToEnd?: boolean;
-  /** The string value indicating the [Calcite icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed for the action. */
+  /**
+   * The string value indicating the [Calcite icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed for the action.
+   *
+   * @since 5.0
+   */
   icon?: Icon["icon"];
-  /** The accessible label to display when hovering over the action. */
+  /**
+   * The accessible label to display when hovering over the action.
+   *
+   * @since 5.0
+   */
   label: string;
 }
 
+/** @since 5.0 */
 export interface ActionColumnDisabledParameters {
-  /** The feature to use when determining if the action should be disabled. */
+  /**
+   * The feature to use when determining if the action should be disabled.
+   *
+   * @since 5.0
+   */
   feature: Graphic;
-  /** The row's index position when determining if the action should be disabled. */
+  /**
+   * The row's index position when determining if the action should be disabled.
+   *
+   * @since 5.0
+   */
   index: number;
 }
 
@@ -173,17 +286,32 @@ export interface ActionColumnDisabledParameters {
  *
  * @param params - An object containing information about an associated row and feature.
  * @returns Indicates whether the action should be disabled.
+ * @since 5.0
  */
 export type ActionColumnDisabledFunction = (params: ActionColumnDisabledParameters) => boolean;
 
-/** The related records for the associated feature used in the [Columns's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html#formatFunction) and [FieldColumn's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-types.html#FieldValueFormatFunction) `formatFunction`. */
+/**
+ * The related records for the associated feature used in the [Columns's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html#formatFunction) and [FieldColumn's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-types.html#FieldValueFormatFunction) `formatFunction`.
+ *
+ * @since 5.0
+ */
 export interface RelatedRecordInfo {
-  /** The number of related records associated with the feature. */
+  /**
+   * The number of related records associated with the feature.
+   *
+   * @since 5.0
+   */
   count: number;
-  /** The ID of the relationship defined in the data source. */
+  /**
+   * The ID of the relationship defined in the data source.
+   *
+   * @since 5.0
+   */
   relationshipId: number;
 }
 
+/** @since 5.0 */
 export type SupportedColumnTemplates = ColumnTemplate | FieldColumnTemplate | GroupColumnTemplate | AttachmentsColumnTemplate | RelationshipColumnTemplate;
 
+/** @since 5.0 */
 export type GroupColumnSupportedTemplates = Exclude<SupportedColumnTemplates, GroupColumnTemplate>;

package/widgets/FeatureTable.d.ts

@@ -414,7 +414,7 @@ export interface FeatureTableEvents extends FeatureTableViewModelEvents {}
  * ```
  * ![featuretable-rowHighlightIds](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/rowhighlightids.png)
  *
- * Additionally, selection and highlight behavior can be enhanced using the feature table's [events](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#FeatureTableEvents). These events are designed to listen for cell interaction and include: [@cell-click](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#event-cell-click), {@link widgets/FeatureTable#event-cell-keyDown}, [@cell-pointerout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#event-cell-pointerout), and [@cell-pointerover](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#event-cell-pointerover). The latter two events are especially useful for tasks such as highlighting a feature in the view while hovering over a cell, all doing so without requiring the end-user to select the row. For example, these events can be used to display cell information in a tooltip that is attached to the mouse cursor.
+ * Additionally, selection and highlight behavior can be enhanced using the feature table's [events](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#FeatureTableEvents). These events are designed to listen for cell interaction and include: [@cell-click](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#event-cell-click), [@cell-keydown](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#event-cell-keydown), [@cell-pointerout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#event-cell-pointerout), and [@cell-pointerover](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#event-cell-pointerover). The latter two events are especially useful for tasks such as highlighting a feature in the view while hovering over a cell, all doing so without requiring the end-user to select the row. For example, these events can be used to display cell information in a tooltip that is attached to the mouse cursor.
  *
  * > In short, the [highlightIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightIds) property is used to control and synchronize selections between the FeatureTable and other components of the SDK, whereas [rowHighlightIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#rowHighlightIds) is for adding a highlight to some rows, based on some other interaction within the application. It allows the ability to select specific rows based on actions performed in the application, such as hovering over a feature on the map or applying a filter through another widget.
  *
@@ -432,7 +432,7 @@ export interface FeatureTableEvents extends FeatureTableViewModelEvents {}
  * * **Filtering by time**- To achieve this, configure the [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeExtent) property to a time extent. Once configured, the table will exclusively show rows corresponding to features that are within the defined time extent.
  * **Filtering by selection and geometry**- This is accomplished by setting both the [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#objectIds) and [filterGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#filterGeometry) properties. When set, the table will only display rows for features that match the corresponding object ID and and intersect the geometry.
  *
- * It is possible to control sort order individually per column or on multiple columns. The latter is accomplished by setting the [multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) property to `true`. When set, the table will allow sorting on multiple columns. The table's [sortColumn()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#sortColumn) method is used to sort columns. This method takes the field name and sort order as parameters. The sort order can be set to either `asc` or `desc`. The priority of columns and their sort order can be set using {@link widgets/support/FieldColumnTemplate#initialSortPriority}. This property is used to set the initial sort priority for a column.
+ * It is possible to control sort order individually per column or on multiple columns. The latter is accomplished by setting the [multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) property to `true`. When set, the table will allow sorting on multiple columns. The table's [sortColumn()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#sortColumn) method is used to sort columns. This method takes the field name and sort order as parameters. The sort order can be set to either `asc` or `desc`. The priority of columns and their sort order can be set using [FieldColumnTemplate#initialSortPriority](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#initialSortPriority). This property is used to set the initial sort priority for a column.
  *
  * > [!WARNING]
  * >
@@ -721,7 +721,7 @@ export default class FeatureTable extends Widget<FeatureTableProperties> {
    */
   get activeFilters(): Collection<FeatureTableSupportedFilters>;
   /**
-   * Use this read-only property if needing to query features while retaining a column's sort order. It returns an array of [ColumnSortOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-types.html#ColumnSortOrder) which contains a column's name and its sort direction. The sort priority is honored in the returned [ColumnSortOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-types.html#ColumnSortOrder) if [multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) is `true` with a set {@link widgets/FeatureTable#initialSortPriority}.
+   * Use this read-only property if needing to query features while retaining a column's sort order. It returns an array of [ColumnSortOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-types.html#ColumnSortOrder) which contains a column's name and its sort direction. The sort priority is honored in the returned [ColumnSortOrder](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-types.html#ColumnSortOrder) if [multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) is `true` with a set [FieldColumnTemplate#initialSortPriority](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#initialSortPriority).
    *
    * @default []
    * @since 4.25

package/widgets/FeatureTemplates/VisibleElements.d.ts

@@ -1,16 +1,20 @@
 import type Accessor from "../../core/Accessor.js";
 
+/** @since 5.0 */
 export interface VisibleElementsProperties extends Partial<Pick<VisibleElements, "filter">> {}
 
 /**
  * The visible elements that are displayed within the widget.
  * This provides the ability to turn individual elements of the widget's display on/off.
+ *
+ * @since 5.0
  */
 export default abstract class VisibleElements extends Accessor {
   /**
    * Indicates whether the [templates filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#visibleElements) displays.
    *
    * @default true
+   * @since 5.0
    */
   accessor filter: boolean;
 }

package/widgets/FeatureTemplates/types.d.ts

@@ -11,6 +11,7 @@ import type { LayerWithFeatureTemplatesUnion } from "../../layers/types.js";
  * @returns Groups consist of a group `key` and `label`. These are shown in the UI. If both
  * the `key` and `label` are identical, return a `string`. Otherwise, return an `object` with
  * `key/name` properties. This gives finer control of the groups.
+ * @since 5.0
  * @example
  * // This example shows using a function to check if
  * // the layer title contains the word 'military'. If so,
@@ -51,13 +52,23 @@ import type { LayerWithFeatureTemplatesUnion } from "../../layers/types.js";
  */
 export type GroupByFunction<T = any> = (grouping: GroupByFunctionGrouping) => object;
 
+/** @since 5.0 */
 export interface GroupByFunctionGrouping {
-  /** [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) instance referenced in [FeatureTemplates#layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#layers) property. */
+  /**
+   * [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) instance referenced in [FeatureTemplates#layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#layers) property.
+   *
+   * @since 5.0
+   */
   layer: LayerWithFeatureTemplatesUnion;
-  /** [FeatureTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) associated with the `layer`. */
+  /**
+   * [FeatureTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) associated with the `layer`.
+   *
+   * @since 5.0
+   */
   template: AnyEditingTemplateInfo;
 }
 
+/** @since 5.0 */
 export type GroupByType = "none" | "layer" | "geometry" | GroupByFunction;
 
 /**
@@ -70,6 +81,7 @@ export type GroupByType = "none" | "layer" | "geometry" | GroupByFunction;
  * @returns Function is a predicate, to test each element of the array.
  * Return `true` to keep [item](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) in the template widget, otherwise, `false`
  * to remove it.
+ * @since 5.0
  * @example
  * // Filter and display templates only if their labels contain the word `Street`
  * function myFilterFunction(filter) {
@@ -89,10 +101,13 @@ export type GroupByType = "none" | "layer" | "geometry" | GroupByFunction;
  */
 export type Filter = (filterName: FilterFilterName) => boolean;
 
+/** @since 5.0 */
 export interface FilterFilterName {
   /**
    * The [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#label)
    * of the [template item](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) to filter.
+   *
+   * @since 5.0
    */
   label?: string | null;
 }

package/widgets/Features/FeaturesVisibleElements.d.ts

@@ -1,5 +1,6 @@
 import type Accessor from "../../core/Accessor.js";
 
+/** @since 5.0 */
 export interface FeaturesVisibleElementsProperties extends Partial<Pick<FeaturesVisibleElements, "actionBar" | "closeButton" | "collapseButton" | "featureListLayerTitle" | "featureMenuHeading" | "featureNavigation" | "flow" | "heading" | "spinner">> {}
 
 /**
@@ -8,24 +9,29 @@ export interface FeaturesVisibleElementsProperties extends Partial<Pick<Features
  * Disabling all `visibleElements` on the Features widget allows the look and feel of the [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) widget, while supporting related record browsing and clustering.
  *
  * ![popup-visibleElements](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/popup/popup-visible-elements.png)
+ *
+ * @since 5.0
  */
 export default abstract class FeaturesVisibleElements extends Accessor {
   /**
    * Indicates whether to display the action bar that holds the feature's [FeaturesViewModel#actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions) will be displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor actionBar: boolean;
   /**
    * Indicates whether to display a close button on the widget dialog.
    *
    * @default true
+   * @since 5.0
    */
   accessor closeButton: boolean;
   /**
    * **Since 4.28.** Indicates whether to display the collapse button on the widget dialog.
    *
    * @default false
+   * @since 5.0
    */
   accessor collapseButton: boolean;
   /**
@@ -34,18 +40,21 @@ export default abstract class FeaturesVisibleElements extends Accessor {
    * ![popup-visibleElements-featureListLayerTitle](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/popup/popup-listlayertitle-true2.png)
    *
    * @default true
+   * @since 5.0
    */
   accessor featureListLayerTitle: boolean;
   /**
    * **Since 4.32.** Indicates whether to display a heading and description on the widget feature menu list.
    *
    * @default true
+   * @since 5.0
    */
   accessor featureMenuHeading: boolean;
   /**
    * Indicates whether pagination for feature navigation will be displayed. This allows the user to scroll through various [selected features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#features) using pagination arrows.
    *
    * @default true
+   * @since 5.0
    */
   accessor featureNavigation: boolean;
   /**
@@ -55,18 +64,21 @@ export default abstract class FeaturesVisibleElements extends Accessor {
    * To place the widget into an existing Calcite flow component, set this property to `false`.
    *
    * @default true
+   * @since 5.0
    */
   accessor flow: boolean;
   /**
    * Indicates whether to display the widget heading.
    *
    * @default true
+   * @since 5.0
    */
   accessor heading: boolean;
   /**
    * Indicates whether to display the widget's loading spinner.
    *
    * @default true
+   * @since 5.0
    */
   accessor spinner: boolean;
 }

package/widgets/FloorFilter/FloorFilterViewModel.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import{__decorate as e}from"tslib";import t from"../../core/Accessor.js";import{createTask as i}from"../../core/asyncUtils.js";import l from"../../core/Collection.js";import s from"../../core/Error.js";import{throwIfAborted as r}from"../../core/promiseUtils.js";import{watch as o,initial as a,syncAndInitial as n}from"../../core/reactiveUtils.js";import{Milliseconds as h}from"../../core/time.js";import{property as d,subclass as c}from"../../core/accessorSupport/decorators.js";import u from"../../webdoc/Widgets.js";import f from"../../webdoc/widgets/FloorFilter.js";import{isWebMap as p}from"../../webmap/utils.js";import{GoTo as y}from"../support/GoTo.js";function v(e){return"esri.WebScene"===e.declaredClass}let m=class extends(y(t)){constructor(e){super(e),this.filterMenuOpen=!1,this.filterMenuType="site",this.filterMode="base-floors",this.levelsExpanded=!0,this.searchTerm=null,this.view=null,this._updateFloorFilterTask=null,this._viewHeightBreakpoint=null,this._viewWidthBreakpoint=null}initialize(){this.addHandles([o(()=>this.view?.map,e=>{null!=this._updateFloorFilterTask&&(this._updateFloorFilterTask.abort(),this._updateFloorFilterTask=null),this._updateFloorFilterTask=i(async t=>{await this._updateFloorFilterFromMap(e),r(t),this._setInitialViewState(e)})},a),o(()=>this.view,(e,t)=>{this._unregisterWidget(t),this._registerWidget(e),this._watchSearchResults(e)},n),o(()=>this.view?.widthBreakpoint??null,e=>{this._viewWidthBreakpoint=e}),o(()=>this.view?.heightBreakpoint??null,e=>{this._viewHeightBreakpoint=e})])}destroy(){this._unregisterWidget(this.view),this.view=null,null!=this._updateFloorFilterTask&&(this._updateFloorFilterTask.abort(),this._updateFloorFilterTask=null)}set enabled(e){this._callOverride("enabled",e)}set facility(e){if(e&&this._isOverridden("facility")){const t=this.getFacility(e);this.hasMultipleSites&&(this.site=t?.siteId||null)}this._callOverride("facility",e)}set filterFeatures(e){this._callOverride("filterFeatures",e)}set filterLayers(e){this._callOverride("filterLayers",e)}get hasFacilities(){return null!=this.filterLayers?.facilityLayer&&this.filterFeatures?.facilities?.facilitiesInfo?.length>0}get hasLevels(){return null!=this.filterLayers?.levelLayer&&this.filterFeatures?.levels?.levelsInfo?.length>0}get hasMultipleSites(){return null!=this.filterLayers?.siteLayer&&this.filterFeatures?.sites?.sitesInfo?.length>1}get isNormalMode(){let e=!0;const t=this._viewWidthBreakpoint;return"xsmall"!==this._viewHeightBreakpoint&&"xsmall"!==t||(e=!1),e}set level(e){if(!e)return this._callOverride("level",e),this.facility=null,this.site=null,void this.setFloors(null);let t=null,i=null;const l=e?.split("--");if(l?.length>1&&"all"===l[0]?(i=l[1],t={id:e,facilityId:i,shortName:null,longName:null,levelNumber:null,verticalOrder:null}):(t=this.getLevel(e),i=t?.facilityId??null),this.level!==e||this.isNormalMode||this.levelsExpanded)t&&this.hasFacilities&&this.hasLevels?(this.facility=i,this.hasMultipleSites&&(this.site=this.getFacility(i)?.siteId||null),this.setFloors(t)):this._isOverridden("level")&&(this.facility=null,this.site=null,this.hasMultipleSites&&(this.filterMenuType="site"),this.setFloors(null)),this._callOverride("level",e);else{const e=this.getFacilityLevels(i);e?.length>1&&(this.levelsExpanded=!0)}}set longNames(e){this._callOverride("longNames",e)}set minimized(e){this._callOverride("minimized",e)}set pinnedLevels(e){this._callOverride("pinnedLevels",e)}get selectedVerticalOrder(){if(p(this.view?.map)){const e=this.view.map.resourceInfo;return e?.widgets?.floorFilter?.selectedVerticalOrder??null}return null}set site(e){this._callOverride("site",e)}get state(){return this.view&&this.filterFeatures&&this.hasFacilities&&this.hasLevels?"ready":this.view&&!this.filterFeatures?"loading":"disabled"}get useVerticalOrder(){if(p(this.view?.map)){const e=this.view.map.resourceInfo;return e?.widgets?.floorFilter?.useVerticalOrder??!1}return!1}filterFacilities(e){let t=e;this.searchTerm&&(this.searchTerm=this.searchTerm.trim(),t=e.filter(e=>{const{name:t}=e;return t.toLowerCase().includes(this.searchTerm?.toLowerCase())})),this.site&&(t=t.filter(e=>e.siteId===this.site));return t.sort((e,t)=>{const i=e.name,l=t.name;return i.localeCompare(l,void 0,{sensitivity:"base"})})}filterSites(e){let t=e;this.searchTerm&&(this.searchTerm=this.searchTerm.trim(),t=e.filter(e=>{const{name:t}=e;return t.toLowerCase().includes(this.searchTerm?.toLowerCase())}));return t.sort((e,t)=>{const i=e.name,l=t.name;return i.localeCompare(l,void 0,{sensitivity:"base"})})}getBaseLevel(e){const t=this.filterFeatures?.levels?.levelsInfo;let i=null;if(e){const{id:l}=e;if(t&&t.length>0&&(t.forEach(e=>{0===e.verticalOrder&&e.facilityId===l&&(i=e)}),!i)){let e=null;t.forEach(t=>{t.facilityId===l&&(e?(t.verticalOrder??0)>=0?null!=e.verticalOrder&&(e.verticalOrder<0||(t.verticalOrder??0)<e.verticalOrder)&&(e=t):null!=e.verticalOrder&&null!=t.verticalOrder&&e.verticalOrder<0&&t.verticalOrder>e.verticalOrder&&(e=t):e=t)}),e&&(i=e)}}return i}getFacility(e){return this.filterFeatures?.facilities?.facilitiesInfo?.find(t=>t.id===e)??null}getFacilityLevels(e){if(!e||!this.filterFeatures?.levels?.levelsInfo)return[];return this.filterFeatures.levels.levelsInfo.filter(t=>t.facilityId===e).sort((e,t)=>{const i=e.verticalOrder??0,l=t.verticalOrder??0;return i>l?-1:i===l?0:1})}getLevel(e){return this.filterFeatures?.levels?.levelsInfo?.find(t=>t.id===e)??null}getSite(e){return this.filterFeatures?.sites?.sitesInfo?.find(t=>t.id===e)??null}goTo(e){const{view:t}=this;if(!t||!e)return;const{geometry:i}=e;i&&i.extent&&this.callGoTo({target:i.extent,options:{duration:h(1e3),easing:"quad-in-out"}})}setFloors(e){const{view:t}=this;t&&(t?.map?.allLayers?.forEach(e=>{"feature"===e.type&&this._computeViewAllModeFloors(e)}),t.floors=new l(this._computeFloors(e)))}updateWebDocument(e){if(p(e)){const t=new f({enabled:this.enabled,longNames:this.longNames,minimized:this.minimized,pinnedLevels:this.pinnedLevels,site:this.site??null,facility:this.facility??null,level:this.level??null,useVerticalOrder:this.useVerticalOrder,selectedVerticalOrder:this.selectedVerticalOrder});e.widgets?e.widgets.floorFilter=t:e.widgets=new u({floorFilter:t})}}_computeFloors(e){if("single-floor"===this.filterMode)this._computeSingleFloor(e);else if("base-floors"===this.filterMode)return"3d"===this.view?.type?this._computeBaseFloors3D(e):this._computeBaseFloors(e);return this._computeEmptyFloors()}_computeSingleFloor(e){if(!e)return this._computeEmptyFloors();const t=[];if("all"===e?.id){this.getFacilityLevels(e.facilityId).forEach(e=>{e.id&&t.push(e.id)})}else e&&t.push(e.id);return t}_computeBaseFloors(e){const t=this.filterFeatures?.levels?.levelsInfo;if(!t?.length)return this._computeEmptyFloors();const i=[];if("all"===e?.id){this.getFacilityLevels(e.facilityId).forEach(e=>{e.id&&i.push(e.id)})}else e&&i.push(e.id);const l=e?.facilityId,s=e?.verticalOrder,r=(e,t)=>{0===e&&i.push(t)};return t.forEach(e=>{const{id:t,facilityId:o,verticalOrder:a}=e;l||i.includes(t)?o===l||i.includes(t)||(this.useVerticalOrder?a===s&&i.push(t):r(a,t)):r(a,t)}),i}_computeBaseFloors3D(e){const t=this.filterFeatures?.levels?.levelsInfo;if(!t?.length)return this._computeEmptyFloors();const i=[],l=e?.id.split("--")??[];if(l?.length>1&&"all"===l[0]){this.getFacilityLevels(e?.facilityId).forEach(e=>{e.id&&i.push(e.id)})}else e&&i.push(e.id);const s=e?.facilityId;return t.forEach(e=>{const{id:t,facilityId:l}=e;(s||i.includes(t))&&(l===s||i.includes(t))||i.push(t)}),i}_computeEmptyFloors(){return[]}async _setFilterLayers(){const{view:e}=this;if(e&&!this._isOverridden("filterLayers")){if(!p(e.map)&&!v(e.map))throw new s("floorfilter:unsupported-map","Map must be a webmap or webscene");{const t=e.map,i=t?.allLayers;if(i?.items?.length>0){const e={siteLayer:null,facilityLayer:null,levelLayer:null},l=t.floorInfo?.siteLayer?.layerId,s=t.floorInfo?.facilityLayer?.layerId,r=t.floorInfo?.levelLayer?.layerId,o=t.floorInfo?.siteLayer?.sublayerId||t.floorInfo?.facilityLayer?.sublayerId||t.floorInfo?.levelLayer?.sublayerId;if(!s||!r)return;const a=i.items.filter(e=>"feature"===e.type||"scene"===e.type),n=i.items.filter(e=>"map-image"===e.type);if(n?.length>0&&o){await Promise.all(n.map(e=>e.load()));const i=t.floorInfo?.siteLayer?.sublayerId,o=t.floorInfo?.facilityLayer?.sublayerId,a=t.floorInfo?.levelLayer?.sublayerId;n.forEach(t=>{const n=t.id,h=t?.allSublayers,d=h?.items;(n===l||n===s||n===r)&&d?.length>0&&h.items.forEach(t=>{const s=t.id;n===l&&s===i?e.siteLayer=t:s===o?e.facilityLayer=t:s===a&&(e.levelLayer=t)})})}a?.length>0&&a.forEach(t=>{const i=t.id;i===l?e.siteLayer=t:i===s?e.facilityLayer=t:i===r&&(e.levelLayer=t)}),this.filterLayers=e}}}}async _getFilterFeatures(){if(this._isOverridden("filterFeatures"))return this.filterFeatures;const[e,t,i]=await Promise.all([this._getSites(),this._getFacilities(),this._getLevels()]);return{sites:e,facilities:t,levels:i}}async _getSites(){const e={sitesInfo:[]},{filterLayers:t,view:i}=this,l=i?.map,{siteLayer:s}=t;if(!s||!l?.floorInfo?.siteLayer)return e;const r=s.createQuery();r.returnGeometry=!0,r.outFields=["*"],r.returnZ=!0,"type"in s&&"scene"===s.type&&(r.multipatchOption="xyFootprint");const{siteIdField:o,nameField:a}=l.floorInfo.siteLayer,n=await s.queryFeatures(r);if(n?.features?.length>0){const t=n.features,i=s?.fieldsIndex.get(o)?.name||o,l=s?.fieldsIndex.get(a)?.name||a;null!=i&&null!=l&&t.forEach(t=>{const s=t.attributes,r=t.geometry,o=s[i],a=s[l];o&&a&&e.sitesInfo.push({id:o,name:a,geometry:r})})}return e}async _getFacilities(){const{filterLayers:e,view:t}=this,i=t?.map,{facilityLayer:l}=e,s={facilitiesInfo:[]};if(!l||!i?.floorInfo?.facilityLayer)return s;const r=l.createQuery();r.returnGeometry=!0,r.outFields=["*"],r.returnZ=!0,"type"in l&&"scene"===l.type&&(r.multipatchOption="xyFootprint");const{facilityIdField:o,siteIdField:a,nameField:n}=i.floorInfo.facilityLayer,h=await l.queryFeatures(r);if(h?.features?.length>0){const e=h.features,t=l?.fieldsIndex.get(o)?.name||o,i=l?.fieldsIndex.get(a)?.name||a,r=l?.fieldsIndex.get(n)?.name||n;t&&i&&r&&e.forEach(e=>{const l=e.attributes,o=e.geometry,a=l[t],n=l[i],h=l[r];a&&h&&s.facilitiesInfo.push({id:a,siteId:n,name:h,geometry:o})})}return s}async _getLevels(){const{filterLayers:e,view:t}=this,i=t?.map,{levelLayer:l}=e,s={levelsInfo:[]};if(!l||!i?.floorInfo?.levelLayer)return s;const r=l.createQuery();r.returnGeometry=!0,r.outFields=["*"],r.returnZ=!0;const{levelIdField:o,facilityIdField:a,longNameField:n,shortNameField:h,levelNumberField:d,verticalOrderField:c}=i.floorInfo.levelLayer,u=await l.queryFeatures(r);if(u?.features?.length>0){const e=u.features,t=l?.fieldsIndex.get(o)?.name||o,i=l?.fieldsIndex.get(a)?.name||a,r=l?.fieldsIndex.get(n)?.name||n,f=l?.fieldsIndex.get(h)?.name||h,p=l?.fieldsIndex.get(d)?.name||d,y=l?.fieldsIndex.get(c)?.name||c;t&&i&&r&&f&&p&&y&&e.forEach(e=>{const l=e.attributes,o=l[t],a=l[i],n=l[r],h=l[f],d=l[p],c=l[y];o&&a&&n&&h&&"number"==typeof d&&"number"==typeof c&&s.levelsInfo.push({id:o,facilityId:a,longName:n,shortName:h,levelNumber:d,verticalOrder:c})})}return s}_registerWidget(e){const t=e?.persistableViewModels.includes(this);t||e?.persistableViewModels.add(this)}_unregisterWidget(e){e?.persistableViewModels.remove(this)}_watchSearchResults(e){e?.on("select-result-floor",e=>{const t=this.getLevel(e);t&&this.level!==e&&(this.level=e,this.setFloors(t))})}async _setInitialViewState(e){if(this.view)try{await this.view.when(),await this._setFilterLayers();const t=await this._getFilterFeatures();if(!t)return;if(this.filterFeatures=t,!this.hasFacilities||!this.hasLevels)return void console.error("Facilities and Levels are required for the Floor Filter widget");if(this.hasMultipleSites||(this.filterMenuType="facility"),this.facility&&this.level){this.filterMenuType="facility";const e=this.getFacility(this.facility),t=this.getLevel(this.level);this.site||(this.site=e?.siteId||void 0),this.setFloors(t)}else if(this.facility&&!this.level){this.filterMenuType="facility";const e=this.getFacility(this.facility),t=this.getBaseLevel(e);this.site||(this.site=e?.siteId||void 0),this.level=t?.id||void 0,this.setFloors(t)}else if(!this.facility&&this.level){this.filterMenuType="facility";const e=this.getLevel(this.level),t=this.getFacility(e?.facilityId);this.facility=t?.id||void 0,this.site||(this.site=t?.siteId||void 0),this.setFloors(e)}else if(!this.site||this.facility||this.level){if(!e||!p(e))return void this.setFloors(null);const t=e?.widgets?.floorFilter;if(!t)return void this.setFloors(null);t.site&&!this.site&&(this.site=t.site,this.filterMenuType="facility"),this.setFloors(null)}else this.filterMenuType="site",this.setFloors(null)}catch(t){console.error("Couldn't retrieve sites, facilities, and levels",t)}}_callOverride(e,t){this._override(e,t)}async _updateFloorFilterFromMap(e){if(!e||!p(e))return;const t=e?.widgets?.floorFilter;t&&(this._isOverridden("enabled")||(this.enabled=t.enabled),this._isOverridden("longNames")||(this.longNames=t.longNames),this._isOverridden("minimized")||(this.minimized=t.minimized),this._isOverridden("pinnedLevels")||(this.pinnedLevels=t.pinnedLevels),this._isOverridden("site")||(this.site=t.site),this._isOverridden("facility")||(this.facility=t.facility),this._isOverridden("level")||(this.level=t.level))}_computeViewAllModeFloors(e){const{filterFeatures:t}=this;if(e.floorInfo?.viewAllMode&&this.hasLevels&&this.hasFacilities&&"base-floors"===this.filterMode){const{level:i,facility:s}=this,r=[];t.levels.levelsInfo.forEach(e=>{const{id:t,facilityId:l}=e;s&&l===s?i&&t===i&&r.push(t):r.push(t)}),e.floorInfo.viewAllLevelIds=new l(r)}}};e([d({value:!1})],m.prototype,"enabled",null),e([d({value:void 0})],m.prototype,"facility",null),e([d({value:null})],m.prototype,"filterFeatures",null),e([d({value:null})],m.prototype,"filterLayers",null),e([d()],m.prototype,"filterMenuOpen",void 0),e([d()],m.prototype,"filterMenuType",void 0),e([d()],m.prototype,"filterMode",void 0),e([d()],m.prototype,"hasFacilities",null),e([d()],m.prototype,"hasLevels",null),e([d()],m.prototype,"hasMultipleSites",null),e([d({readOnly:!0})],m.prototype,"isNormalMode",null),e([d({value:void 0})],m.prototype,"level",null),e([d({value:!1})],m.prototype,"longNames",null),e([d()],m.prototype,"levelsExpanded",void 0),e([d({value:!1})],m.prototype,"minimized",null),e([d({value:!1})],m.prototype,"pinnedLevels",null),e([d()],m.prototype,"searchTerm",void 0),e([d({readOnly:!0})],m.prototype,"selectedVerticalOrder",null),e([d({value:void 0})],m.prototype,"site",null),e([d({readOnly:!0})],m.prototype,"state",null),e([d({readOnly:!0,value:!1})],m.prototype,"useVerticalOrder",null),e([d()],m.prototype,"view",void 0),e([d()],m.prototype,"_viewHeightBreakpoint",void 0),e([d()],m.prototype,"_viewWidthBreakpoint",void 0),e([d()],m.prototype,"updateWebDocument",null),m=e([c("esri.widgets.FloorFilter.FloorFilterViewModel")],m);const F=m;export{F as default};
+import{__decorate as e}from"tslib";import t from"../../core/Accessor.js";import{createTask as i}from"../../core/asyncUtils.js";import l from"../../core/Collection.js";import s from"../../core/Error.js";import{throwIfAborted as r}from"../../core/promiseUtils.js";import{watch as o,initial as a,syncAndInitial as n}from"../../core/reactiveUtils.js";import{Milliseconds as h}from"../../core/time.js";import{property as d,subclass as c}from"../../core/accessorSupport/decorators.js";import u from"../../webdoc/Widgets.js";import f from"../../webdoc/widgets/FloorFilter.js";import{isWebMap as p}from"../../webmap/utils.js";import{GoTo as y}from"../support/GoTo.js";function v(e){return"esri.WebScene"===e.declaredClass}let m=class extends(y(t)){constructor(e){super(e),this.filterMenuOpen=!1,this.filterMenuType="site",this.filterMode="base-floors",this.levelsExpanded=!0,this.searchTerm=null,this.view=null,this._updateFloorFilterTask=null,this._viewHeightBreakpoint=null,this._viewWidthBreakpoint=null}initialize(){this.addHandles([o(()=>this.view?.map,e=>{null!=this._updateFloorFilterTask&&(this._updateFloorFilterTask.abort(),this._updateFloorFilterTask=null),this._updateFloorFilterTask=i(async t=>{await this._updateFloorFilterFromMap(e),r(t),this._setInitialViewState(e)})},a),o(()=>this.view,(e,t)=>{this._unregisterWidget(t),this._registerWidget(e),this._watchSearchResults(e)},n),o(()=>this.view?.widthBreakpoint??null,e=>{this._viewWidthBreakpoint=e}),o(()=>this.view?.heightBreakpoint??null,e=>{this._viewHeightBreakpoint=e})])}destroy(){this._unregisterWidget(this.view),this.view=null,null!=this._updateFloorFilterTask&&(this._updateFloorFilterTask.abort(),this._updateFloorFilterTask=null)}set enabled(e){this._callOverride("enabled",e)}set facility(e){if(e&&this._isOverridden("facility")){const t=this.getFacility(e);this.hasMultipleSites&&(this.site=t?.siteId||null)}this._callOverride("facility",e)}set filterFeatures(e){this._callOverride("filterFeatures",e)}set filterLayers(e){this._callOverride("filterLayers",e)}get hasFacilities(){return null!=this.filterLayers?.facilityLayer&&this.filterFeatures?.facilities?.facilitiesInfo?.length>0}get hasLevels(){return null!=this.filterLayers?.levelLayer&&this.filterFeatures?.levels?.levelsInfo?.length>0}get hasMultipleSites(){return null!=this.filterLayers?.siteLayer&&this.filterFeatures?.sites?.sitesInfo?.length>1}get isNormalMode(){let e=!0;const t=this._viewWidthBreakpoint;return"xsmall"!==this._viewHeightBreakpoint&&"xsmall"!==t||(e=!1),e}set level(e){if(!e)return this._callOverride("level",e),this.facility=null,this.site=null,void this.setFloors(null);let t=null,i=null;const l=e?.split("--");if(l?.length>1&&"all"===l[0]?(i=l[1],t={id:e,facilityId:i,shortName:null,longName:null,levelNumber:null,verticalOrder:null}):(t=this.getLevel(e),i=t?.facilityId??null),this.level!==e||this.isNormalMode||this.levelsExpanded)t&&this.hasFacilities&&this.hasLevels?(this.facility=i,this.hasMultipleSites&&(this.site=this.getFacility(i)?.siteId||null),this.setFloors(t)):this._isOverridden("level")&&(this.facility=null,this.site=null,this.hasMultipleSites&&(this.filterMenuType="site"),this.setFloors(null)),this._callOverride("level",e);else{const e=this.getFacilityLevels(i);e?.length>1&&(this.levelsExpanded=!0)}}set longNames(e){this._callOverride("longNames",e)}set minimized(e){this._callOverride("minimized",e)}set pinnedLevels(e){this._callOverride("pinnedLevels",e)}get selectedVerticalOrder(){if(p(this.view?.map)){const e=this.view.map.resourceInfo;return e?.widgets?.floorFilter?.selectedVerticalOrder??null}return null}set site(e){this._callOverride("site",e)}get state(){return this.view&&this.filterFeatures&&this.hasFacilities&&this.hasLevels?"ready":this.view&&!this.filterFeatures?"loading":"disabled"}get useVerticalOrder(){if(p(this.view?.map)){const e=this.view.map.resourceInfo;return e?.widgets?.floorFilter?.useVerticalOrder??!1}return!1}filterFacilities(e){let t=e;this.searchTerm&&(this.searchTerm=this.searchTerm.trim(),t=e.filter(e=>{const{name:t}=e;return t.toLowerCase().includes(this.searchTerm?.toLowerCase())})),this.site&&(t=t.filter(e=>e.siteId===this.site));return t.sort((e,t)=>{const i=e.name,l=t.name;return i.localeCompare(l,void 0,{sensitivity:"base"})})}filterSites(e){let t=e;this.searchTerm&&(this.searchTerm=this.searchTerm.trim(),t=e.filter(e=>{const{name:t}=e;return t.toLowerCase().includes(this.searchTerm?.toLowerCase())}));return t.sort((e,t)=>{const i=e.name,l=t.name;return i.localeCompare(l,void 0,{sensitivity:"base"})})}getBaseLevel(e){const t=this.filterFeatures?.levels?.levelsInfo;let i=null;if(e){const{id:l}=e;if(t&&t.length>0&&(t.forEach(e=>{0===e.verticalOrder&&e.facilityId===l&&(i=e)}),!i)){let e=null;t.forEach(t=>{t.facilityId===l&&(e?(t.verticalOrder??0)>=0?null!=e.verticalOrder&&(e.verticalOrder<0||(t.verticalOrder??0)<e.verticalOrder)&&(e=t):null!=e.verticalOrder&&null!=t.verticalOrder&&e.verticalOrder<0&&t.verticalOrder>e.verticalOrder&&(e=t):e=t)}),e&&(i=e)}}return i}getFacility(e){return this.filterFeatures?.facilities?.facilitiesInfo?.find(t=>t.id===e)??null}getFacilityLevels(e){if(!e||!this.filterFeatures?.levels?.levelsInfo)return[];return this.filterFeatures.levels.levelsInfo.filter(t=>t.facilityId===e).sort((e,t)=>{const i=e.verticalOrder??0,l=t.verticalOrder??0;return i>l?-1:i===l?0:1})}getLevel(e){return this.filterFeatures?.levels?.levelsInfo?.find(t=>t.id===e)??null}getSite(e){return this.filterFeatures?.sites?.sitesInfo?.find(t=>t.id===e)??null}goTo(e){const{view:t}=this;if(!t||!e)return;const{geometry:i}=e;i&&i.extent&&this.callGoTo({target:i.extent,options:{duration:h(1e3),easing:"quad-in-out-coast"}})}setFloors(e){const{view:t}=this;t&&(t?.map?.allLayers?.forEach(e=>{"feature"===e.type&&this._computeViewAllModeFloors(e)}),t.floors=new l(this._computeFloors(e)))}updateWebDocument(e){if(p(e)){const t=new f({enabled:this.enabled,longNames:this.longNames,minimized:this.minimized,pinnedLevels:this.pinnedLevels,site:this.site??null,facility:this.facility??null,level:this.level??null,useVerticalOrder:this.useVerticalOrder,selectedVerticalOrder:this.selectedVerticalOrder});e.widgets?e.widgets.floorFilter=t:e.widgets=new u({floorFilter:t})}}_computeFloors(e){if("single-floor"===this.filterMode)this._computeSingleFloor(e);else if("base-floors"===this.filterMode)return"3d"===this.view?.type?this._computeBaseFloors3D(e):this._computeBaseFloors(e);return this._computeEmptyFloors()}_computeSingleFloor(e){if(!e)return this._computeEmptyFloors();const t=[];if("all"===e?.id){this.getFacilityLevels(e.facilityId).forEach(e=>{e.id&&t.push(e.id)})}else e&&t.push(e.id);return t}_computeBaseFloors(e){const t=this.filterFeatures?.levels?.levelsInfo;if(!t?.length)return this._computeEmptyFloors();const i=[];if("all"===e?.id){this.getFacilityLevels(e.facilityId).forEach(e=>{e.id&&i.push(e.id)})}else e&&i.push(e.id);const l=e?.facilityId,s=e?.verticalOrder,r=(e,t)=>{0===e&&i.push(t)};return t.forEach(e=>{const{id:t,facilityId:o,verticalOrder:a}=e;l||i.includes(t)?o===l||i.includes(t)||(this.useVerticalOrder?a===s&&i.push(t):r(a,t)):r(a,t)}),i}_computeBaseFloors3D(e){const t=this.filterFeatures?.levels?.levelsInfo;if(!t?.length)return this._computeEmptyFloors();const i=[],l=e?.id.split("--")??[];if(l?.length>1&&"all"===l[0]){this.getFacilityLevels(e?.facilityId).forEach(e=>{e.id&&i.push(e.id)})}else e&&i.push(e.id);const s=e?.facilityId;return t.forEach(e=>{const{id:t,facilityId:l}=e;(s||i.includes(t))&&(l===s||i.includes(t))||i.push(t)}),i}_computeEmptyFloors(){return[]}async _setFilterLayers(){const{view:e}=this;if(e&&!this._isOverridden("filterLayers")){if(!p(e.map)&&!v(e.map))throw new s("floorfilter:unsupported-map","Map must be a webmap or webscene");{const t=e.map,i=t?.allLayers;if(i?.items?.length>0){const e={siteLayer:null,facilityLayer:null,levelLayer:null},l=t.floorInfo?.siteLayer?.layerId,s=t.floorInfo?.facilityLayer?.layerId,r=t.floorInfo?.levelLayer?.layerId,o=t.floorInfo?.siteLayer?.sublayerId||t.floorInfo?.facilityLayer?.sublayerId||t.floorInfo?.levelLayer?.sublayerId;if(!s||!r)return;const a=i.items.filter(e=>"feature"===e.type||"scene"===e.type),n=i.items.filter(e=>"map-image"===e.type);if(n?.length>0&&o){await Promise.all(n.map(e=>e.load()));const i=t.floorInfo?.siteLayer?.sublayerId,o=t.floorInfo?.facilityLayer?.sublayerId,a=t.floorInfo?.levelLayer?.sublayerId;n.forEach(t=>{const n=t.id,h=t?.allSublayers,d=h?.items;(n===l||n===s||n===r)&&d?.length>0&&h.items.forEach(t=>{const s=t.id;n===l&&s===i?e.siteLayer=t:s===o?e.facilityLayer=t:s===a&&(e.levelLayer=t)})})}a?.length>0&&a.forEach(t=>{const i=t.id;i===l?e.siteLayer=t:i===s?e.facilityLayer=t:i===r&&(e.levelLayer=t)}),this.filterLayers=e}}}}async _getFilterFeatures(){if(this._isOverridden("filterFeatures"))return this.filterFeatures;const[e,t,i]=await Promise.all([this._getSites(),this._getFacilities(),this._getLevels()]);return{sites:e,facilities:t,levels:i}}async _getSites(){const e={sitesInfo:[]},{filterLayers:t,view:i}=this,l=i?.map,{siteLayer:s}=t;if(!s||!l?.floorInfo?.siteLayer)return e;const r=s.createQuery();r.returnGeometry=!0,r.outFields=["*"],r.returnZ=!0,"type"in s&&"scene"===s.type&&(r.multipatchOption="xyFootprint");const{siteIdField:o,nameField:a}=l.floorInfo.siteLayer,n=await s.queryFeatures(r);if(n?.features?.length>0){const t=n.features,i=s?.fieldsIndex.get(o)?.name||o,l=s?.fieldsIndex.get(a)?.name||a;null!=i&&null!=l&&t.forEach(t=>{const s=t.attributes,r=t.geometry,o=s[i],a=s[l];o&&a&&e.sitesInfo.push({id:o,name:a,geometry:r})})}return e}async _getFacilities(){const{filterLayers:e,view:t}=this,i=t?.map,{facilityLayer:l}=e,s={facilitiesInfo:[]};if(!l||!i?.floorInfo?.facilityLayer)return s;const r=l.createQuery();r.returnGeometry=!0,r.outFields=["*"],r.returnZ=!0,"type"in l&&"scene"===l.type&&(r.multipatchOption="xyFootprint");const{facilityIdField:o,siteIdField:a,nameField:n}=i.floorInfo.facilityLayer,h=await l.queryFeatures(r);if(h?.features?.length>0){const e=h.features,t=l?.fieldsIndex.get(o)?.name||o,i=l?.fieldsIndex.get(a)?.name||a,r=l?.fieldsIndex.get(n)?.name||n;t&&i&&r&&e.forEach(e=>{const l=e.attributes,o=e.geometry,a=l[t],n=l[i],h=l[r];a&&h&&s.facilitiesInfo.push({id:a,siteId:n,name:h,geometry:o})})}return s}async _getLevels(){const{filterLayers:e,view:t}=this,i=t?.map,{levelLayer:l}=e,s={levelsInfo:[]};if(!l||!i?.floorInfo?.levelLayer)return s;const r=l.createQuery();r.returnGeometry=!0,r.outFields=["*"],r.returnZ=!0;const{levelIdField:o,facilityIdField:a,longNameField:n,shortNameField:h,levelNumberField:d,verticalOrderField:c}=i.floorInfo.levelLayer,u=await l.queryFeatures(r);if(u?.features?.length>0){const e=u.features,t=l?.fieldsIndex.get(o)?.name||o,i=l?.fieldsIndex.get(a)?.name||a,r=l?.fieldsIndex.get(n)?.name||n,f=l?.fieldsIndex.get(h)?.name||h,p=l?.fieldsIndex.get(d)?.name||d,y=l?.fieldsIndex.get(c)?.name||c;t&&i&&r&&f&&p&&y&&e.forEach(e=>{const l=e.attributes,o=l[t],a=l[i],n=l[r],h=l[f],d=l[p],c=l[y];o&&a&&n&&h&&"number"==typeof d&&"number"==typeof c&&s.levelsInfo.push({id:o,facilityId:a,longName:n,shortName:h,levelNumber:d,verticalOrder:c})})}return s}_registerWidget(e){const t=e?.persistableViewModels.includes(this);t||e?.persistableViewModels.add(this)}_unregisterWidget(e){e?.persistableViewModels.remove(this)}_watchSearchResults(e){e?.on("select-result-floor",e=>{const t=this.getLevel(e);t&&this.level!==e&&(this.level=e,this.setFloors(t))})}async _setInitialViewState(e){if(this.view)try{await this.view.when(),await this._setFilterLayers();const t=await this._getFilterFeatures();if(!t)return;if(this.filterFeatures=t,!this.hasFacilities||!this.hasLevels)return void console.error("Facilities and Levels are required for the Floor Filter widget");if(this.hasMultipleSites||(this.filterMenuType="facility"),this.facility&&this.level){this.filterMenuType="facility";const e=this.getFacility(this.facility),t=this.getLevel(this.level);this.site||(this.site=e?.siteId||void 0),this.setFloors(t)}else if(this.facility&&!this.level){this.filterMenuType="facility";const e=this.getFacility(this.facility),t=this.getBaseLevel(e);this.site||(this.site=e?.siteId||void 0),this.level=t?.id||void 0,this.setFloors(t)}else if(!this.facility&&this.level){this.filterMenuType="facility";const e=this.getLevel(this.level),t=this.getFacility(e?.facilityId);this.facility=t?.id||void 0,this.site||(this.site=t?.siteId||void 0),this.setFloors(e)}else if(!this.site||this.facility||this.level){if(!e||!p(e))return void this.setFloors(null);const t=e?.widgets?.floorFilter;if(!t)return void this.setFloors(null);t.site&&!this.site&&(this.site=t.site,this.filterMenuType="facility"),this.setFloors(null)}else this.filterMenuType="site",this.setFloors(null)}catch(t){console.error("Couldn't retrieve sites, facilities, and levels",t)}}_callOverride(e,t){this._override(e,t)}async _updateFloorFilterFromMap(e){if(!e||!p(e))return;const t=e?.widgets?.floorFilter;t&&(this._isOverridden("enabled")||(this.enabled=t.enabled),this._isOverridden("longNames")||(this.longNames=t.longNames),this._isOverridden("minimized")||(this.minimized=t.minimized),this._isOverridden("pinnedLevels")||(this.pinnedLevels=t.pinnedLevels),this._isOverridden("site")||(this.site=t.site),this._isOverridden("facility")||(this.facility=t.facility),this._isOverridden("level")||(this.level=t.level))}_computeViewAllModeFloors(e){const{filterFeatures:t}=this;if(e.floorInfo?.viewAllMode&&this.hasLevels&&this.hasFacilities&&"base-floors"===this.filterMode){const{level:i,facility:s}=this,r=[];t.levels.levelsInfo.forEach(e=>{const{id:t,facilityId:l}=e;s&&l===s?i&&t===i&&r.push(t):r.push(t)}),e.floorInfo.viewAllLevelIds=new l(r)}}};e([d({value:!1})],m.prototype,"enabled",null),e([d({value:void 0})],m.prototype,"facility",null),e([d({value:null})],m.prototype,"filterFeatures",null),e([d({value:null})],m.prototype,"filterLayers",null),e([d()],m.prototype,"filterMenuOpen",void 0),e([d()],m.prototype,"filterMenuType",void 0),e([d()],m.prototype,"filterMode",void 0),e([d()],m.prototype,"hasFacilities",null),e([d()],m.prototype,"hasLevels",null),e([d()],m.prototype,"hasMultipleSites",null),e([d({readOnly:!0})],m.prototype,"isNormalMode",null),e([d({value:void 0})],m.prototype,"level",null),e([d({value:!1})],m.prototype,"longNames",null),e([d()],m.prototype,"levelsExpanded",void 0),e([d({value:!1})],m.prototype,"minimized",null),e([d({value:!1})],m.prototype,"pinnedLevels",null),e([d()],m.prototype,"searchTerm",void 0),e([d({readOnly:!0})],m.prototype,"selectedVerticalOrder",null),e([d({value:void 0})],m.prototype,"site",null),e([d({readOnly:!0})],m.prototype,"state",null),e([d({readOnly:!0,value:!1})],m.prototype,"useVerticalOrder",null),e([d()],m.prototype,"view",void 0),e([d()],m.prototype,"_viewHeightBreakpoint",void 0),e([d()],m.prototype,"_viewWidthBreakpoint",void 0),e([d()],m.prototype,"updateWebDocument",null),m=e([c("esri.widgets.FloorFilter.FloorFilterViewModel")],m);const F=m;export{F as default};

package/widgets/Histogram/types.d.ts

@@ -1,4 +1,5 @@
 
+/** @since 5.0 */
 export type HistogramState = "disabled" | "ready";
 
 /**
@@ -9,6 +10,7 @@ export type HistogramState = "disabled" | "ready";
  * @param index - The index of the histogram bar. This directly corresponds
  *   to the index of the associated [bin](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#bins).
  * @param element - The histogram bar element to style.
+ * @since 5.0
  */
 export type BarCreatedFunction = (index: number, element: SVGElement) => void;
 
@@ -22,12 +24,22 @@ export type BarCreatedFunction = (index: number, element: SVGElement) => void;
  * @param labelElement - The SVG element representing the label
  *    rendered on the histogram for the associated line element.
  * @param index - The index of the data line.
+ * @since 5.0
  */
 export type DataLineCreatedFunction = (lineElement: SVGElement, labelElement?: SVGElement | null | undefined, index?: number | null | undefined) => void;
 
+/** @since 5.0 */
 export interface DataLineInfos {
-  /** The label associated with the line. */
+  /**
+   * The label associated with the line.
+   *
+   * @since 5.0
+   */
   label?: string | number | null;
-  /** The value on the data axis of the histogram where a line will be rendered. */
+  /**
+   * The value on the data axis of the histogram where a line will be rendered.
+   *
+   * @since 5.0
+   */
   value: number;
 }

package/widgets/HistogramRangeSlider/types.d.ts

@@ -1,2 +1,3 @@
 
+/** @since 5.0 */
 export type RangeType = "equal" | "not-equal" | "less-than" | "greater-than" | "at-most" | "at-least" | "between" | "not-between";