@arcgis/core 5.0.0-next.51 → 5.0.0-next.53

package/widgets/FeatureTable/FeatureTableViewModel.d.ts

@@ -1,4 +1,1097 @@
-import "../../interfaces";
+import type Collection from "../../core/Collection.js";
+import type Relationship from "../../layers/support/Relationship.js";
+import type AttributeTableTemplate from "../../tables/AttributeTableTemplate.js";
+import type TimeExtent from "../../time/TimeExtent.js";
+import type LinkChartView from "../../views/LinkChartView.js";
+import type LayerView from "../../views/layers/LayerView.js";
+import type FeatureTable from "../FeatureTable.js";
+import type ActionColumn from "./ActionColumn.js";
+import type AttachmentsColumn from "./AttachmentsColumn.js";
+import type FieldColumn from "./FieldColumn.js";
+import type RelationshipColumn from "./RelationshipColumn.js";
+import type GridViewModel from "./Grid/GridViewModel.js";
+import type GroupColumn from "./Grid/GroupColumn.js";
+import type AttachmentsViewOptions from "./support/AttachmentsViewOptions.js";
+import type TableTemplate from "./support/TableTemplate.js";
+import type { ReadonlyArrayOrCollection } from "../../core/Collection.js";
+import type { GeometryUnion } from "../../geometry/support/typeUtils.js";
+import type { FieldValue } from "../../layers/support/fieldUtils.js";
+import type { TimeZone } from "../../time/interfaces.js";
+import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
+import type { ObjectId } from "../../views/IObjectId.js";
+import type { GridViewModelProperties } from "./Grid/GridViewModel.js";
+import type { GridMultiSortPriority, GridSupportedColumns, FeatureTableState, TableInteractionCellClickEvent, TableInteractionCellDblclickEvent, TableInteractionCellKeydownEvent, TableInteractionCellPointeroverEvent, TableInteractionColumnReorderEvent, TableInteractionCellPointeroutEvent } from "./Grid/interfaces.js";
+import type { TableMenuConfig } from "./Grid/support/interfaces.js";
+import type { ColumnSortOrder, FeatureTableSupportedColumn as SupportedColumn, FeatureTableSupportedFilters as SupportedFilters, FeatureTableSupportedLayer, ActionColumnConfig } from "./support/interfaces.js";
+import type { AttributeTableTemplateProperties } from "../../tables/AttributeTableTemplate.js";
+import type { MeshProperties } from "../../geometry/Mesh.js";
+import type { PolylineProperties } from "../../geometry/Polyline.js";
+import type { PolygonProperties } from "../../geometry/Polygon.js";
+import type { PointProperties } from "../../geometry/Point.js";
+import type { MultipointProperties } from "../../geometry/Multipoint.js";
+import type { ExtentProperties } from "../../geometry/Extent.js";
+import type { TableTemplateProperties } from "./support/TableTemplate.js";
+import type { TimeExtentProperties } from "../../time/TimeExtent.js";
 
