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

package/widgets/FeatureTable/Grid/GridViewModel.d.ts

@@ -1,5 +1,7 @@
 import type { EventedAccessor, EventedMixinProperties } from "../../../core/Evented.js";
 
+/** @since 5.0 */
 export interface GridViewModelProperties extends EventedMixinProperties {}
 
+/** @since 5.0 */
 export default abstract class GridViewModel extends EventedAccessor {}

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

@@ -2,97 +2,208 @@ import type Graphic from "../../../Graphic.js";
 import type Column from "./Column.js";
 import type { Icon } from "@esri/calcite-components/components/calcite-icon";
 
+/** @since 5.0 */
 export type CellValue = null | undefined | string | number;
 
+/** @since 5.0 */
 export type TextAlign = "start" | "center" | "end";
 
+/** @since 5.0 */
 export type FeatureTableState = "disabled" | "loading" | "loaded" | "ready" | "error";
 
+/** @since 5.0 */
 export type GridSupportedColumns = Column;
 
+/** @since 5.0 */
 export type GridMultiSortPriority = "append" | "prepend";
 
+/** @since 5.0 */
 export interface TableInteractionEvent {
-  /** The feature associated with the cell. */
+  /**
+   * The feature associated with the cell.
+   *
+   * @since 5.0
+   */
   feature?: Graphic;
-  /** The field name associated with the cell. */
+  /**
+   * The field name associated with the cell.
+   *
+   * @since 5.0
+   */
   fieldName?: string;
-  /** Specifies the index of the row (not just the individual cell). */
+  /**
+   * Specifies the index of the row (not just the individual cell).
+   *
+   * @since 5.0
+   */
   index?: number;
-  /** The native event object used for the interaction. */
+  /**
+   * The native event object used for the interaction.
+   *
+   * @since 5.0
+   */
   native?: MouseEvent | PointerEvent | KeyboardEvent;
-  /** The object ID of the feature associated with the cell. */
+  /**
+   * The object ID of the feature associated with the cell.
+   *
+   * @since 5.0
+   */
   objectId?: number;
 }
 
+/** @since 5.0 */
 export interface TableInteractionCellClickEvent extends TableInteractionEvent {
-  /** The type of cell interaction event. */
+  /**
+   * The type of cell interaction event.
+   *
+   * @since 5.0
+   */
   type: "cell-click";
 }
 
+/** @since 5.0 */
 export interface TableInteractionCellDblclickEvent extends TableInteractionEvent {
-  /** The type of cell interaction event. */
+  /**
+   * The type of cell interaction event.
+   *
+   * @since 5.0
+   */
   type: "cell-dblclick";
 }
 
+/** @since 5.0 */
 export interface TableInteractionCellPointeroverEvent extends TableInteractionEvent {
-  /** The type of cell interaction event. */
+  /**
+   * The type of cell interaction event.
+   *
+   * @since 5.0
+   */
   type: "cell-pointerover";
 }
 
+/** @since 5.0 */
 export interface TableInteractionCellPointeroutEvent extends TableInteractionEvent {
-  /** The type of cell interaction event. */
+  /**
+   * The type of cell interaction event.
+   *
+   * @since 5.0
+   */
   type: "cell-pointerout";
 }
 
+/** @since 5.0 */
 export interface TableInteractionCellKeydownEvent extends TableInteractionEvent {
-  /** The type of cell interaction event. */
+  /**
+   * The type of cell interaction event.
+   *
+   * @since 5.0
+   */
   type: "cell-keydown";
 }
 
+/** @since 5.0 */
 export interface TableInteractionColumnReorderEvent extends TableInteractionEvent {
-  /** The type of table interaction event. */
+  /**
+   * The type of table interaction event.
+   *
+   * @since 5.0
+   */
   type: "column-reorder";
 }
 
+/** @since 5.0 */
 export type Direction = "asc" | "desc" | null | undefined;
 
+/** @since 5.0 */
 export interface ColumnTableMenuConfig extends TableMenuConfig {
-  /** The string value indicating the [icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed in the header cell of the column. */
+  /**
+   * The string value indicating the [icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed in the header cell of the column.
+   *
+   * @since 5.0
+   */
   icon?: Icon["icon"];
-  /** The selection mode of the menu items. */
+  /**
+   * The selection mode of the menu items.
+   *
+   * @since 5.0
+   */
   selectionMode?: "none" | "single" | "multiple";
 }
 
