@arcgis/map-components 5.1.0-next.9 → 5.1.0-next.91

package/dist/components/arcgis-feature-table/customElement.d.ts

@@ -1,37 +1,30 @@
 /// <reference path="../../index.d.ts" />
 import type FeatureTable from "@arcgis/core/widgets/FeatureTable.js";
-import type RelationshipColumn from "@arcgis/core/widgets/FeatureTable/RelationshipColumn";
-import type GroupColumn from "@arcgis/core/widgets/FeatureTable/Grid/GroupColumn";
-import type Column from "@arcgis/core/widgets/FeatureTable/Grid/Column";
-import type AttachmentsColumn from "@arcgis/core/widgets/FeatureTable/AttachmentsColumn";
-import type ActionColumn from "@arcgis/core/widgets/FeatureTable/ActionColumn";
+import type RelationshipColumn from "@arcgis/core/widgets/FeatureTable/RelationshipColumn.js";
+import type GroupColumn from "@arcgis/core/widgets/FeatureTable/Grid/GroupColumn.js";
+import type Column from "@arcgis/core/widgets/FeatureTable/Grid/Column.js";
+import type AttachmentsColumn from "@arcgis/core/widgets/FeatureTable/AttachmentsColumn.js";
+import type ActionColumn from "@arcgis/core/widgets/FeatureTable/ActionColumn.js";
 import type LinkChartView from "@arcgis/core/views/LinkChartView.js";
-import type AttachmentsColumn2 from "@arcgis/core/widgets/FeatureTable/AttachmentsColumn.js";
 import type AttributeTableTemplate from "@arcgis/core/tables/AttributeTableTemplate.js";
-import type ActionColumn2 from "@arcgis/core/widgets/FeatureTable/ActionColumn.js";
 import type Collection from "@arcgis/core/core/Collection.js";
-import type Column2 from "@arcgis/core/widgets/FeatureTable/Grid/Column.js";
 import type AttachmentsViewOptions from "@arcgis/core/widgets/FeatureTable/support/AttachmentsViewOptions.js";
 import type FieldColumn from "@arcgis/core/widgets/FeatureTable/FieldColumn.js";
-import type GroupColumn2 from "@arcgis/core/widgets/FeatureTable/Grid/GroupColumn.js";
 import type LayerView from "@arcgis/core/views/layers/LayerView.js";
 import type Relationship from "@arcgis/core/layers/support/Relationship.js";
-import type RelationshipColumn2 from "@arcgis/core/widgets/FeatureTable/RelationshipColumn.js";
+import type SelectionManager from "@arcgis/core/views/SelectionManager.js";
 import type TableTemplate from "@arcgis/core/widgets/FeatureTable/support/TableTemplate.js";
 import type TimeExtent from "@arcgis/core/time/TimeExtent.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
-import type { IconName } from "../../utils/action-utils.js";
-import type { FeatureStoreItem } from "@arcgis/core/widgets/FeatureTable/support/types";
-import type { CollectionChangeEvent } from "@arcgis/core/core/Collection";
-import type { TableInteractionColumnReorderEvent, TableInteractionCellPointeroverEvent, TableInteractionCellPointeroutEvent, TableInteractionCellKeydownEvent, TableInteractionCellClickEvent } from "@arcgis/core/widgets/FeatureTable/Grid/types";
+import type { ArcgisReferenceElement, IconName } from "../types.js";
+import type { FeatureStoreItem, ActionColumnConfig, FeatureTableSupportedFilters, ColumnSortOrder, FeatureTableSupportedLayer } from "@arcgis/core/widgets/FeatureTable/support/types.js";
+import type { CollectionChangeEvent } from "@arcgis/core/core/Collection.js";
+import type { DiscardPendingEditsParameters, FeatureStoreEdits, TableInteractionColumnReorderEvent, TableInteractionCellPointeroverEvent, TableInteractionCellPointeroutEvent, TableInteractionCellKeydownEvent, TableInteractionCellClickEvent, TableMenuConfig, GridMultiSortPriority, FeatureTableState } from "@arcgis/core/widgets/FeatureTable/Grid/types.js";
 import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
