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

package/widgets/FeatureTable/RelationshipColumn.d.ts

@@ -1,4 +1,97 @@
-import "../../interfaces";
+import type FeatureLayer from "../../layers/FeatureLayer.js";
+import type SceneLayer from "../../layers/SceneLayer.js";
+import type Relationship from "../../layers/support/Relationship.js";
+import type Column from "./Grid/Column.js";
+import type { Icon } from "@esri/calcite-components/components/calcite-icon";
+import type { ColumnProperties } from "./Grid/Column.js";
+import type { TextAlign } from "./Grid/interfaces.js";
 
-import RelationshipColumn = __esri.RelationshipColumn;
-export default RelationshipColumn;
+export interface RelationshipColumnProperties extends ColumnProperties, Partial<Pick<RelationshipColumn, "collapsed">> {
+  /**
+   * The [Calcite Icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed within the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) header for the attachments column.
+   *
+   * @default "link"
+   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  icon?: Icon["icon"];
+  /**
+   * Default width of the relationship column in pixels.
+   *
+   * @default "200px"
+   */
+  width?: number | string;
+}
+
+/**
+ * The `RelationshipColumn` class works with the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) to display any associated related records for each feature in the table. This column will only be displayed if the related layer or table is also added to the map. If a feature has related records and the table is configured to [enable related records](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#relatedRecordsEnabled), the count of related records is displayed in the cell. Whereas the cell is empty if the feature does not have related records. This column is always appended to the end of the table.
+ *
+ * > [!WARNING]
+ * >
+ * > This class should be used for observing potential changes. It is designed
+ * > primarily to read and not interact directly with the relationship columns.
+ *
+ * ![relationship columns](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/relationship-column.png)
+ *
+ * @since 4.30
+ * @see [Column](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html)
+ * @see [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html)
+ * @see [FeatureTableViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html)
+ */
+export default class RelationshipColumn extends Column {
+  constructor(properties?: RelationshipColumnProperties);
+  /**
+   * Indicates whether the column displays collapsed. If collapsed, the header will always display as empty.
+   *
+   * @default false
+   */
+  accessor collapsed: boolean;
+  /**
+   * The sanitized label displayed within the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) header for the relationship column. If the label is not provided, the name of the relationship is used. If the relationship name is not provided, the title of the related layer is used.
+   *
+   * @since 4.30
+   * @see [ArcGIS HTML Sanitizer](https://github.com/Esri/arcgis-html-sanitizer#readme)
+   * @see [ArcGIS Online supported HTML specification](https://doc.arcgis.com/en/arcgis-online/reference/supported-html.htm)
+   */
+  get effectiveLabel(): string;
+  /**
+   * The [Calcite Icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed within the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) header for the attachments column.
+   *
+   * @default "link"
+   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: Icon["icon"];
+  /** The layer that contains the features being displayed in the table. */
+  get layer(): FeatureLayer | SceneLayer;
+  /** Returns the [Relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html) of the [relatedLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-RelationshipColumn.html#relatedLayer) to find a relationship that has the same id as the [relationshipId](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-RelationshipColumn.html#relationshipId). */
+  get originRelationship(): Relationship | null | undefined;
+  /** The layer that contains the related features being displayed in the table. */
+  get relatedLayer(): FeatureLayer | SceneLayer;
+  /** Returns the first relationship from [layer's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-RelationshipColumn.html#layer) `relationships` that matches the [relationshipId](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-RelationshipColumn.html#relationshipId). */
+  get relationship(): Relationship | null | undefined;
+  /**
+   * The unique ID for the relationship.
+   *
+   * @see [Relationship#id](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#id)
+   */
+  get relationshipId(): number;
+  /**
+   * Indicates whether the relationship column can be resized. This is always set to `true`.
+   *
+   * @default true
+   */
+  get resizable(): boolean;
+  /**
+   * The text alignment of the relationship column.
+   *
+   * @default "center"
+   */
+  get textAlign(): TextAlign;
+  /**
+   * Default width of the relationship column in pixels.
+   *
+   * @default "200px"
+   */
+  accessor width: number | string;
+}