-/** The configuration for the table's menu. */
+/**
+ * The configuration for the table's menu.
+ *
+ * @since 5.0
+ */
 export interface TableMenuConfig {
-  /** Indicates whether the menu is disabled. Default value is `false`. */
+  /**
+   * Indicates whether the menu is disabled. Default value is `false`.
+   *
+   * @since 5.0
+   */
   disabled?: boolean;
-  /** The menu items within the table menu. */
+  /**
+   * The menu items within the table menu.
+   *
+   * @since 5.0
+   */
   items: TableMenuItemConfig[];
-  /** Indicates whether the menu is open. Default value is `false`. */
+  /**
+   * Indicates whether the menu is open. Default value is `false`.
+   *
+   * @since 5.0
+   */
   open?: boolean;
 }
 
-/** The configuration for an individual menu item within the table menu. */
+/**
+ * The configuration for an individual menu item within the table menu.
+ *
+ * @since 5.0
+ */
 export interface TableMenuItemConfig {
-  /** The function that executes when the menu item is clicked. */
+  /**
+   * The function that executes when the menu item is clicked.
+   *
+   * @since 5.0
+   */
   clickFunction: TableMenuItemConfigClickFunction;
-  /** Indicates whether the menu item is disabled. Default value is `false`. */
+  /**
+   * Indicates whether the menu item is disabled. Default value is `false`.
+   *
+   * @since 5.0
+   */
   disabled?: boolean;
-  /** A function that determines whether the menu item is hidden. Default value is `false`. */
+  /**
+   * A function that determines whether the menu item is hidden. Default value is `false`.
+   *
+   * @since 5.0
+   */
   hidden?: TableMenuItemConfigHiddenFunction | boolean;
-  /** The string value indicating the [Calcite icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed for the menu item. */
+  /**
+   * The string value indicating the [Calcite icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed for the menu item.
+   *
+   * @since 5.0
+   */
   icon?: Icon["icon"];
   /**
    * This is the CSS class for the icon displayed for the menu item.
    *
    * @deprecated Since version 4.30. Use `icon` instead.
+   * @since 5.0
    */
   iconClass?: string;
-  /** The text displayed for the menu item. */
+  /**
+   * The text displayed for the menu item.
+   *
+   * @since 5.0
+   */
   label: string;
-  /** Indicates whether the menu item is selected. Default value is `false`. */
+  /**
+   * Indicates whether the menu item is selected. Default value is `false`.
+   *
+   * @since 5.0
+   */
   selected?: boolean;
 }
 
