types | References | ArcGIS Maps SDK for JavaScript

Types

import type { FieldValueFormatFunctionParameters, FormatFunctionParameters, FeatureTableSupportedLayer, FeatureTableSupportedColumn, FormatFunction } from "@arcgis/core/widgets/FeatureTable/support/types.js";

Type definitions

FieldValueFormatFunctionParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: FormatFunctionParameters

FormatFunctionParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

attachments

Property

Type: AttachmentInfo[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

(Since 4.31) A reference to attachments for the associated feature.

column

Property

Type: Column

Since: ArcGIS Maps SDK for JavaScript 5.0

A reference to this specific Column.

feature

Property

Type: Graphic

Since: ArcGIS Maps SDK for JavaScript 5.0

A reference to the feature represented by the associated row.

index

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Index of the associated row being rendered.

virtualIndex

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

(Since 4.31) Virtual index of the associated row being rendered. Unlike index, a row's virtualIndex changes as the table scrolls. The first row in the DOM has a virtualIndex of 0. As rows are added/removed from the DOM, the virtual index adjusts before it renders. This can help with performance when rendering large datasets.

relatedRecords

Property

Type: RelatedRecordInfo[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

(Since 4.31) A reference to related records for the associated feature.

value

Property

Type: CellValue

Since: ArcGIS Maps SDK for JavaScript 5.0

Current projected value of the cell.

field

Property

Type: Field | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The field associated with the column.

FeatureTableSupportedLayer

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | OrientedImageryLayer | ParquetLayer | Sublayer

FeatureTableSupportedColumn

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: default

FormatFunction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Custom function for rendering cell content. Accepts a string, number, an HTML element or equivalent node type (e.g. a Calcite component).

Parameters

Parameter	Type	Description	Required
params	FormatFunctionParameters	An object containing information about the associated row and feature.

Returns: CellValue | HTMLElement
Formatted content to be displayed in the cell.

FieldValueFormatFunction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Custom function for rendering cell content. Accepts a string, number, an HTML element or equivalent node type (e.g. a Calcite component).

Parameters

Parameter	Type	Description	Required
params	FieldValueFormatFunctionParameters	An object containing information about the associated row and feature.

Returns: FieldValue | HTMLElement
Formatted content to be displayed in the cell.

FeatureStoreItem

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Information about an item in the store, used to represent a row in the table.

objectId

Property

Type: ObjectId

Since: ArcGIS Maps SDK for JavaScript 5.0

The object ID of the feature represented by the item.

feature

Property

Type: Graphic

Since: ArcGIS Maps SDK for JavaScript 5.0

The feature represented by the item.

attachments

Property

Type: AttachmentInfo[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The attachment information for the associated feature.

relatedRecords

Property

Type: RelatedRecordInfo[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The related record information for the associated feature.

FeatureTableSupportedFilters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: GeometryFilter | SelectionFilter

GeometryFilter

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Use this for spatial filtering, it is the Geometry used to filter out data within the table.

See also

Supertypes: TableFilter

type

Property

Type: "geometry"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the filter used. This will always read as "geometry".

geometry

Property

Type: GeometryUnion

Since: ArcGIS Maps SDK for JavaScript 5.0

The geometry used to filter out the table's data.

SelectionFilter

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Use this for selecting rows within the table based off of their object ID.

See also

FeatureTableViewModel.activeFilters

Supertypes: TableFilter

type

Property

Type: "selection"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the filter used. This will always read as "selection".

objectIds

Property

Type: ObjectId[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of numbers indicating the row's object IDs.

TableFilter

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

type

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the filter used.

ColumnSortOrder

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of objects containing a column's name and sort direction. This is used in conjunction with FeatureTableViewModel.activeSortOrders to help retain a column's sort order while querying.

See also

FeatureTableViewModel.activeSortOrders

fieldName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The field name as defined by the layer. Set this property to indicate which column to sort. This should match the field name as defined at the feature service level.

direction

Property

Type: Direction

Since: ArcGIS Maps SDK for JavaScript 5.0

Controls the sort order of the column given the set fieldName.

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.

ActionColumnCallbackParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

index

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The index of the associated row.

feature

Property

Type: Graphic

Since: ArcGIS Maps SDK for JavaScript 5.0

A reference to the associated feature.

native

Property

Type: MouseEvent | KeyboardEvent

Since: ArcGIS Maps SDK for JavaScript 5.0

A reference to the interaction event.

ActionColumnCallback

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Function called when an action is clicked or pressed.

Parameters

Parameter	Type	Description	Required
params	ActionColumnCallbackParameters	An object containing information about the associated row and feature.

Returns: void

ActionColumnConfig

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Configuration for the FeatureTable's actionColumn.

label

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The accessible label to display when hovering over the action.

callback

Property

Type: ActionColumnCallback

Since: ArcGIS Maps SDK for JavaScript 5.0

Callback function invoked when the action is clicked or activated via the keyboard.

disabled

Property

Type: ActionColumnDisabledFunction | boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if a specific action should be conditionally disabled.

frozenToEnd

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates the column should be frozen to the end of the table.

icon

Property

Type: Icon["icon"] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The string value indicating the Calcite icon displayed for the action.

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);
 }
}

ActionColumnDisabledParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

feature

Property

Type: Graphic

Since: ArcGIS Maps SDK for JavaScript 5.0

The feature to use when determining if the action should be disabled.

index

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The row's index position when determining if the action should be disabled.

ActionColumnDisabledFunction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The function that is called when determining if an action should be disabled.

Parameters

Parameter	Type	Description	Required
params	ActionColumnDisabledParameters	An object containing information about an associated row and feature.

Returns: boolean
Indicates whether the action should be disabled.

RelatedRecordInfo

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The related records for the associated feature used in the Columns's and FieldColumn's formatFunction.

relationshipId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the relationship defined in the data source.

count

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The number of related records associated with the feature.

SupportedColumnTemplates

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: ColumnTemplate | FieldColumnTemplate | GroupColumnTemplate | AttachmentsColumnTemplate | RelationshipColumnTemplate

GroupColumnSupportedTemplates

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: Exclude<SupportedColumnTemplates‚ GroupColumnTemplate>