-import type { ActionColumnConfig, FeatureTableSupportedFilters, ColumnSortOrder, FeatureTableSupportedLayer } from "@arcgis/core/widgets/FeatureTable/support/types.js";
 import type { FeatureTableDescriptionFunction, FeatureTableTitleFunction } from "@arcgis/core/widgets/FeatureTable.js";
 import type { GeometryUnion } from "@arcgis/core/geometry/types.js";
 import type { ObjectId } from "@arcgis/core/views/types.js";
 import type { Icon } from "@esri/calcite-components/components/calcite-icon";
-import type { TableMenuConfig, GridMultiSortPriority, FeatureTableState } from "@arcgis/core/widgets/FeatureTable/Grid/types.js";
 
 /**
  * The Feature Table component provides an interactive tabular view of each feature's attributes in a feature layer.
@@ -45,7 +38,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    * @since 4.33
    * @see [actionColumnConfig](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#actionColumnConfig)
    */
-  get actionColumn(): ActionColumn2 | null | undefined;
+  get actionColumn(): ActionColumn | null | undefined;
   /**
    * Configuration for the [ActionColumn](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/ActionColumn/).
    * This property allows for customizing the action column's appearance and behavior.
@@ -54,7 +47,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    * viewing additional information about a feature. This column is displayed as the
    * last column in the table and is only displayed if this property is set.
    *
-   * ![featuretable action column](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/action-column.png)
+   * ![featuretable action column](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/featuretable/action-column.avif)
    *
    * @since 4.30
    * @see [actionColumn](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#actionColumn)
@@ -94,7 +87,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    *
    * @since 4.33
    */
-  get allColumns(): Array<Column2>;
+  get allColumns(): Array<Column>;
   /**
    * Indicates the table is displaying all related tables in "show all" mode.
    *
@@ -107,17 +100,17 @@ export abstract class ArcgisFeatureTable extends LitElement {
    *
    * @since 4.33
    */
-  get allVisibleColumns(): Array<Column2>;
+  get allVisibleColumns(): Array<Column>;
   /**
    * A flattened array of all [attachment columns](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/AttachmentsColumn/) within the table, including nested columns.
    *
    * @since 4.33
    */
-  get attachmentsColumns(): Array<AttachmentsColumn2>;
+  get attachmentsColumns(): Array<AttachmentsColumn>;
   /**
    * Indicates whether to display the `Attachments` field in the table. It displays the count of attachments per feature and is only applicable if the feature layer [supports attachments](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities).
    *
-   * ![featuretable attachmentsEnabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/attachments-enabled.png)
+   * ![featuretable attachmentsEnabled](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/featuretable/attachments-enabled.avif)
    *
    * @default false
    * @see [FeatureLayer.capabilities.data.supportsAttachment](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities)
@@ -172,6 +165,20 @@ export abstract class ArcgisFeatureTable extends LitElement {
    * @since 5.0
    */
   get canAddRelatedFeature(): boolean;
+  /**
+   * Indicates whether the primary panel is closed. Once the panel is closed, the panel must be re-opened programmatically.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor closed: boolean;
+  /**
+   * Indicates whether the primary panel is collapsed. This only applies if the 'showCollapse' property has also been set to true.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor collapsed: boolean;
   /**
    * Indicates whether to enable the table's column performance mode.
    * This mode is designed to improve the performance of the table when working with a large number of columns.
@@ -189,7 +196,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    * A read-only collection of column, field, group, action, attachment,
    * and relationship columns that are displayed within the table.
    */
-  get columns(): Collection<Column2>;
+  get columns(): Collection<Column>;
   /**
    * The SQL where clause used to filter features visible in the table. Only the features that satisfy the definition
    * expression are displayed in the table. This value takes priority over any definition expression set on the
@@ -205,7 +212,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    */
   accessor description: string | FeatureTableDescriptionFunction | null | undefined;
   /**
-   * When true, the component is visually withdrawn and cannot be interacted with.
+   * When true, the component is visually withdrawn and cannot receive user interaction.
    *
    * @default false
    * @since 5.0
@@ -241,6 +248,15 @@ export abstract class ArcgisFeatureTable extends LitElement {
    * @see [Sample - FeatureTable with related data](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-relates/)
    */
   accessor filterBySelectionEnabled: boolean;