@@ -100,6 +211,7 @@ export interface TableMenuItemConfig {
  * The function that executes when the menu item is clicked.
  *
  * @param event - The event.
+ * @since 5.0
  */
 export type TableMenuItemConfigClickFunction = (event: MouseEvent | KeyboardEvent) => void;
 
@@ -107,5 +219,6 @@ export type TableMenuItemConfigClickFunction = (event: MouseEvent | KeyboardEven
  * A function that determines whether the menu item is hidden.
  *
  * @returns whether the menu item is hidden.
+ * @since 5.0
  */
 export type TableMenuItemConfigHiddenFunction = () => boolean;

package/widgets/FeatureTable/TableMenuVisibleElements.d.ts

@@ -1,54 +1,64 @@
 import type Accessor from "../../core/Accessor.js";
 
+/** @since 5.0 */
 export interface TableMenuVisibleElementsProperties extends Partial<Pick<TableMenuVisibleElements, "clearSelection" | "deleteSelection" | "exportSelectionToCSV" | "refreshData" | "selectedRecordsShowAllToggle" | "selectedRecordsShowSelectedToggle" | "toggleColumns" | "zoomToSelection">> {}
 
+/** @since 5.0 */
 export default abstract class TableMenuVisibleElements extends Accessor {
   /**
    * Indicates whether to display the `Clear selection` menu item. Default value is `true` and will display within the menu if any rows are selected.
    *
    * @default true
+   * @since 5.0
    */
   accessor clearSelection: boolean;
   /**
    * _(Since 4.25)_ Indicates whether to display the `Delete Selection` menu item. Default value is `true` and will display if `editingEnabled` is `true` and enabled on the feature service and rows are selected.
    *
    * @default true
+   * @since 5.0
    */
   accessor deleteSelection: boolean;
   /**
    * _(Since 4.31)_ Indicates whether to display the `Export selection to CSV` menu item. Default value is `true` and will display if rows are selected. Geometry is included in the final export if the layer's geometry is of type point.
    *
    * @default true
+   * @since 5.0
    */
   accessor exportSelectionToCSV: boolean;
   /**
    * Indicates whether to display the `Refresh data` menu item. Default value is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor refreshData: boolean;
   /**
    * _(Since 4.23)_ Indicates whether to toggle between showing only selected records in the table to showing all of the records. Default value is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor selectedRecordsShowAllToggle: boolean;
   /**
    * _(Since 4.23)_ Indicates whether to display the `Show selected records` menu item. Default value is `true` and will display within the menu if any rows are selected.
    *
    * @default true
+   * @since 5.0
    */
   accessor selectedRecordsShowSelectedToggle: boolean;
   /**
    * Indicates whether to enable toggling column visibility within the menu. Default value is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor toggleColumns: boolean;
   /**
    * _(Since 4.23)_ Indicates whether to display the `Zoom to selected` menu item. Default value is `true` and will display within the menu if any rows are selected.
    *
    * @default true
+   * @since 5.0
    */
   accessor zoomToSelection: boolean;
 }

package/widgets/FeatureTable/VisibleElements.d.ts

@@ -4,6 +4,7 @@ import type TableMenuVisibleElements from "./TableMenuVisibleElements.js";
 import type { ColumnMenuVisibleElementsProperties } from "./ColumnMenuVisibleElements.js";
 import type { TableMenuVisibleElementsProperties } from "./TableMenuVisibleElements.js";
 
+/** @since 5.0 */
 export interface VisibleElementsProperties extends Partial<Pick<VisibleElements, "columnDescriptions" | "columnMenus" | "header" | "layerDropdown" | "layerDropdownIcons" | "menu" | "pendingEditsFooter" | "progress" | "selectionColumn" | "tooltips">> {
   /**
    * The menu items within the column menu.
@@ -11,7 +12,11 @@ export interface VisibleElementsProperties extends Partial<Pick<VisibleElements,
    * @since 4.30
    */
   columnMenuItems?: ColumnMenuVisibleElementsProperties;
-  /** The menu items within the feature table menu. */
+  /**
+   * The menu items within the feature table menu.
+   *
+   * @since 5.0
+   */
   menuItems?: TableMenuVisibleElementsProperties;
 }
 
@@ -20,6 +25,8 @@ export interface VisibleElementsProperties extends Partial<Pick<VisibleElements,
  * This provides the ability to turn individual elements of the widget's display on/off.
  *
  * ![featuretable-visibleelements](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/featuretablevisibleelements.png)
+ *
+ * @since 5.0
  */
 export default abstract class VisibleElements extends Accessor {
   /**
@@ -47,6 +54,7 @@ export default abstract class VisibleElements extends Accessor {
    * Indicates whether to display the feature table's header information. Default value is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor header: boolean;
   /**
@@ -67,9 +75,14 @@ export default abstract class VisibleElements extends Accessor {
    * Indicates whether to display the feature table's menu. Default value is `true`.
    *
    * @default true
+   * @since 5.0
    */
   accessor menu: boolean;
-  /** The menu items within the feature table menu. */
+  /**
+   * The menu items within the feature table menu.
+   *
+   * @since 5.0
+   */
   get menuItems(): TableMenuVisibleElements;
   set menuItems(value: TableMenuVisibleElementsProperties);
   /**
@@ -90,6 +103,7 @@ export default abstract class VisibleElements extends Accessor {
    * Indicates whether to display the selection column in the table. Each row has a checkbox that selects its corresponding feature. Default value is `true`. If working with a map, make certain to set the `FeatureTable.view` property as this enables highlighting the corresponding feature.
    *
    * @default true
+   * @since 5.0
    */
   accessor selectionColumn: boolean;
   /**

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

@@ -108,7 +108,7 @@ export default abstract class ColumnTemplateBase extends ColumnTemplateBaseSuper
    */
   accessor iconText: string | null | undefined;
   /**
-   * Use this in combination with [FeatureTable#multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) and {@link widgets/FeatureTable#direction} properties to set sorting functionality on multiple columns. This property indicates the index of the sorted column when compared to other columns, with lower numbers taking a higher priority.
+   * Use this in combination with [FeatureTable#multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) and [direction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#direction) properties to set sorting functionality on multiple columns. This property indicates the index of the sorted column when compared to other columns, with lower numbers taking a higher priority.
    *
    * If no sort priority is set, the priority defaults to the most recently-sorted column. This occurs when sorting via the UI, or programmatically by calling [FeatureTable#sortColumn()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#sortColumn). For example, using the example snippet below, the sort order priority is set for three columns, with "Status" having the least priority. Calling `table.sortColumn("Status", "asc")` would update the `Status` column to the highest priority. This would also occur if manually sorting via the column's UI.
    *