Grid Data Technical Reference

Adds a Column Definition to the Grid

Adds rows to AdapTable (and AG Grid)

Adds or Updates AdapTable (and AG Grid) with new and changed rows

Applies current Filtering in AdapTable

Removes Column Sorts in AdapTable

Removes all current Filters in AdapTable

Clears Row Grouping in the Grid

Closes the transposed view of the Grid (if open)

Collapse all open groups in Row Grouping

Deletes rows from AdapTable (and AG Grid)

Deselects all selected rows, cells and ranges

Deselects the AG Grid Row Node in AdapTable

AG Grid Row Nodes in AdapTable

Deselects Row with given Primary Key Value

Deselects Row with given Primary Key Values

Expands all closed groups in Row Grouping

Expands Row Groups that contain given keys

Returns AG Grid Row Model Type

Return all AG Grid columns

Retrieves all Row Nodes currently in the Grid (by default excluding the group rows)

Retrieves Display Value for a given cell

Retrieves Normalised Value for a given cell

Retrieves Raw Value for a given cell

Gets the count of the cells in a Column that have the given Raw Value

Returns summary info on Selected Cells

Number of columns in the grid, including hidden columns.

Retrieves all the values for a single Column.

Retrieves ColumnSort for a given Column

Returns Column Sort information in AdapTable

Retrieves the displayed (formatted but not styled) data from the grid (filtered and sorted and visible columns only)

Retrieves Formatted Value for a given Raw Value in given Column

Retrieves Display Value for Cell in given Row and Column

Retrieves the distinct raw values currently in a Column, sorted.

Useful when building dropdown options (e.g. Action Column select, Forms)
from values that already exist in the Grid.

Returns an empty array if the Column is unknown.

Retrieves the filtered values for a single Column.

Retrieves filtered data from the grid

Retrieves the first Displayed Row Node in AdapTable

Retrieves the first Row Node in AdapTable

Retrieves Cell in given Row and Column

Returns all the Grid Cells in a Column that have the given Display Value

Returns all the Grid Cells in a Column that have the given Raw Value

Returns the Grid Container in which the AdapTable Instance is present

Retrieves all data from the grid

Retrieves all Grouped Row Nodes currently in the Grid

Returns the Internal section from AdapTable State

Retrieves Normalised Value for Cell in given Row and Column

Returns the Primary Key Value for a given Row Node

Returns the Primary Key Values for a given Row Node collection

Retrieves Raw Value for Cell in given Row and Column

Number of data rows, excluding group rows.

Retrieves the displayed RowNode at the given index

Retrieves Row Node that contains given Primary Key

Retrieves Row Nodes that contain given Primary Keys

Returns all current Selected Cells in AdapTable

Returns all current Selected Rows in AdapTable

Returns current AdapTable Variant: vanilla, angular, react, vue

Number of columns that are currently visible.

Retrieves the visible (filtered and sorted) values for a single Column.

Retrieves visible data from the grid (filtered and sorted from visible columns only)

Number of rows currently displayed, after filtering.

Retrieves all filtered Row Nodes currently in the Grid (i.e. after applying the current filter)

Highlights a Cell in AdapTable

Highlights a Column in AdapTable

Highlight a row using an adaptable style

Highlight rows using an adaptable style

Checks if given Grid Cell is editable

Checks if given Grid Cell has been edited (uses Data Change History)

Checks if all of given Grid Cells are editable

Whether given Row Node is a Grand Total Row

Whether AdapTable instance can be Row Grouped

Whether Grid is currently in Pivot Mode

Whether AdapTable instance can be pivoted

Whether AdapTable instance offers cell range selection

Whether Grid is currently showing Row Groups

Whether AdapTable instance offers row selection

Whether a Row is selected

Whether given Row Node is a Row Group

Whether Grid is a Master Detail Grid

Whether Quick Filter is available in the Grid

Whether given Row Node is in a Summary Row

Whether Grid displays a Tree Data (structured hierarchical data)

Whether given Row Node is visible

Grid will jump to cell in a given Row and Column

Grid will jump to Column that has given ColumnId

Grid will jump to Row containing given Primary Key Value

Loads data into grid and fire a RowChanged.trigger='Load' event

Adds, Updates or Deletes rows in AdapTable (and AG Grid) in single transaction

Opens Settings Panel with Grid Info section selected and visible

Redraws AdapTable (expensive operation so use sparingly)

Refreshes all Cells in the Grid

Refresh a Cell Value in AdapTable

Refresh Cell Values in AdapTable

Refresh Column Values in AdapTable

Refresh Columns Values in AdapTable

Refreshes a single Grid Cell

Refreshes a set of Grid Cells

Forces a re-render of the Grid Header

Forces a re-render of all Group Rows (including aggregations)

Forces a re-render of Row with given Primary Key value

Forces a re-render of the given row

Forces re-render of given rows (if none provided, all rows are refreshed)

Removes the Column Definition for a given Column.

Select the whole Grid

Selects a group of cells in a given range - provide either primary keys or row indexes

Selects a group of cells in a given range using a query

Selects a Column in AG Grid

Selects Columns in AG Grid

Selects the AG Grid Row Node in AdapTable

Selects the AG Grid Row Nodes in AdapTable

Selects Row with given Primary Key Value

Selects Rows with given Primary Key Values

Sorts AdapTable using given Column Sorts

Replaces the grid's column definitions.

Updates cell in AdapTable (as an AG Grid edit)

Updates multiple cells

Sets the grid to Row Group

Opens a window with a transposed view of the grid.

Reverses a data change (if triggered by cell edit)

Unhighlights all highlighted Cells in AdapTable

Unhighlights all highlighted Columns in AdapTable

Remove all highlighted rows

Unhighlights a Cell in AdapTable

Unhighlights a Column in AdapTable

Remove highlight from Row

Remove highlight from given Rows

Merges non-stateful AG Grid column properties into an existing column definition. The column is matched by colId. A column that does not exist yet is added.

Merges non-stateful AG Grid column properties into the given column definitions. Each column is matched by colId.

Updates Ag Grid Column State for a given Column; use to update STATEFUL AG Grid Column props

Updates Ag Grid Column State for given Columns; use to update STATEFUL AG Grid Column props

Updates AdapTable (and AG Grid) with rows that have changed

Rows that changed, and whether they were added, updated, deleted or loaded.

Custom application Context provided in AdaptableOptions.adaptableContext

Timestamp of change occurrence (in milliseconds)

Data rows that have been added, updated, or deleted

Row Nodes that were affected by this change

Trigger for row change: Load, Add, Update, or Delete