+  /**
+   * Indicates that the table should only display rows for features that are currently in the view's extent.
+   * This property has no effect if the table has not been provided a view. If this property is true, the view's extent
+   * will overwrite the current value of [filterGeometry](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#filterGeometry).
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor filterByViewExtent: boolean;
   /**
    * Set this property to filter the features displayed in the table. It accepts a [Geometry](https://developers.arcgis.com/javascript/latest/references/core/geometry/Geometry/), e.g. [Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/), and uses it as a spatial filter. When modifying this property, the `FeatureTable` will completely refresh and re-query for all features.
    *
@@ -268,7 +284,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    *
    * @since 4.33
    */
-  get groupColumns(): Array<GroupColumn2>;
+  get groupColumns(): Array<GroupColumn>;
   /**
    * Convenience property indicating the data set contains contingent values. This includes contingent values in a related table.
    *
@@ -329,27 +345,55 @@ export abstract class ArcgisFeatureTable extends LitElement {
    */
   accessor hideColumnDescriptions: boolean;
   /**
-   * Indicates whether to display the Sort Ascending menu item.
+   * Indicates whether to display the 'Sort Ascending' menu item in column menus.
    *
    * @default false
    * @since 5.0
    */
   accessor hideColumnMenuItemsSortAscending: boolean;
   /**
-   * Indicates whether to display the Sort Descending menu item.
+   * Indicates whether to display the 'Sort Descending' menu item in column menus.
    *
    * @default false
    * @since 5.0
    */
   accessor hideColumnMenuItemsSortDescending: boolean;
   /**
-   * Indicates whether to display the menu items within the individual columns
+   * Indicates whether to display the menu items within the individual columns.
    *
    * @default false
    */
   accessor hideColumnMenus: boolean;
   /**
-   * Indicates whether to display the feature table's header information.
+   * Indicates whether to display the column visibility menu in the table header.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor hideColumnVisibilityMenu: boolean;
+  /**
+   * Indicates whether to display the filter in column visibility menu.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor hideColumnVisibilityMenuItemsFilter: boolean;
+  /**
+   * Indicates whether to display the header in column visibility menu.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor hideColumnVisibilityMenuItemsHeader: boolean;
+  /**
+   * Indicates whether to display the 'toggle all' button in column visibility menu.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor hideColumnVisibilityMenuItemsToggleAll: boolean;
+  /**
+   * Indicates whether to display the feature table's header.
    *
    * @default false
    * @since 5.0
@@ -369,28 +413,28 @@ export abstract class ArcgisFeatureTable extends LitElement {
    */
   accessor hideMenu: boolean;
   /**
-   * Indicates whether to display the Clear selection menu item.
+   * Indicates whether to display the 'Clear selection' menu item.
    *
    * @default false
    * @since 5.0
    */
   accessor hideMenuItemsClearSelection: boolean;
   /**
-   * Indicates whether to display the Delete Selection menu item.
+   * Indicates whether to display the' Delete Selection' menu item.
    *
    * @default false
    * @since 5.0
    */
   accessor hideMenuItemsDeleteSelection: boolean;
   /**
-   * Indicates whether to display the Export selection to CSV menu item.
+   * Indicates whether to display the 'Export selection to CSV' menu item.
    *
    * @default false
    * @since 5.0
    */
   accessor hideMenuItemsExportSelectionToCsv: boolean;
   /**
-   * Indicates whether to display the Refresh data menu item.
+   * Indicates whether to display the 'Refresh data' menu item.
    *
    * @default false
    * @since 5.0
@@ -404,21 +448,22 @@ export abstract class ArcgisFeatureTable extends LitElement {
    */
   accessor hideMenuItemsSelectedRecordsShowAllToggle: boolean;
   /**
-   * Indicates whether to display the Show selected records menu item.
+   * Indicates whether to display the 'Show selected records' menu item.
    *
    * @default false
    * @since 5.0
    */
   accessor hideMenuItemsSelectedRecordsShowSelectedToggle: boolean;
   /**
-   * Indicates whether to enable toggling column visibility within the menu.
+   * Indicates whether to display the column visibility menu in the table header.
    *
+   * @deprecated since 5.1. Use the 'hideColumnVisibilityMenu' property instead.
    * @default false
    * @since 5.0
    */
   accessor hideMenuItemsToggleColumns: boolean;
   /**
-   * Indicates whether to display the Zoom to selected menu item.
+   * Indicates whether to display the 'Zoom to selection' menu item.
    *
    * @default false
    * @since 5.0
@@ -536,7 +581,14 @@ export abstract class ArcgisFeatureTable extends LitElement {
    */
   accessor layer: FeatureTableSupportedLayer | null | undefined;
   /**
-   * Portal Item Id for a layer to load. You can set, `layer`, `layerUrl`, or `itemId`,
+   * Layer Id of layer in the associated map. You can set `layer`, `layerId` or `layerItemId`,
+   * but not more than one.
+   *
+   * @since 5.1
+   */
+  accessor layerId: string | undefined;
+  /**
+   * Portal Item Id for a layer to load. You can set, `layer`, `layerUrl`, `layerId` or `layerItemId`,
    * but not more than one.
    */
   accessor layerItemId: string | undefined;
