types | References | ArcGIS Maps SDK for JavaScript

Types

import type { CellValue, TextAlign, FeatureTableState, GridSupportedColumns, GridMultiSortPriority } from "@arcgis/core/widgets/FeatureTable/Grid/types.js";

Type definitions

CellValue

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: null | undefined | string | number

TextAlign

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "start" | "center" | "end"

FeatureTableState

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "disabled" | "loading" | "loaded" | "ready" | "error"

GridSupportedColumns

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: default

GridMultiSortPriority

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "append" | "prepend"

TableInteractionEvent

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

feature

Property

Type: Graphic | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The feature associated with the cell.

fieldName

Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The field name associated with the cell.

index

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies the index of the row (not just the individual cell).

native

Property

Type: MouseEvent | PointerEvent | KeyboardEvent | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The native event object used for the interaction.

objectId

Property

Type: number | string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The object ID of the feature associated with the cell.

TableInteractionCellClickEvent

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: TableInteractionEvent

type

Property

Type: "cell-click"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of cell interaction event.

TableInteractionCellDblclickEvent

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: TableInteractionEvent

type

Property

Type: "cell-dblclick"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of cell interaction event.

TableInteractionCellPointeroverEvent

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: TableInteractionEvent

type

Property

Type: "cell-pointerover"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of cell interaction event.

TableInteractionCellPointeroutEvent

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: TableInteractionEvent

type

Property

Type: "cell-pointerout"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of cell interaction event.

TableInteractionCellKeydownEvent

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: TableInteractionEvent

type

Property

Type: "cell-keydown"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of cell interaction event.

TableInteractionColumnReorderEvent

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: TableInteractionEvent

type

Property

Type: "column-reorder"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of table interaction event.

Direction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "asc" | "desc" | null | undefined

ColumnTableMenuConfig

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: TableMenuConfig

selectionMode

Property

Type: "none" | "single" | "multiple" | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The selection mode of the menu items.

icon

Property

Type: Icon["icon"] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The string value indicating the icon displayed in the header cell of the column.

TableMenuConfig

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The configuration for the table's menu.

disabled

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the menu is disabled. Default value is false.

items

Property

Type: TableMenuItemConfig[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The menu items within the table menu.

open

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the menu is open. Default value is false.

TableMenuItemConfig

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The configuration for an individual menu item within the table menu.

label

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The text displayed for the menu item.

disabled

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the menu item is disabled. Default value is false.

icon

Property

Type: Icon["icon"] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The string value indicating the Calcite icon displayed for the menu item.

iconClass

deprecated Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

This is the CSS class for the icon displayed for the menu item.

selected

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the menu item is selected. Default value is false.

clickFunction

Property

Type: TableMenuItemConfigClickFunction

Since: ArcGIS Maps SDK for JavaScript 5.0

The function that executes when the menu item is clicked.

hidden

Property

Type: TableMenuItemConfigHiddenFunction | boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

A function that determines whether the menu item is hidden. Default value is false.

TableMenuItemConfigClickFunction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The function that executes when the menu item is clicked.

Parameters

Parameter	Type	Description	Required
event	MouseEvent \| KeyboardEvent	The event.

Returns: void

TableMenuItemConfigHiddenFunction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

A function that determines whether the menu item is hidden.

Returns: boolean
whether the menu item is hidden.

FeatureStoreEdits

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

DiscardPendingEditsParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0