-import FeatureTableViewModel = __esri.FeatureTableViewModel;
-export default FeatureTableViewModel;
+export interface FeatureTableViewModelProperties extends GridViewModelProperties, Partial<Pick<FeatureTableViewModel, "actionColumnConfig" | "attachmentsEnabled" | "autoRefreshEnabled" | "columnPerformanceModeEnabled" | "columnReorderingEnabled" | "definitionExpression" | "editingEnabled" | "filterBySelectionEnabled" | "highlightEnabled" | "initialSize" | "layer" | "maxSize" | "menuConfig" | "multipleSelectionEnabled" | "multipleSortPriority" | "multiSortEnabled" | "outFields" | "pageIndex" | "pageSize" | "paginationEnabled" | "relatedRecordsEnabled" | "relatedTables" | "returnGeometryEnabled" | "returnMEnabled" | "returnZEnabled" | "syncTemplateOnChangesEnabled" | "timeZone" | "view">> {
+  /**
+   * Use this property to configure how columns display within the table in regard to visibility, column order, and sorting.
+   *
+   * > [!WARNING]
+   * >
+   * > This property differs from the [tableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#tableTemplate) property. The `tableTemplate` property 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. It is useful for application-level development that remains within an application. Use the [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#attributeTableTemplate) property to access the table's settings across different applications. By using this property, the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-tables-AttributeTableTemplate.html) and [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) documentation for more information.
+   *
+   * @since 4.31
+   * @see [Sample - FeatureTable Component](https://developers.arcgis.com/javascript/latest/sample-code/feature-table/)
+   */
+  attributeTableTemplate?: AttributeTableTemplateProperties | null;
+  /**
+   * Set this property to filter the features displayed in the table. It accepts a [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html), e.g. [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html), and uses it as a spatial filter. When modifying this property, the FeatureTable will completely refresh and re-query for all features.
+   *
+   * @since 4.19
+   * @see [Sample - FeatureTable using a map](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-map/)
+   * @example
+   * // Listen for when the view is updated. If so, pass the new
+   * // view.extent into the table's filterGeometry.
+   *
+   * await whenOnce(() => featureLayer.loaded);
+   *
+   * reactiveUtils.when(
+   *   () => view.stationary === false && !!view.extent,
+   *   () => {
+   *     // Filter and show only the visible features in the feature table
+   *     featureTable.viewModel.filterGeometry = view.extent;
+   *   },
+   *   { initial: true }
+   * );
+   */
+  filterGeometry?: ((ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" })) | null;
+  /**
+   * A collection of string [field.names](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) that are to remain hidden within the table. By default fields such as `CreationDate`, `Creator`, `EditDate`, `Editor`, and `GlobalID` do not show. If these fields are needed, set them via [TableTemplate#columnTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html#columnTemplates). In this case, it is also required that the column template's [FieldColumnTemplate#visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#visible) property is set to `true`.
+   *
+   * @default true
+   * @since 4.16
+   * @see [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html)
+   * @see [viewModel: { // autocasts as new FeatureTableViewModel layer: featureLayer, tableTemplate: tableTemplate //autocasts as new TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html)}
+   * @example
+   * const featureTableVM = new FeatureTableViewModel({
+   *   layer: featureLayer,
+   *   hiddenFields: ["Primary_Type", "incident_date"], // will not show these two fields within the table
+   *   },
+   *   container: document.getElementById("tableDiv")
+   * });
+   * @example
+   * // Set this syntax if needing to display a default hidden field, e.g. 'CreationDate`
+   * const featureTableVM = new FeatureTableViewModel({
+   *   layer: featureLayer,
+   *   tableTemplate: { // autocasts to TableTemplate
+   *     customTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate
+   *     { //autocasts to FieldColumnTemplate
+   *       type: "field",
+   *       fieldName: "CreationDate",
+   *       label: "Date created",
+   *       visible: true
+   *     }]
+   *   },
+   *   container: document.getElementById("tableDiv")
+   * });
+   */
+  hiddenFields?: ReadonlyArrayOrCollection<string>;
+  /**
+   * This property accepts and returns a collection of feature object IDs. Use this to access and control which features are currently selected in the table and subsequently highlighted within the map. Once an application sets a collection of object IDs, the table will select the corresponding row and highlight its feature within the map.
+   *
+   * @since 4.25
+   * @see [highlightEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightEnabled)
+   * @see [rowHighlightIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#rowHighlightIds)
+   * @see [Sample - FeatureTable using a map](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-map/)
+   * @example
+   * // This example instantiates the table with highlighted features
+   * const featureTable = new FeatureTable({
+   *   view: view,
+   *   layer: featureLayer,
+   *   container: "tableDiv",
+   *   highlightIds
+   * });
+   *
+   * // Push the object ids into a collection and select
+   * featureTable.viewModel.highlightIds.push(2, 3, 4);
+   *
+   * // Listen for changes in the collection of highlighted features
+   * featureTable.viewModel.highlightIds.on("change", (event) => {
+   *   console.log("features selected", event.added);
+   *   console.log("features deselected", event.removed);
+   * });
+   */
+  highlightIds?: ReadonlyArrayOrCollection<ObjectId>;
+  /**
+   * This property accepts and returns a collection of feature object IDs. Use this to access and control which features are currently visible in the table.
+   * When the collection is empty, all potential rows are displayed. Modifying object IDs is not supported while [filterBySelectionEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelectionEnabled) is `true` as these properties are mutually exclusive.
+   * This filter can also be combined with [filterGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterGeometry) to display features that satisfy both conditions.
+   *
+   * @since 4.30
+   */
+  objectIds?: ReadonlyArrayOrCollection<ObjectId>;
+  /**
+   * This property accepts and returns a collection of feature object IDs. It is used to access and control which rows display a darker background, i.e., highlighted. Take note that highlighted rows are not considered selected as this property is independent of the table's selection state. Use the [highlightIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightIds) property to choose rows. Setting `rowHighlightIds` applies an alternative highlight style to an entire row or rows.
+   *
+   * @since 4.30
+   * @see [highlightEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightEnabled)
+   * @see [highlightIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightIds)
+   */
+  rowHighlightIds?: ReadonlyArrayOrCollection<ObjectId>;
+  /**
+   * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) used for the feature table.
+   *
+   * The [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) is where you configure how the feature table should display and set any associated properties for the table and its columns.
+   *
+   * > [!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/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#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/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#attributeTableTemplate), the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-tables-AttributeTableTemplate.html) and [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) documentation for more information.
+   *
+   * > [!WARNING]
+   * >
+   * > Take note that it is required to set the `type` property when creating column templates.
+   *
+   * @since 4.24
+   * @example
+   * const tableTemplate = new TableTemplate({
+   *   columnTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate
+   *   { // autocasts to FieldColumnTemplate
+   *     type: "field",
+   *     fieldName: "ObjectId",
+   *     direction: "asc", // In order to use initialSortPriority, make sure direction is set
+   *     initialSortPriority: 1 // This field's sort order takes the second-highest priority.
+   *   },
+   *   {
+   *     type: "field",
+   *     fieldName: "NAME",
+   *     label: "Name",
+   *     asc: "asc", // In order to use initialSortPriority, make sure direction is set
+   *     initialSortPriority: 0 // This field's sort order takes the highest priority
+   *    },
+   *    {
+   *      type: "field",
+   *      fieldName: "STATUS",
+   *      label: "Status",
+   *      direction: "asc", // In order to use initialSortPriority, make sure direction is set
+   *      initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.
+   *    }
+   *   ]
+   * });
+   */
+  tableTemplate?: TableTemplateProperties | null;
+  /**
+   * The [TimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-time-TimeExtent.html) in which to filter and display data within the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget. Setting this property directly on the viewModel or its [widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeExtent) takes precedence over the layer's [FeatureLayer#timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeExtent). If this property is set directly on the [widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeExtent), the table will not refresh when the layer's [TimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-time-TimeExtent.html) changes.
+   *
+   * @since 4.30
+   * @see [FeatureLayer#timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeExtent)
+   * @example
+   * // Filters the table to display only features that fit within the time extent
+   * reactiveUtils.watch(
+   *   () => timeSlider.timeExtent,
+   *   (extent) => {
+   *     featureTable.viewModel.timeExtent = extent;
+   *   }
+   * );
+   */
+  timeExtent?: TimeExtentProperties | null;
+}
+
+export interface FeatureTableViewModelEvents {
+  /**
+   * Fires when a cell within the table is clicked.
+   *
+   * @since 4.30
+   * @example
+   * // This snippet removes the selection column and adds an event listener
+   * // which toggles the selection of a feature when a cell is clicked.
+   * featureTable.visibleElements.selectionColumn = false;
+   * featureTable.on("cell-click", (event) => {
+   *  if (featureTable.highlightIds.includes(event.objectId)) {
+   *    featureTable.highlightIds.remove(event.objectId);
+   *  }
+   *  else {
+   *    featureTable.highlightIds.push(event.objectId);
+   *  }
+   * });
+   */
+  "cell-click": TableInteractionCellClickEvent;
+  /**
+   * Fires when a cell within the table is double-clicked.
+   *
+   * @since 4.31
+   */
+  "cell-dblclick": TableInteractionCellDblclickEvent;
+  /**
+   * Fires when a key is pressed down within a cell within the table.
+   *
+   * @since 4.30
+   * @example
+   * // The following snippet listens for the Enter key to be pressed within a cell and zooms
+   * // to the feature associated with the row.
+   * featureTable.on("cell-keydown", (event) => {
+   *  if (event.native.key === "Enter") {
+   *    view.goTo(event.feature);
+   *  }
+   * });
+   */
+  "cell-keydown": TableInteractionCellKeydownEvent;
+  /**
+   * Fires when the mouse pointer is moved out of a cell within the table. This event is useful for scenarios highlighting for things like highlighting a feature in the view, while hovering, without requiring manual interaction to select a row. Another example: these events can also be used to show information about the cell in a tooltip attached to the mouse.
+   *
+   * @since 4.30
+   */
+  "cell-pointerout": TableInteractionCellPointeroutEvent;
+  /**
+   * Fires when the mouse pointer is moved over a cell within the table.
+   *
+   * @since 4.30
+   */
+  "cell-pointerover": TableInteractionCellPointeroverEvent;
+  /**
+   * Fires when a column is reordered via drag-and-drop.
+   *
+   * @since 4.31
+   */
+  "column-reorder": TableInteractionColumnReorderEvent;
+}
+
+/**
+ * Provides the logic for the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget and [component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-table/), which allows users to view content from feature attributes in a tabular format.
+ *
+ * @since 4.15
+ * @see [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget
+ * @see [Feature Table component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-table/)
+ * @example
+ * const featureTable = new FeatureTable({
+ *   viewModel: { // autocasts as new FeatureTableViewModel
+ *     layer: featureLayer,
+ *     tableTemplate: tableTemplate //autocasts as new TableTemplate
+ *   }
+ * });
+ */
+export default class FeatureTableViewModel extends GridViewModel {
+  /**
+   * @deprecated
+   * Do not directly reference this property.
+   * Use EventNames and EventTypes helpers from \@arcgis/core/Evented
+   */
+  "@eventTypes": FeatureTableViewModelEvents;
+  constructor(properties?: FeatureTableViewModelProperties);
+  /**
+   * Reference to the current [action column](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-ActionColumn.html). This column is only generated if a [configuration](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#actionColumnConfig) has been provided.
+   *
+   * @since 4.33
+   * @see [actionColumnConfig](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#actionColumnConfig)
+   */
+  get actionColumn(): ActionColumn | null | undefined;
+  /**
+   * Configuration for the [ActionColumn](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-ActionColumn.html).
+   * This property allows for customizing the action column's appearance and behavior.
+   * The action column is a column that contains interactive buttons for each row.
+   * These buttons can be used to perform actions such as editing, deleting, or
+   * 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)
+   *
+   * @since 4.30
+   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+   * @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 = {
+   *   label: "Go to feature",
+   *    icon: "zoom-to-object",
+   *    callback: (params) => {
+   *     view.goTo(params.feature);
+   *  }
+   * }
+   */
+  actionColumnConfig?: ActionColumnConfig | null;
+  /**
+   * A read-only property indicating the type of filter used by the table. It returns either filters by geometry or selections using a row's object ID.
+   *
+   * @since 4.23
+   * @see [Sample - FeatureTable using a map](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-map/)
+   */
+  get activeFilters(): Collection<SupportedFilters>;
+  /**
+   * 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-interfaces.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-interfaces.html#ColumnSortOrder) if [multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#multiSortEnabled) is `true` with a set {@link widgets/FeatureTable/FeatureTableViewModel#initialSortPriority}.
+   *
+   * @default []
+   * @since 4.25
+   */
+  get activeSortOrders(): ColumnSortOrder[];
+  /**
+   * A flattened array of all [columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html) within the table, including nested columns. Take note that [group columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-GroupColumn.html) are separate entries. This property is useful when applying
+   * updates to all columns, including nested columns, as it provides ease of use when iterating through all columns in the table.
+   *
+   * @since 4.33
+   */
+  get allColumns(): GridSupportedColumns[];
+  /**
+   * Indicates the table is displaying all related tables in `show all` mode.
+   *
+   * @since 4.31
+   */
+  get allRelatedTablesVisible(): boolean;
+  /**
+   * A flattened array of all visible [columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html) within the table, including nested columns. [Group columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-GroupColumn.html) are separate entries.
+   *
+   * @since 4.33
+   */
+  get allVisibleColumns(): GridSupportedColumns[];
+  /**
+   * A flattened array of all [attachment columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-AttachmentsColumn.html) within the table, including nested columns.
+   *
+   * @since 4.33
+   */
+  get attachmentsColumns(): 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/api-reference/esri-layers-FeatureLayer.html#capabilities).
+   *
+   * ![featuretable attachmentsEnabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/attachments-enabled.png)
+   *
+   * @default false
+   * @see [FeatureLayer.capabilities.data.supportsAttachment](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities)
+   */
+  accessor attachmentsEnabled: boolean;
+  /**
+   * This read-only property provides the the configuration options for the attachments view.
+   *
+   * @since 4.33
+   * @see [Sample - FeatureTable with editing and attachments enabled](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-editing/)
+   */
+  get attachmentsViewOptions(): AttachmentsViewOptions;
+  /**
+   * Use this property to configure how columns display within the table in regard to visibility, column order, and sorting.
+   *
+   * > [!WARNING]
+   * >
+   * > This property differs from the [tableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#tableTemplate) property. The `tableTemplate` property 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. It is useful for application-level development that remains within an application. Use the [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#attributeTableTemplate) property to access the table's settings across different applications. By using this property, the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-tables-AttributeTableTemplate.html) and [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) documentation for more information.
+   *
+   * @since 4.31
+   * @see [Sample - FeatureTable Component](https://developers.arcgis.com/javascript/latest/sample-code/feature-table/)
+   */
+  get attributeTableTemplate(): AttributeTableTemplate | null | undefined;
+  set attributeTableTemplate(value: AttributeTableTemplateProperties | null | undefined);
+  /**
+   * Indicates whether the table should automatically refresh when the underlying data changes. This property is useful when the table is displaying data from a feature layer that is being updated by other clients.
+   *
+   * @default true
+   * @since 4.23
+   */
+  accessor autoRefreshEnabled: 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.
+   *
+   * @default true
+   * @since 4.33
+   */
+  columnPerformanceModeEnabled: boolean;
+  /**
+   * Indicates if columns can be reordered by dragging the column's header.
+   *
+   * @default true
+   * @since 4.33
+   */
+  columnReorderingEnabled: boolean;
+  /**
+   * A read-only collection of [Column](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html), [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html), [group](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-GroupColumn.html), [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-ActionColumn.html), [attachment](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-AttachmentsColumn.html), and [relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-RelationshipColumn.html) columns that are displayed within the table.
+   *
+   * By default fields such as `CreationDate`, `Creator`, `EditDate`, `Editor`, and `GlobalID` do not show. If these fields are needed, set them via [TableTemplate#columnTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html#columnTemplates). In this scenario, it is also necessary to set the column template's `visible` property to `true`.
+   *
+   * @see [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html)
+   */
+  get columns(): Collection<SupportedColumn>;
+  /**
+   * 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
+   * associated layer.
+   *
+   * @since 4.33
+   */
+  accessor definitionExpression: string | null | undefined;
+  /**
+   * Indicates whether editing is enabled on the data within the feature table. Double-clicking in a cell will enable editing for that value.
+   *
+   * Editing permissions can be separated into the following levels of priority:
+   *
+   * 1. [FeatureLayer#editingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#editingEnabled) - This is derived from the layer's [FeatureLayer#editingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#editingEnabled) property. This must always be `true` for editing to be enabled.
+   * 2. [Field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) - This is derived from the [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). It takes what is set in the [Field#editable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#editable) property. This must always be `true` for editing to be enabled, although it can be overridden to `false` (not vice-versa) via a [field column template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#editable).
+   * 3. [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) - The [FeatureTable#editingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#editingEnabled) property must be set on the table in order for any type of editing to be enabled.
+   * 4. [Template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#editable) - The editable permissions on a field can be configured by setting the
+   * [FieldColumnTemplate#editable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#editable) property of the [FieldColumnTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html).
+   *
+   * > [!WARNING]
+   * >
+   * > If the service's field is not editable, it is not possible to override its permissions using any of the options above.
+   * > [FieldColumnTemplate#editable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#editable) can never override what is set on the layer, field, or table.
+   *
+   * ![featuretable editing](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/editing.png)
+   *
+   * @default false
+   * @since 4.16
+   * @see [Editing within the FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#editing-in-featuretable)
+   * @see [Sample - FeatureTable with editing enabled](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-editing/)
+   * @see [Sample - FeatureTable with related data](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-relates/)
+   */
+  accessor editingEnabled: boolean;
+  /**
+   * The total number of records displayed in the table's current view. Normally, this is equivalent to [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#size) for default configurations.
+   * If [paginationEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#paginationEnabled) is true, `effectiveSize` reflects the total number of visible rows for the current page.
+   * This value is usually equivalent to [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#pageSize) unless viewing the last page of data. The last page may display less features
+   * than the maximum number for a single page. This property also takes into account all [active filters](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#activeFilters) and the current value
+   * of [maxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#maxSize).
+   *
+   * @since 4.31
+   */
+  get effectiveSize(): number;
+  /**
+   * A flattened array of all [field columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html) within the table, including nested columns.
+   *
+   * @since 4.33
+   */
+  get fieldColumns(): FieldColumn[];
+  /**
+   * Indicates whether the table only displays rows that are considered selected. Row selection can be modified by adding or removing associated object IDs from [FeatureTable#highlightIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightIds). This will cause the store to fetch fresh features to ensure the expected sort order is honored.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor filterBySelectionEnabled: boolean;
+  /**
+   * Set this property to filter the features displayed in the table. It accepts a [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html), e.g. [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html), and uses it as a spatial filter. When modifying this property, the FeatureTable will completely refresh and re-query for all features.
+   *
+   * @since 4.19
+   * @see [Sample - FeatureTable using a map](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-map/)
+   * @example
+   * // Listen for when the view is updated. If so, pass the new
+   * // view.extent into the table's filterGeometry.
+   *
+   * await whenOnce(() => featureLayer.loaded);
+   *
+   * reactiveUtils.when(
+   *   () => view.stationary === false && !!view.extent,
+   *   () => {
+   *     // Filter and show only the visible features in the feature table
+   *     featureTable.viewModel.filterGeometry = view.extent;
+   *   },
+   *   { initial: true }
+   * );
+   */
+  get filterGeometry(): GeometryUnion | null | undefined;
+  set filterGeometry(value: ((ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" })) | null | undefined);
+  /**
+   * A flattened array of all [group columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-GroupColumn.html) within the table.
+   *
+   * @since 4.33
+   */
+  get groupColumns(): GroupColumn[];
+  /**
+   * A collection of string [field.names](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) that are to remain hidden within the table. By default fields such as `CreationDate`, `Creator`, `EditDate`, `Editor`, and `GlobalID` do not show. If these fields are needed, set them via [TableTemplate#columnTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html#columnTemplates). In this case, it is also required that the column template's [FieldColumnTemplate#visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#visible) property is set to `true`.
+   *
+   * @default true
+   * @since 4.16
+   * @see [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html)
+   * @see [viewModel: { // autocasts as new FeatureTableViewModel layer: featureLayer, tableTemplate: tableTemplate //autocasts as new TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html)}
+   * @example
+   * const featureTableVM = new FeatureTableViewModel({
+   *   layer: featureLayer,
+   *   hiddenFields: ["Primary_Type", "incident_date"], // will not show these two fields within the table
+   *   },
+   *   container: document.getElementById("tableDiv")
+   * });
+   * @example
+   * // Set this syntax if needing to display a default hidden field, e.g. 'CreationDate`
+   * const featureTableVM = new FeatureTableViewModel({
+   *   layer: featureLayer,
+   *   tableTemplate: { // autocasts to TableTemplate
+   *     customTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate
+   *     { //autocasts to FieldColumnTemplate
+   *       type: "field",
+   *       fieldName: "CreationDate",
+   *       label: "Date created",
+   *       visible: true
+   *     }]
+   *   },
+   *   container: document.getElementById("tableDiv")
+   * });
+   */
+  get hiddenFields(): Collection<string>;
+  set hiddenFields(value: ReadonlyArrayOrCollection<string>);
+  /**
+   * Indicates whether to highlight the associated feature when a row is selected. In order for this to work as expected, the table must be associated with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
+   * @default true
+   * @since 4.25
+   */
+  accessor highlightEnabled: boolean;
+  /**
+   * This property accepts and returns a collection of feature object IDs. Use this to access and control which features are currently selected in the table and subsequently highlighted within the map. Once an application sets a collection of object IDs, the table will select the corresponding row and highlight its feature within the map.
+   *
+   * @since 4.25
+   * @see [highlightEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightEnabled)
+   * @see [rowHighlightIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#rowHighlightIds)
+   * @see [Sample - FeatureTable using a map](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-map/)
+   * @example
+   * // This example instantiates the table with highlighted features
+   * const featureTable = new FeatureTable({
+   *   view: view,
+   *   layer: featureLayer,
+   *   container: "tableDiv",
+   *   highlightIds
+   * });
+   *
+   * // Push the object ids into a collection and select
+   * featureTable.viewModel.highlightIds.push(2, 3, 4);
+   *
+   * // Listen for changes in the collection of highlighted features
+   * featureTable.viewModel.highlightIds.on("change", (event) => {
+   *   console.log("features selected", event.added);
+   *   console.log("features deselected", event.removed);
+   * });
+   */
+  get highlightIds(): Collection<ObjectId>;
+  set highlightIds(value: ReadonlyArrayOrCollection<ObjectId>);
+  /**
+   * The user-provided number of total features accessed from the data source. This is used for initial load of the data store as opposed to querying a specified layer. Additionally, the table will query data counts to verify the data's integrity, or when requested via [refresh()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#refresh).
+   *
+   * @since 4.31
+   */
+  accessor initialSize: number | null | undefined;
+  /**
+   * Indicates the table is displaying an editable input in one of its cells.
+   *
+   * @since 4.33
+   */
+  get isEditing(): boolean;
+  /**
+   * Indicates if the table is querying data. This is useful when determining if the table is busy. This can be especially helpful when the table is querying a large amount of features.
+   *
+   * @since 4.33
+   */
+  get isQuerying(): boolean;
+  /**
+   * Indicates if the table is querying or syncing data. This is useful when determining if the table is busy. This can be especially helpful when the table is querying a large amount of features.
+   *
+   * @since 4.31
+   */
+  get isQueryingOrSyncing(): boolean;
+  /**
+   * Indicates if the table is syncing data. This is useful when determining if the table is busy.
+   *
+   * @since 4.33
+   */
+  get isSyncing(): boolean;
+  /**
+   * Indicates if the table is syncing attachment edits.
+   *
+   * @since 4.31
+   */
+  get isSyncingAttachments(): boolean;
+  /**
+   * The associated  [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),
+   * [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), [KnowledgeGraphSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html), [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), or [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) containing
+   * the fields and attributes to display within the widget. The table's pagination defaults to `50` records at a time. It is possible to set the default pagination using the FeatureTable's [FeatureTable#pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageSize) property.
+   *
+   * > [!WARNING]
+   * >
+   * > - Support for [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html) was added at version 4.30.
+   * > - Support for [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), and [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) was added at version 4.21.
+   * > - For an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) to work with FeatureTable, it must have mosaic dataset. Currently, Map and FeatureTable interaction for ImageryLayers is not supported.
+   *
+   * @see [FeatureTable#pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageSize)
+   */
+  accessor layer: FeatureTableSupportedLayer | null | undefined;
+  /** The [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) displaying data for the table's associated [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#layer). */
+  get layerView(): LayerView | null | undefined;
+  /**
+   * This property is applicable when working with layers that contain a large number of features, as it provides the ability to limit the displayed total feature count. If [paginationEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#paginationEnabled) is `true`, and `maxSize` is greater than the current value of [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#pageSize), multiple pages usually display. If `maxSize` is less than [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#pageSize), a single page shows the total number of features limited to `maxSize`.
+   *
+   * @since 4.31
+   */
+  maxSize?: number | null;
+  /** Set this object to customize the feature table's menu content. */
+  accessor menuConfig: TableMenuConfig | null | undefined;
+  /**
+   * Controls whether the table allows multiple selected rows.
+   *
+   * @default true
+   * @since 4.30
+   */
+  multipleSelectionEnabled: boolean;
+  /**
+   * This property can be used to determine how newly sorted columns are prioritized. By default, newly sorted columns are
+   * given the highest sort priority.
+   *
+   * @default "prepend"
+   * @since 4.33
+   */
+  multipleSortPriority: GridMultiSortPriority;
+  /**
+   * Indicates whether sorting multiple columns is supported within the table. Use this in combination with the [FieldColumnTemplate#initialSortPriority](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#initialSortPriority) and [FieldColumnTemplate#direction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#direction) properties to set sorting functionality for multiple columns.
+   *
+   * @default false
+   * @since 4.23
+   * @see [FieldColumnTemplate#initialSortPriority](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#initialSortPriority)
+   * @see [FieldColumnTemplate#direction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#direction)
+   * @see [FeatureTable#sortColumn()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#sortColumn)
+   * @see [Sample - FeatureTable with editing enabled](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-editing/)
+   * @see [Sample - FeatureTable](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable/)
+   * @example
+   * const featureTableVM = new FeatureTableViewModel({
+   *   layer: featureLayer,
+   *   multiSortEnabled: true,
+   *   tableTemplate: { // autocastable to TableTemplate
+   *     columnTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate
+   *     { // autocastable to FieldColumnTemplate
+   *       fieldName: "ObjectId",
+   *       direction: "asc", // In order to use initialSortPriority, make sure direction is set
+   *       initialSortPriority: 1, // This field's sort order takes second-highest priority.
+   *     },
+   *     {
+   *       fieldName: "Name",
+   *       direction: "asc", // In order to use initialSortPriority, make sure direction is set
+   *       initialSortPriority: 0, // This field's sort order takes the highest priority.
+   *     },
+   *     {
+   *       fieldName: "Status",
+   *       direction: "asc", // In order to use initialSortPriority, make sure direction is set
+   *       initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.
+   *     }]
+   *   },
+   *   container: "tableDiv"
+   * });
+   */
+  multiSortEnabled: boolean;
+  /**
+   * This property accepts and returns a collection of feature object IDs. Use this to access and control which features are currently visible in the table.
+   * When the collection is empty, all potential rows are displayed. Modifying object IDs is not supported while [filterBySelectionEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelectionEnabled) is `true` as these properties are mutually exclusive.
+   * This filter can also be combined with [filterGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterGeometry) to display features that satisfy both conditions.
+   *
+   * @since 4.30
+   */
+  get objectIds(): Collection<ObjectId>;
+  set objectIds(value: ReadonlyArrayOrCollection<ObjectId>);
+  /**
+   * An array of field names from the table's data source to include when the table requests data. By default, all fields are requested. This property is useful when working with many fields and only a subset of them is needed for the table. Take note that doing so can improve the table's load time.
+   *
+   * @since 4.31
+   */
+  accessor outFields: string[] | null | undefined;
+  /**
+   * Number of pages of features to be displayed in the table, based on the total [number of features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#size) and configured [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#pageSize).
+   *
+   * @since 4.31
+   */
+  get pageCount(): number;
+  /**
+   * Represents the index of the page of the feature currently being displayed. The number of features per page can be adjusted by modifying the [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#pageSize). [Pagination](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#paginationEnabled) must be enabled or the value of this property may not be not reliable due to virtualization of visible pages.
+   *
+   * @since 4.31
+   */
+  accessor pageIndex: number;
+  /**
+   * The default page size used when displaying features within the table. By default, the page loads the first 50 features returned by the service. It can be used with [paginationEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#paginationEnabled) to display a subset of features.
+   *
+   * > [!WARNING]
+   * >
+   * > It is not possible to overwrite the maximum page size on the server, ie. `maxRecordCount`, as this property only applies to set values less than the maximum page size, i.e. `maxRecordCount`, set on the service.
+   *
+   * @default 50
+   * @since 4.19
+   * @see [ArcGIS REST API - FeatureLayer - maxRecordCount](https://developers.arcgis.com/rest/services-reference/feature-layer.htm)
+   */
+  accessor pageSize: number;
+  /**
+   * Controls whether the table should only display a single page of features at any time. Current page can be determined via the [pageIndex](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#pageIndex) property. The current page can be modified by calling the [goToPage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#goToPage) method and passing in the desired [page index](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#pageIndex).
+   *
+   * @default false
+   * @since 4.31
+   */
+  paginationEnabled: boolean;
+  /**
+   * Indicates whether to display any related records associated with rows within the table. Take note that related layers must be provided via the {@link widgets/FeatureTable/FeatureTableViewModel#layers} property when there is no associated [FeatureTable#view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#view).
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor relatedRecordsEnabled: boolean;
+  /**
+   * A nested table instance which represents a relationship to another table. This is a reference to the most recently generated table when multiple related tables exist. It is only applicable if the table instance manages all nested tables.
+   *
+   * @since 4.31
+   */
+  get relatedTable(): FeatureTable | null | undefined;
+  /**
+   * A collection of nested table instances. This is typically used to represent relationships between each other.
+   * These are configured and managed by a single table widget instance. Only applies if this particular table instance is responsible for managing all nested tables.
+   * Nested tables reference the main table controller via the {@link widgets/FeatureTable/FeatureTableViewModel#tableController} property.
+   *
+   * @since 4.31
+   */
+  accessor relatedTables: Collection<FeatureTable>;
+  /**
+   * A flattened array of all [relationship columns](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-RelationshipColumn.html) within the table, including nested columns.
+   *
+   * @since 4.33
+   */
+  get relationshipColumns(): RelationshipColumn[];
+  /** An array of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html) that exist on the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#layer). This is only applicable if relationships are supported. */
+  get relationships(): Relationship[] | null | undefined;
+  /**
+   * Indicates whether to fetch geometries for the corresponding features displayed in the table.
+   *
+   * > [!WARNING]
+   * >
+   * > Setting this to true can impact performance of the widget.
+   *
+   * @default false
+   * @since 4.27
+   */
+  accessor returnGeometryEnabled: boolean;
+  /**
+   * Indicates whether geometries fetched for the corresponding features contain M values, if supported.
+   * The [FeatureTable#returnGeometryEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#returnGeometryEnabled) property must also be true.
+   *
+   * > [!WARNING]
+   * >
+   * > Setting this to true can impact performance of the widget.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor returnMEnabled: boolean;
+  /**
+   * Indicates whether the fetched features' geometries contain Z values. This is only applicable if Z-values are supported.
+   * The [FeatureTable#returnGeometryEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#returnGeometryEnabled) property must also be true.
+   *
+   * > [!WARNING]
+   * >
+   * > Setting this to true can impact performance of the widget.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor returnZEnabled: boolean;
+  /**
+   * This property accepts and returns a collection of feature object IDs. It is used to access and control which rows display a darker background, i.e., highlighted. Take note that highlighted rows are not considered selected as this property is independent of the table's selection state. Use the [highlightIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightIds) property to choose rows. Setting `rowHighlightIds` applies an alternative highlight style to an entire row or rows.
+   *
+   * @since 4.30
+   * @see [highlightEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightEnabled)
+   * @see [highlightIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#highlightIds)
+   */
+  get rowHighlightIds(): Collection<ObjectId>;
+  set rowHighlightIds(value: ReadonlyArrayOrCollection<ObjectId>);
+  /**
+   * Total number of records currently displayed in the table. This property takes into account all active filters and
+   * the current value of [maxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#maxSize) if it is configured.
+   *
+   * @default 0
+   * @since 4.30
+   */
+  get size(): number;
+  /**
+   * The state of the widget.
+   *
+   * Value | Description
+   * ------|------------
+   * disabled | Dependencies are missing and therefore the widget is disabled.
+   * error | Widget failed to load (_added at version 4.30_).
+   * loaded | Widget is ready to use.
+   * loading | Widget is busy loading its resources.
+   * ready | Dependencies are met and has valid property values but hasn't started the load process.
+   *
+   * @default "disabled"
+   */
+  get state(): FeatureTableState;
+  /**
+   * Indicates whether the table and associated layer support adding attachments with the current configuration.
+   *
+   * @since 4.31
+   */
+  get supportsAddAttachments(): boolean;
+  /**
+   * Indicates whether the table supports viewing attachments with the current configuration.
+   *
+   * @since 4.31
+   */
+  get supportsAttachments(): boolean;
+  /**
+   * Indicates whether the table and associated layer support deleting attachments with the current configuration.
+   *
+   * @since 4.31
+   */
+  get supportsDeleteAttachments(): boolean;
+  /**
+   * Defines whether or not the feature supports resizing
+   * attachments. This depends on whether the
+   * feature layer's [capabilities.attachment.supportsResize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is set to `true`.
+   *
+   * @since 4.31
+   */
+  get supportsResizeAttachments(): boolean;
+  /**
+   * Indicates whether the table and associated layer support updating attachments with the current configuration.
+   *
+   * @since 4.31
+   */
+  get supportsUpdateAttachments(): boolean;
+  /**
+   * Indicates whether the table should synchronize the current [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#attributeTableTemplate) being used based on
+   * changes made to the table's UI.
+   *
+   * @default true
+   * @since 4.33
+   * @see [FeatureTable#attributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#attributeTableTemplate)
+   */
+  accessor syncTemplateOnChangesEnabled: boolean;
+  /**
+   * The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) used for the feature table.
+   *
+   * The [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) is where you configure how the feature table should display and set any associated properties for the table and its columns.
+   *
+   * > [!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/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#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/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#attributeTableTemplate), the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-tables-AttributeTableTemplate.html) and [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) documentation for more information.
+   *
+   * > [!WARNING]
+   * >
+   * > Take note that it is required to set the `type` property when creating column templates.
+   *
+   * @since 4.24
+   * @example
+   * const tableTemplate = new TableTemplate({
+   *   columnTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate
+   *   { // autocasts to FieldColumnTemplate
+   *     type: "field",
+   *     fieldName: "ObjectId",
+   *     direction: "asc", // In order to use initialSortPriority, make sure direction is set
+   *     initialSortPriority: 1 // This field's sort order takes the second-highest priority.
+   *   },
+   *   {
+   *     type: "field",
+   *     fieldName: "NAME",
+   *     label: "Name",
+   *     asc: "asc", // In order to use initialSortPriority, make sure direction is set
+   *     initialSortPriority: 0 // This field's sort order takes the highest priority
+   *    },
+   *    {
+   *      type: "field",
+   *      fieldName: "STATUS",
+   *      label: "Status",
+   *      direction: "asc", // In order to use initialSortPriority, make sure direction is set
+   *      initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.
+   *    }
+   *   ]
+   * });
+   */
+  get tableTemplate(): TableTemplate | null | undefined;
+  set tableTemplate(value: TableTemplateProperties | null | undefined);
+  /**
+   * The [TimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-time-TimeExtent.html) in which to filter and display data within the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget. Setting this property directly on the viewModel or its [widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeExtent) takes precedence over the layer's [FeatureLayer#timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeExtent). If this property is set directly on the [widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeExtent), the table will not refresh when the layer's [TimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-time-TimeExtent.html) changes.
+   *
+   * @since 4.30
+   * @see [FeatureLayer#timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeExtent)
+   * @example
+   * // Filters the table to display only features that fit within the time extent
+   * reactiveUtils.watch(
+   *   () => timeSlider.timeExtent,
+   *   (extent) => {
+   *     featureTable.viewModel.timeExtent = extent;
+   *   }
+   * );
+   */
+  get timeExtent(): TimeExtent | null | undefined;
+  set timeExtent(value: TimeExtentProperties | null | undefined);
+  /**
+   * Dates and times displayed in the widget will be in terms of this time zone. If not supplied, the view's time zone
+   * is typically used (if available). Depending on the field type, individual columns may have their own unique
+   * time zone behavior when the time zone itself is `unknown`.
+   *
+   * > [!WARNING]
+   * >
+   * > The following considerations apply when working with date, time, and big integer field types:
+   * >
+   * > By default, the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) displays timezones for `date` and `timestamp-offset` field [types](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) reflecting the MapView's timezone. This timezone can be overridden by setting the view's [timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#timeZone) property.
+   * > If the table's [FeatureTable#view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#view) isn't set, and the table's [Feature#timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#timeZone) isn't set, the table defaults to `system` time. The only time that this is not the case is when there is a [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#preferredTimeZone) set on the table's layer. If the latter is true, the preferred time zone is used as opposed to `system`.
+   *
+   * @since 4.28
+   */
+  accessor timeZone: TimeZone | null | undefined;
+  /**
+   * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This property must be set for
+   * the select/highlight in the map to work.
+   */
+  accessor view: MapViewOrSceneView | LinkChartView | 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(): GridSupportedColumns[];
+  /**
+   * Clears the current [filterBySelection()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelection) so that the table displays all of the table rows.
+   *
+   * @deprecated since version 4.30. Use [filterBySelectionEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelectionEnabled) or [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#objectIds) instead.
+   * @since 4.23
+   * @see [filterBySelection()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelection)
+   */
+  clearSelectionFilter(): void;
+  /**
+   * Deletes all the selected rows from the table.
+   *
+   * > [!WARNING]
+   * >
+   * > There must be at least one selected row within the table for this to work. Also, make sure that [editingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#editingEnabled) is set to `true` and the underlying service data supports deletion.
+   *
+   * @returns Resolves when the selection is deleted.
+   * @since 4.25
+   */
+  deleteSelection(): Promise<void>;
+  /**
+   * Exports features associated with currently selected rows to a CSV file and displays a download prompt. When invoked from the table's menu, it automatically includes geometry for features with a `point` geometry type. Geometry information is excluded on all other layer types.
+   *
+   * > [!WARNING]
+   * >
+   * > This method must be used on selected rows within the table.
+   *
+   * @param includeGeometry - Indicates whether the geometry should be included in the exported file. Only applies to features with 'point' geometries.
+   * @returns Resolves when the export dialog is displayed.
+   * @since 4.31
+   */
+  exportSelectionToCSV(includeGeometry?: boolean): Promise<void>;
+  /**
+   * Filters the table using the current row selection and displays only those selected table rows.
+   *
+   * @deprecated since version 4.30. Use [filterBySelectionEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelectionEnabled) or [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#objectIds) instead.
+   * @since 4.23
+   */
+  filterBySelection(): void;
+  /**
+   * Returns the current row index for the associated feature. Returns a value of -1 if the row is not found.
+   *
+   * @param objectId - The `ObjectId` field of the specified feature.
+   * @returns The feature's row index.
+   */
+  getObjectIdIndex(objectId: ObjectId): number;
+  /**
+   * Returns a field value given the specified feature `object` and an associated `fieldName`.
+   *
+   * @param objectId - The object ID field of the specified feature.
+   * @param fieldName - The name of the field in which to get the associated object id's feature value.
+   * @returns Associated value for the specified feature, as provided using its object ID, under the given field value.
+   * @example
+   * // Gets the field value for the specified field name, "OPENSTATUS" with the given feature ObjectId
+   * const featureValue = featureTable.viewModel.getValue(feature.attributes.ObjectId, "OPENSTATUS");
+   * console.log(featureValue);
+   */
+  getValue(objectId: ObjectId, fieldName: string): FieldValue;
+  /**
+   * Instructs the table to scroll to or display a specific page of data.
+   *
+   * @param index - The page index.
+   * @since 4.31
+   * @see [pageIndex](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#pageIndex)
+   */
+  goToPage(index: number): void;
+  /**
+   * Internal method used to hide the attachments view.
+   *
+   * @since 4.31
+   */
+  hideAttachmentsView(): void;
+  /**
+   * Instructs the table to scroll to or display the next page of data.
+   *
+   * @since 4.31
+   */
+  nextPage(): void;
+  /**
+   * Instructs the table to scroll to or display the previous page of data.
+   *
+   * @since 4.31
+   */
+  previousPage(): void;
+  /**
+   * Refreshes the table contents while maintaining the current scroll position.
+   *
+   * @since 4.16
+   */
+  refresh(): Promise<void>;
+  /**
+   * Re-renders the cell's content. Generally, this is only required if using a custom function for [FieldColumnTemplate#formatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#formatFunction) or [ColumnTemplate#formatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplate.html#formatFunction). If the render function is dependent on external data or its state, and that data or state changes, calling this method will re-render the cell content. If the render function is dependent on the feature's attributes, calling this method is not necessary as the cell content will automatically update when the feature's attributes change. If the render function is dependent on the feature's geometry, calling this method is not necessary as the cell content will automatically update when the feature's geometry changes.
+   *
+   * @since 4.30
+   */
+  refreshCellContent(): void;
+  /**
+   * Performs a light refresh of cell content, emptying the store and fetching fresh data. Scroll position is maintained.
+   * Unlike the [refresh()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#refresh) method, this method does not query the layer for an updated total feature count.
+   *
+   * @since 4.31
+   */
+  refreshPageCache(): void;
+  /**
+   * Performs a full reset of the entire table resulting in the table scrolling to the top-most row.
+   *
+   * @since 4.23
+   */
+  reset(): Promise<void>;
+  /**
+   * Resets the horizontal scroll position of the table to the default view.
+   *
+   * @since 4.31
+   */
+  scrollLeft(): void;
+  /**
+   * Scrolls the table to the bottom row. If pagination is enabled, the table scrolls to
+   * the bottom row of the current page.
+   *
+   * @since 4.31
+   */
+  scrollToBottom(): void;
+  /**
+   * Scrolls the table to a row based on a specified index.
+   *
+   * @param index - Index of the row in which the table should scroll.
+   * @since 4.19
+   */
+  scrollToIndex(index: number): void;
+  /**
+   * Scrolls the table to a row based on a specified object ID. The row must already be loaded for this method to take effect.
+   *
+   * @param objectId - Object id of a row's associated feature in which the table should scroll.
+   * @since 4.31
+   */
+  scrollToRow(objectId: ObjectId): void;
+  /**
+   * Scrolls the table to the top row. If [pagination is enabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#paginationEnabled), the table scrolls to the top row of the current page.
+   *
+   * @since 4.31
+   */
+  scrollToTop(): void;
+  /**
+   * Manually sync the provided layer's attributeTableTemplate with the current state of the FeatureTable.
+   * This is useful if 'syncTemplateOnChangesEnabled' is set to false.
+   *
+   * @since 4.32
+   */
+  syncAttributeTableTemplate(): void;
+  /**
+   * Toggles current visibility of the provided column.
+   *
+   * @param fieldName - Associated field name of the column to be hidden or made visible. This should match the field name as defined at the data source.
+   * @since 4.30
+   */
+  toggleColumnVisibility(fieldName: string): void;
+  /**
+   * Zooms the view to the extent of the current row selection. This can also be triggered as a menu item within the table. This item will display if at least one row is selected and the [FeatureTable#view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#view) is set on the `FeatureTable`.
+   *
+   * @since 4.23
+   * @see [FeatureTable.visibleElements.menuItems.zoomToSelection](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#visibleElements)
+   */
+  zoomToSelection(): Promise<void>;
+}