package/widgets/FeatureTable/TableMenuVisibleElements.d.ts

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

package/widgets/FeatureTable/VisibleElements.d.ts

@@ -0,0 +1,81 @@
+import type Accessor from "../../core/Accessor.js";
+import type ColumnMenuVisibleElements from "./ColumnMenuVisibleElements.js";
+import type TableMenuVisibleElements from "./TableMenuVisibleElements.js";
+import type { ColumnMenuVisibleElementsProperties } from "./ColumnMenuVisibleElements.js";
+import type { TableMenuVisibleElementsProperties } from "./TableMenuVisibleElements.js";
+
+export interface VisibleElementsProperties extends Partial<Pick<VisibleElements, "columnDescriptions" | "columnMenus" | "header" | "layerDropdown" | "layerDropdownIcons" | "menu" | "progress" | "selectionColumn" | "tooltips">> {
+  /** _(Since 4.30)_ The menu items within the column menu. */
+  columnMenuItems?: ColumnMenuVisibleElementsProperties;
+  /** The menu items within the feature table menu. */
+  menuItems?: TableMenuVisibleElementsProperties;
+}
+
+/**
+ * The visible elements that are displayed within the widget.
+ * This provides the ability to turn individual elements of the widget's display on/off.
+ *
+ * ![featuretable-visibleelements](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/featuretablevisibleelements.png)
+ */
+export default abstract class VisibleElements extends Accessor {
+  /**
+   * _(Since 4.31)_ Indicates whether to display descriptions in the header cells of individual columns. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor columnDescriptions: boolean;
+  /** _(Since 4.30)_ The menu items within the column menu. */
+  get columnMenuItems(): ColumnMenuVisibleElements;
+  set columnMenuItems(value: ColumnMenuVisibleElementsProperties);
+  /**
+   * _(Since 4.23)_ Indicates whether to display interactive menus in the header cells of individual columns. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor columnMenus: boolean;
+  /**
+   * Indicates whether to display the feature table's header information. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor header: boolean;
+  /**
+   * _(Since 4.30)_ Indicates whether to display the feature table's layer switch drop down menu. Default value is `false`.
+   *
+   * @default false
+   */
+  accessor layerDropdown: boolean;
+  /**
+   * _(Since 4.32)_ Indicates whether to display layer-specific icons in the layer drop down menu. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor layerDropdownIcons: boolean;
+  /**
+   * Indicates whether to display the feature table's menu. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor menu: boolean;
+  /** The menu items within the feature table menu. */
+  get menuItems(): TableMenuVisibleElements;
+  set menuItems(value: TableMenuVisibleElementsProperties);
+  /**
+   * _(Since 4.30)_ Indicates whether to display the progress indicator when the table is querying or syncing data. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor progress: boolean;
+  /**
+   * Indicates whether to display the selection column in the table. Each row has a checkbox that selects its corresponding feature. Default value is `true`. If working with a map, make certain to set the `FeatureTable.view` property as this enables highlighting the corresponding feature.
+   *
+   * @default true
+   */
+  accessor selectionColumn: boolean;
+  /**
+   * _(Since 4.30)_ Indicates whether to display the tooltip for the Show/hide columns button. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor tooltips: boolean;
+}

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

@@ -1,4 +1,27 @@
-import "../../../interfaces";
+import type ColumnTemplateBase from "./ColumnTemplateBase.js";
+import type { ColumnTemplateBaseProperties } from "./ColumnTemplateBase.js";
 
-import AttachmentsColumnTemplate = __esri.AttachmentsColumnTemplate;
-export default AttachmentsColumnTemplate;
+export interface AttachmentsColumnTemplateProperties extends ColumnTemplateBaseProperties {}
+
+/**
+ * A AttachmentsColumnTemplate formats and defines the structure of a [AttachmentsColumn](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-AttachmentsColumn.html) within a
+ * [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget.
+ *
+ * The AttachmentsColumnTemplate is set directly on the table's [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) or its [view model](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#tableTemplate). This template enables the display of multiple (@link module:esri/widgets/FeatureTable/AttachmentColumn attachment columns} anywhere within the table, offering enhanced configuration flexibility.
+ *
+ * @since 4.31
+ * @see [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html)
+ * @see [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html)
+ * @see [ColumnTemplateBase](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html)
+ * @see [Sample - FeatureTable with editing and attachments enabled](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-editing/)
+ * @see [Sample - FeatureTable with related records](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-relates/)
+ * @example
+ * const attachmentsColumnTemplate = new AttachmentsColumnTemplate({
+ *   label: "Attachments",
+ * });
+ */
+export default class AttachmentsColumnTemplate extends ColumnTemplateBase {
+  constructor(properties?: AttachmentsColumnTemplateProperties);
+  /** The type of column that the template represents. */
+  get type(): "attachment";
+}

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

@@ -1,4 +1,74 @@
-import "../../../interfaces";
+import type Accessor from "../../../core/Accessor.js";
+import type EsriError from "../../../core/Error.js";
+import type AttachmentInfo from "../../../rest/query/support/AttachmentInfo.js";
+import type { ObjectId } from "../../../views/IObjectId.js";
 
-import AttachmentsViewOptions = __esri.AttachmentsViewOptions;
-export default AttachmentsViewOptions;
+export interface AttachmentsViewOptionsProperties {}
+
+/**
+ * AttachmentsViewOptions is a read-only class which defines what can be displayed within [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) attachments. It is used to manage the state of the attachments view, including the current attachment being edited, the list of attachment information, candidates for new attachments, and any errors that may occur. It is meant to provide a user-friendly interface for managing attachments in the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget
+ *
+ * It is important to note that this class does not handle the actual uploading or downloading of attachments, but rather manages the state and options for displaying attachments within the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget.
+ *
+ * @since 4.33
+ */
+export default class AttachmentsViewOptions extends Accessor {
+  constructor(properties?: AttachmentsViewOptionsProperties);
+  /** The ID of the attachment currently being edited. */
+  get attachmentId(): number | null | undefined;
+  /**
+   * An array of attachment information objects.
+   *
+   * @default []
+   */
+  get attachmentInfos(): AttachmentInfo[];
+  /**
+   * A list of file candidates that can be added as attachments.
+   * This is typically used when a user selects files to upload.
+   *
+   * @since 4.33
+   */
+  get candidates(): FileList | null | undefined;
+  /**
+   * An error that may occur during attachment operations.
+   * This is typically used to display error messages to the user.
+   *
+   * @since 4.33
+   */
+  get error(): EsriError | null | undefined;
+  /**
+   * The HTML form element used for file uploads.
+   * This is typically used to submit files to the server.
+   *
+   * @since 4.33
+   */
+  get form(): HTMLFormElement | null | undefined;
+  /**
+   * The current mode of the attachments view.
+   * This can be either `list` to display a list of attachments or `file` to allow file uploads.
+   *
+   * @default "list"
+   */
+  get mode(): "list" | "file" | null | undefined;
+  /**
+   * The object ID of the feature associated with the attachments.
+   * This is used to identify which feature the attachments belong to.
+   *
+   * @since 4.33
+   */
+  get objectId(): ObjectId | null | undefined;
+  /**
+   * Used to display the list view and clear temporary file data after a successful edit.
+   * It resets the `attachmentId`, clears the `candidates`, and sets the mode to `list` to display the list of attachments.
+   *
+   * @since 4.33
+   */
+  onEditComplete(): void;
+  /**
+   * Use this method to reset feature-specific properties after the [objectId](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-AttachmentsViewOptions.html#objectId) changes.
+   * This is useful when the feature table is displaying attachments for a different feature, allowing the widget to reset its state without losing the current `objectId`.
+   *
+   * @since 4.33
+   */
+  reset(): void;
+}

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

@@ -1,4 +1,24 @@
-import "../../../interfaces";
+import type ColumnTemplateBase from "./ColumnTemplateBase.js";
+import type { ColumnTemplateBaseProperties } from "./ColumnTemplateBase.js";
+import type { EditableColumnTemplateMixinProperties, EditableColumnTemplateMixin } from "./EditableColumnTemplateMixin.js";
 
-import ColumnTemplate = __esri.ColumnTemplate;
-export default ColumnTemplate;
+export interface ColumnTemplateProperties extends ColumnTemplateBaseProperties, EditableColumnTemplateMixinProperties {}
+
+/**
+ * A ColumnTemplate formats and defines the structure of a [Column](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html) within a
+ * [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget. It is set directly on the table's [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) or its [view model](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html#tableTemplate).
+ * The [FeatureTable's tableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) contains a collection of [column, field and/or group templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html#columnTemplates).
+ *
+ * @since 4.24
+ * @see [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html)
+ * @see [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html)
+ * @see [FieldColumnTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html)
+ * @see [GroupColumnTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html)
+ * @see [Sample - FeatureTable with custom content](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-custom-content/)
+ */
+export default class ColumnTemplate extends ColumnTemplateSuperclass {
+  constructor(properties?: ColumnTemplateProperties);
+  /** The type of column that the template represents. */
+  get type(): "column";
+}
+declare const ColumnTemplateSuperclass: typeof ColumnTemplateBase & typeof EditableColumnTemplateMixin

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

@@ -1,4 +1,222 @@
-import "../../../interfaces";
+import type { Icon } from "@esri/calcite-components/components/calcite-icon";
+import type { ClonableMixin, ClonableMixinProperties } from "../../../core/Clonable.js";
+import type { JSONSupport, JSONSupportMixinProperties } from "../../../core/JSONSupport.js";
+import type { TimeZone } from "../../../time/interfaces.js";
+import type { TextAlign } from "../Grid/interfaces.js";
+import type { ColumnTableMenuConfig, Direction } from "../Grid/support/interfaces.js";
+import type { FormatFunction } from "./interfaces.js";
 
-import ColumnTemplateBase = __esri.ColumnTemplateBase;
-export default ColumnTemplateBase;
+export interface ColumnTemplateBaseProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<ColumnTemplateBase, "autoWidth" | "description" | "direction" | "fieldName" | "flexGrow" | "formatFunction" | "icon" | "iconText" | "initialSortPriority" | "invalid" | "label" | "labelTooltipText" | "menuConfig" | "resizable" | "sortable" | "textAlign" | "textWrap" | "timeZone" | "visible" | "width">> {}
+
+/**
+ * The base class for all column templates used by the [TableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) within the [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) widget.
+ *
+ * `ColumnTemplateBase` is a base class which has no constructor.
+ *
+ * @since 4.24
+ * @see [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html)
+ * @see [FeatureTableViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FeatureTableViewModel.html)
+ * @see [Column](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-Grid-Column.html)
+ * @see [ColumnTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplate.html)
+ * @see [FieldColumnTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html)
+ * @see [GroupColumnTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-GroupColumnTemplate.html)
+ */
+export default abstract class ColumnTemplateBase extends ColumnTemplateBaseSuperclass {
+  /**
+   * Indicates if the column width will automatically adjust to account for large content.
+   * The column ignores the current [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#width) property when `autoWidth` is `true`.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor autoWidth: boolean;
+  /**
+   * A string description of the column to give context to what it represents.
+   *
+   * @since 4.31
+   * @see [FieldColumn#description](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#description)
+   * @see [FieldColumn#effectiveDescription](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-FieldColumn.html#effectiveDescription)
+   */
+  accessor description: string | null | undefined;
+  /**
+   * Controls the sort order of the column. This property will only be honored on one column in the FeatureTable widget.
+   * If direction is specified on more than one column in the same FeatureTable,
+   * it will only be honored on the column with the highest index.
+   *
+   * This is used in combination with the [initialSortPriority](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#initialSortPriority) and [FeatureTable#multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) properties to set sorting functionality for multiple columns.
+   *
+   * Possible Value | Description
+   * ---------------|------------
+   * asc | Sorts the column in ascending order.
+   * desc | Sorts the column in descending order.
+   * null | No sort is applied to the column.
+   *
+   * @see [FeatureTable#multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled)
+   * @see [initialSortPriority](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#initialSortPriority)
+   */
+  accessor direction: Direction;
+  /** The unique field name as defined by the data source. */
+  accessor fieldName: string;
+  /**
+   * Controls the [flex-grow](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow) property for the column. When set to `0`, cell width is fixed.
+   *
+   * @default 1
+   * @since 4.30
+   */
+  accessor flexGrow: number;
+  /**
+   * Custom function for rendering cell content that is called when the column is rendered in the table. The function should return the formatted content to display within a table's cell. This can be a string, number, an HTML element, or equivalent node type (e.g. a [Calcite component](https://developers.arcgis.com/calcite-design-system/components/)). If the content is an HTML element, it is appended to the root element. If the content is a string or number, it is set as the innerHTML of the root element. This property is useful when you want to customize the cell content. For example, you can use this property to create a custom cell renderer that displays a progress bar in the cell. The progress bar can be used to show the progress of a task.
+   *
+   * @since 4.30
+   * @example
+   * // The following example demonstrates how to use the formatFunction property to create a custom cell renderer that displays a progress bar in the cell. The progress bar can be used to show the progress of a task.
+   * columnTemplate.formatFunction = ({ column, feature, index, value })=> {
+   *   const progress = document.createElement("progress");
+   *   progress.max = 100;
+   *   progress.value = value;
+   *   return progress;
+   * };
+   */
+  accessor formatFunction: FormatFunction | null | undefined;
+  /**
+   * Indicates if the the column is frozen in place at the beginning of the table.
+   * Column must be first in the FeatureTable's [column's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#columns), or next to other frozen columns.
+   *
+   * @default false
+   */
+  get frozen(): boolean;
+  /**
+   * Indicates if the column is frozen in place at the end of the table.
+   * Column must be last in the FeatureTable's [column's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#columns), or next to other columns with `frozenToEnd` set to `true`.
+   *
+   * @default false
+   * @since 4.30
+   */
+  get frozenToEnd(): boolean;
+  /**
+   * The string value indicating the [icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed in the header cell of the column.
+   *
+   * @since 4.30
+   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: Icon["icon"] | null | undefined;
+  /**
+   * The string value displayed when hovering over the associated [icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed in the header cell of the column.
+   * When a value is not provied, the column label is displayed instead. A value for 'icon' must also be set on the template.
+   *
+   * @since 4.32
+   * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor iconText: string | null | undefined;
+  /**
+   * Use this in combination with [FeatureTable#multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled) and {@link widgets/FeatureTable#direction} properties to set sorting functionality on multiple columns. This property indicates the index of the sorted column when compared to other columns, with lower numbers taking a higher priority.
+   *
+   * If no sort priority is set, the priority defaults to the most recently-sorted column. This occurs when sorting via the UI, or programmatically by calling [FeatureTable#sortColumn()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#sortColumn). For example, using the example snippet below, the sort order priority is set for three columns, with "Status" having the least priority. Calling `table.sortColumn("Status", "asc")` would update the `Status` column to the highest priority. This would also occur if manually sorting via the column's UI.
+   *
+   * @see [FeatureTable#multiSortEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multiSortEnabled)
+   * @see [direction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-ColumnTemplateBase.html#direction)
+   * @see [FeatureTable#sortColumn()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#sortColumn)
+   * @see [Sample - FeatureTable widget](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable/)
+   * @example
+   * const table = new FeatureTable({
+   *   layer: featureLayer,
+   *   multiSortEnabled: true,
+   *   tableTemplate: { // autocastable to TableTemplate
+   *     columnTemplates: [{ // autocastable to FieldColumnTemplate
+   *       type: "field",
+   *       fieldName: "ObjectId",
+   *       direction: "asc",
+   *       initialSortPriority: 1, // This field's sort order takes second-highest priority.
+   *     },
+   *     {
+   *       type: "field",
+   *       fieldName: "Name",
+   *       direction: "asc",
+   *       initialSortPriority: 0, // This field's sort order takes the highest priority.
+   *     },
+   *     {
+   *       type: "field",
+   *       fieldName: "Status",
+   *       direction: "asc",
+   *       initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.
+   *     }]
+   *   }
+   *   container: "tableDiv"
+   * });
+   */
+  accessor initialSortPriority: number | null | undefined;
+  /**
+   * Indicates whether the column is in an invalid state.
+   *
+   * @default false
+   * @since 4.30
+   */
+  accessor invalid: boolean;
+  /** The default label displayed in the column header cell. */
+  accessor label: string | null | undefined;
+  /**
+   * Text displayed when hovering over the column header label.
+   * Defaults to the typical column label when a value is not provided.
+   */
+  accessor labelTooltipText: string | null | undefined;
+  /**
+   * Configuration options for the column menu.
+   *
+   * @since 4.30
+   */
+  accessor menuConfig: ColumnTableMenuConfig | null | undefined;
+  /**
+   * Indicates whether the column is resizable.
+   *
+   * @default true
+   * @since 4.30
+   */
+  accessor resizable: boolean;
+  /**
+   * Indicates whether the column can be sorted. Columns based on custom content will not be sortable.
+   *
+   * @default false
+   */
+  accessor sortable: boolean;
+  /**
+   * Aligns the columns cell content horizontally.
+   *
+   * @default "start"
+   */
+  accessor textAlign: TextAlign;
+  /**
+   * Indicates cell content should be wrapped and displayed on multiple lines within the cell.
+   *
+   * > [!WARNING]
+   * >
+   * > This causes rows to expand when tall content is visible in the viewport. Scrolling tall cells
+   * > into the viewport may cause the table to visually jump depending on the height of the expanding
+   * > rows.
+   *
+   * @default false
+   */
+  accessor textWrap: boolean;
+  /**
+   * The time zone of the specific column.
+   *
+   * @since 4.31
+   * @see [MapView#timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone)
+   */
+  accessor timeZone: TimeZone | null | undefined;
+  /** The type of column that the template represents. */
+  get type(): "column" | "field" | "group" | "attachment" | "relationship";
+  /**
+   * Indicates whether the column is visible.
+   *
+   * @default true
+   */
+  accessor visible: boolean;
+  /**
+   * Default width of the column in pixels.
+   *
+   * @default 200
+   * @since 4.30
+   */
+  accessor width: number | string;
+}
+declare const ColumnTemplateBaseSuperclass: typeof JSONSupport & typeof ClonableMixin

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

@@ -0,0 +1,44 @@
+
+export interface EditableColumnTemplateMixinProperties extends Partial<Pick<EditableColumnTemplateMixin, "editable" | "required">> {}
+
+/** @since 4.24 */
+export abstract class EditableColumnTemplateMixin {
+  constructor(...args: any[]);
+  /**
+   * Indicates whether the field is editable. Editing permissions can be broken down
+   * with the following levels of priority:
+   *
+   * 1. [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) or [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.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. This can be overridden using a
+   * [field column template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html).
+   * 2. [Template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html) - 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).
+   * 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.
+   *
+   * For example, if table editing is disabled in the widget, i.e. `enableEditing` is not set,
+   * it is still possible to enable editing for a specific column by setting the
+   * [FieldColumnTemplate#editable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#editable) property. Vice versa
+   * is also true, if table editing is enabled, a field template can be used to disable editing for a specific column.
+   *
+   * > [!WARNING]
+   * >
+   * > Ultimately, if the service's field is not editable, it is not possible to override its permissions
+   * > using one of the options above.
+   *
+   * @default true
+   * @see [FieldColumnTemplate#editable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-FieldColumnTemplate.html#editable)
+   * @see [Sample - FeatureTable widget with editing enabled](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-editing/)
+   */
+  accessor editable: boolean;
+  /**
+   * Indicates whether a field requires a value.
+   *
+   * @default false
+   */
+  accessor required: boolean;
+}