@@ -548,7 +600,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    */
   accessor layers: Array<FeatureTableSupportedLayer> | null | undefined;
   /**
-   * Url for a layer to load. You can set, `layer`, `layerUrl`, or `itemId`,
+   * Url for a layer to load. You can set, `layer`, `layerUrl`, `layerId` or `layerItemId`,
    * but not more than one.
    */
   accessor layerUrl: string | undefined;
@@ -730,7 +782,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    *
    * @since 4.33
    */
-  get relationshipColumns(): Array<RelationshipColumn2>;
+  get relationshipColumns(): Array<RelationshipColumn>;
   /**
    * Indicates whether to fetch geometries for the corresponding features displayed in the table.
    *
@@ -793,6 +845,28 @@ export abstract class ArcgisFeatureTable extends LitElement {
    * });
    */
   accessor rowHighlightIds: Collection<ObjectId>;
+  /**
+   * Use this property to supply a custom [SelectionManager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) that overrides the default selection manager.
+   * This is useful when applications want to share selection sets between components, without relying on the view's selection manager. This property is ignored if [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#syncViewSelection) is `true`.
+   *
+   * @since 5.0
+   * @beta
+   */
+  accessor selectionManager: SelectionManager | null | undefined;
+  /**
+   * Indicates whether to display a close button in the table panel header.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor showClose: boolean;
+  /**
+   * Indicates whether to display a collapse button in the table panel header.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor showCollapse: boolean;
   /**
    * Indicates whether to display the feature table's layer switch drop down menu.
    *
@@ -863,6 +937,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    *
    * @default false
    * @since 5.0
+   * @beta
    */
   accessor syncViewSelection: boolean;
   /**
@@ -889,7 +964,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    *
    * > [!WARNING]
    * >
-   * > The `TableTemplate` provides more fine-grained control over how the table is rendered within the application by offering more advanced configurations such as custom cell rendering, column formatting, and more. `TableTemplate` is useful for application-level development that remains within an application. This property differs from the [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#attributeTableTemplate) property as that property should be used to access the table's settings across different applications. By using [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#attributeTableTemplate), the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/tables/AttributeTableTemplate/) and [TableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/TableTemplate/)  documentation for more information.
+   * > The `TableTemplate` provides more fine-grained control over how the table is rendered within the application by offering more advanced configurations such as custom cell rendering, column formatting, and more. `TableTemplate` is useful for application-level development that remains within an application. This property differs from the [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#attributeTableTemplate) property as that property should be used to access the table's settings across different applications. By using [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#attributeTableTemplate), the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/tables/AttributeTableTemplate/) and [TableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/TableTemplate/) documentation for more information.
    *
    * > [!WARNING]
    * >
@@ -965,17 +1040,62 @@ export abstract class ArcgisFeatureTable extends LitElement {
    * The view associated with the component. 
    *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-feature-table component will be associated with a map or scene component rather than using the `view` property.
    */
-  accessor view: MapViewOrSceneView | LinkChartView | null | undefined;
+  accessor view: LinkChartView | MapViewOrSceneView | null | undefined;
   /**
    * A flattened array of all top-level visible columns. Take note that this does not include nested columns.
    *
    * @since 4.33
    */
-  get visibleColumns(): Array<Column2>;
+  get visibleColumns(): Array<Column>;
+  /**
+   * Creates a pending edit with the specified parameters.
+   * A pending edit is not immediately saved to the layer.
+   *
+   * @param edits - Pending edits to be cached. Edits must include a valid objectId and field name.
+   * @since 5.0
+   * @example
+   * // Add pending edits for two cells in a single row
+   * table.addPendingEdits(
+   *   [
+   *     {
+   *       objectId: 1,
+   *       updates: [
+   *         { fieldName: "Hotel_Name", value: "My Hotel" },
+   *         { fieldName: "Address", value: "123 Hotel Street" },
+   *       ]
+   *     }
+   *   ]
+   * );
+   */
+  addPendingEdits(edits: FeatureStoreEdits[]): void;
   /** @param showWarningPrompt */
   deleteSelection(showWarningPrompt?: boolean): Promise<void>;
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
+  /**
+   * Cancels any pending edits. This might be edits for a specific field or column, or
+   * all pending edits for a specific feature. If no parameters are supplied, all pending edits
+   * for all features are discarded. Additionally, if showWarningPrompt is 'true', the value returned
+   * from this method will reflect whether or not the user chose to discard the pending edits.
+   *
+   * @param edits - Information about which pending edits should be canceled. If nothing is provided, all pending edits are discarded.
+   * @param showWarningPrompt - Indicates the table should display a warning prompt, which allows users to confirm if pending edits should be discarded.
+   * @since 5.0
+   * @example
+   * // Discard pending edits for single cell in a given row
+   * table.discardPendingEdits([{ objectId: 1, fieldName: "Address" }]);
+   *
+   * // Discard pending edits for all cells in a given row
+   * table.discardPendingEdits([{ objectId: 1 }]);
+   *
+   * // Discard all pending edits
+   * table.discardPendingEdits();
+   *
+   * // Displays a confirmation prompt before discarding all pending edits
+   * // Returns 'true' if edits were discarded
+   * const editsWereDiscarded = await table.discardPendingEdits(undefined, true);
+   */
+  discardPendingEdits(edits?: DiscardPendingEditsParameters[] | null, showWarningPrompt?: boolean): Promise<boolean>;
   /** @param includeGeometry */
   exportSelectionToCSV(includeGeometry?: boolean): Promise<void>;
   /** @param fieldName */
@@ -986,7 +1106,7 @@ export abstract class ArcgisFeatureTable extends LitElement {
    * @param objectId
    * @since 5.0
    */
-  getFeatureStoreItemByObjectId(objectId: number | string): FeatureStoreItem | null | undefined;
+  getFeatureStoreItemByObjectId(objectId: number | string): Promise<FeatureStoreItem | null | undefined>;
   /** @param index */
   goToPage(index: number): Promise<void>;
   /** @param fieldName */
@@ -994,6 +1114,14 @@ export abstract class ArcgisFeatureTable extends LitElement {
   nextPage(): Promise<void>;
   previousPage(): Promise<void>;
   refresh(): Promise<void>;
+  refreshCellContent(): Promise<void>;
+  /**
+   * Attempts to save any pending edits. If any edits are invalid, the save will be rejected until the edits are in a valid state.
+   *
+   * @returns Resolves when the edits are saved or rejected.
+   * @since 5.0
+   */
+  savePendingEdits(): Promise<void>;
   scrollToBottom(): Promise<void>;
   /** @param index */
   scrollToIndex(index: number): Promise<void>;
@@ -1009,6 +1137,8 @@ export abstract class ArcgisFeatureTable extends LitElement {
    * @param direction
    */
   sortColumn(path: string, direction: "asc" | "desc"): Promise<void>;
+  /** @param fieldName */
+  toggleColumnVisibility(fieldName: string): Promise<void>;
   zoomToSelection(): Promise<void>;
   "@setterTypes": {
     icon?: IconName;