AdapTable Version:

Framework:

GridApi

Provides access to important properties and functionalities of AdapTable e.g. sorting, selected cells etc.

TypeScript

export interface

Methods

Method	Description
addAgGridColumnDefinition(columnDefinition)	Adds a Column Definition to the Grid
addGridData(dataRows, config)	Adds rows to AdapTable (and AG Grid)
addOrUpdateGridData(dataRows, config)	Adds or Updates AdapTable (and AG Grid) with new and changed rows
applyFiltering()	Applies current Filtering in AdapTable
clearAdaptableSorting()	Removes Column Sorts in AdapTable
clearFiltering()	Removes all current Filters in AdapTable
clearRowGroupColumns()	Clears Row Grouping in the Grid
closeTransposedView()	Closes the transposed view of the Grid (if open)
collapseAllRowGroups()	Collapse all open groups in Row Grouping
deleteGridData(dataRows, config)	Deletes rows from AdapTable (and AG Grid)
deselectAll()	Deselects all selected rows, cells and ranges
deSelectNode(rowNode, clearSelection)	Deselects the AG Grid Row Node in AdapTable
deSelectNodes(rowNodes, clearSelection)	AG Grid Row Nodes in AdapTable
deSelectRow(primaryKeyValue, clearSelection)	Deselects Row with given Primary Key Value
deSelectRows(primaryKeyValues, clearSelection)	Deselects Row with given Primary Key Values
expandAllRowGroups()	Expands all closed groups in Row Grouping
expandRowGroupsForValues(columnValues)	Expands Row Groups that contain given keys
getAgGridRowModelType()	Returns AG Grid Row Model Type
getAllAgGridColumns()	Return all AG Grid columns
getAllRowNodes(config)	Retrieves all Row Nodes currently in the Grid (by default excluding the group rows)
getCellDisplayValue(primaryKeyValue, columnId)	Retrieves Display Value for a given cell
getCellNormalisedValue(primaryKeyValue, columnId)	Retrieves Normalised Value for a given cell
getCellRawValue(primaryKeyValue, columnId)	Retrieves Raw Value for a given cell
getCellRawValueCount(columnId, rawValue)	Gets the count of the cells in a Column that have the given Raw Value
getCellSummaryInfo()	Returns summary info on Selected Cells
getColumnCount()	Returns number of columns in Data Source
getColumnSortForColumn(columnId)	Retrieves ColumnSort for a given Column
getColumnSorts()	Returns Column Sort information in AdapTable
getDisplayValueFromRawValue(rowNode, columnId, rawValue)	Retrieves Formatted Value for a given Raw Value in given Column
getDisplayValueFromRowNode(rowNode, columnId)	Retrieves Display Value for Cell in given Row and Column
getFilteredData()	Retrieves filtered data from the grid
getFirstDisplayedRowNode()	Retrieves the first Displayed Row Node in AdapTable
getFirstRowNode()	Retrieves the first Row Node in AdapTable
getGridCellFromRowNode(rowNode, columnId)	Retrieves Cell in given Row and Column
getGridCellsForDisplayValue(columnId, displayValue)	Returns all the Grid Cells in a Column that have the given Display Value
getGridCellsForRawValue(columnId, rawValue)	Returns all the Grid Cells in a Column that have the given Raw Value
getGridContainerElement()	Returns the Grid Container in which the AdapTable Instance is present
getGridData()	Retrieves all data from the grid
getGroupRowNodes(config)	Retrieves all Grouped Row Nodes currently in the Grid
getInternalState()	Returns the Internal section from AdapTable State
getNormalisedValueFromRowNode(rowNode, columnId)	Retrieves Normalised Value for Cell in given Row and Column
getPrimaryKeyValueForRowNode(rowNode)	Returns the Primary Kev Value for a given Row Node
getPrimaryKeyValuesForRowNodes(rowNodes)	Returns the Primary Kev Values for a given Row Node collection
getRawValueFromRowNode(rowNode, columnId)	Retrieves Raw Value for Cell in given Row and Column
getRowCount()	Returns number of rows in Data Source
getRowNodeForIndex(rowIndex)	Retrieves the displayed RowNode at the given index
getRowNodeForPrimaryKey(primaryKeyValue)	Retrieves Row Node that contains given Primary Key
getRowNodesForPrimaryKeys(primaryKeyValues)	Retrieves Row Nodes that contain given Primary Keys
getSelectedCellInfo()	Returns all current Selected Cells in AdapTable
getSelectedRowInfo()	Returns all current Selected Rows in AdapTable
getVariant()	Returns current AdapTable Variant: vanilla, angular, react, vue
getVisibleColumnCount()	Returns number of visible columns in Data Source
getVisibleData()	Retrieves visible data from the grid (filtered and sorted)
getVisibleRowCount()	Returns number of rows in Data Source
getVisibleRowNodes(config)	Retrieves all filtered Row Nodes currently in the Grid (i.e. after applying the current filter)
highlightCell(cellHighlightInfo)	Highlights a Cell in AdapTable
highlightColumn(columnHighlightInfo)	Highlights a Column in AdapTable
highlightRow(rowHighlightInfo)	Highlight a row using an adaptable style
highlightRows(rowsHighlightInfo)	Highlight rows using an adaptable style
isCellEditable(gridCell)	Checks if given Grid Cell is editable
isCellEdited(gridCell)	Checks if given Grid Cell has been edited (uses Data Change History)
isEveryCellEditable(gridCells)	Checks if all of given Grid Cells are editable
isGrandTotalRowNode(rowNode)	Whether given Row Node is a Grand Total Row
isGridGroupable()	Whether AdapTable instance can be Row Grouped
isGridInPivotMode()	Whether Grid is currently in Pivot Mode
isGridPivotable()	Whether AdapTable instance can be pivoted
isGridRangeSelectable()	Whether AdapTable instance offers cell range selection
isGridRowGrouped()	Whether Grid is currently showing Row Groups
isGridRowSelectable()	Whether AdapTable instance offers row selection
isGridRowSelected(primaryKeyValue)	Whether a Row is selected
isGroupRowNode(rowNode)	Whether given Row Node is a Row Group
isMasterDetailGrid()	Whether Grid is a Master Detail Grid
isQuickFilterAvailable()	Whether Quick Filter is available in the Grid
isSummaryNode(rowNode)	Whether given Row Node is in a Summary Row
isTreeDataGrid()	Whether Grid displays a Tree Data (structured hierarchical data)
isVisibleRowNode(rowNode)	Whether given Row Node is visible
jumpToCell(primaryKeyValue, columnId, rowNode)	Grid will jump to cell in a given Row and Column
jumpToColumn(columnId)	Grid will jump to Column that has given ColumnId
jumpToRow(primaryKeyValue)	Grid will jump to Row containing given Primary Kev Value
loadGridData(data)	Loads data into grid and fire a `RowChanged.trigger='Load'` event
manageGridData(dataRowConfig, dataUpdateConfig)	Adds, Updates or Deletes rows in AdapTable (and AG Grid) in single transaction
openGridInfoSettingsPanel()	Opens Settings Panel with Grid Info section selected and visible
redrawGrid()	Redraws AdapTable (expensive operation so use sparingly)
refreshAllCells(forceUpdate)	Refreshes all Cells in the Grid
refreshCell(rowNode, columnId, suppressFlash)	Refresh a Cell Value in AdapTable
refreshCells(rowNode, columnIds, suppressFlash)	Refresh Cell Values in AdapTable
refreshColumn(columnId)	Refresh Column Values in AdapTable
refreshColumns(columnIds)	Refresh Columns Values in AdapTable
refreshGridCell(gridCell)	Refreshes a single Grid Cell
refreshGridCells(gridCells)	Refreshes a set of Grid Cells
refreshGroupRowNodes()	Forces a re-render of all Group Rows (including aggregations)
refreshRowByPrimaryKey(primaryKey)	Forces a re-render of Row with given Primary Key value
refreshRowNode(rowNode)	Forces a re-render of the given row
refreshRowNodes(rowNodes)	Forces re-render of given rows (if none provided, all rows are refreshed)
removeAgGridColumnDefinition(columnId)	Removes the Column Definition for a given Column.
selectAll()	Select the whole Grid
selectCellRange(gridCellRange, clearSelection)	Selects a group of cells in a given range - provide either primary keys or row indexes
selectCellRangeByQuery(query, gridCellRange, clearSelection)	Selects a group of cells in a given range using a query
selectColumn(columnId)	Selects a Column in AG Grid
selectColumns(columnIds)	Selects Columns in AG Grid
selectNode(rowNode, clearSelection)	Selects the AG Grid Row Node in AdapTable
selectNodes(rowNodes, clearSelection)	Selects the AG Grid Row Nodes in AdapTable
selectRow(primaryKeyValue, clearSelection)	Selects Row with given Primary Key Value
selectRows(primaryKeyValues, clearSelection)	Selects Rows with given Primary Key Values
setAdaptableSorting(columnSorts)	Sorts AdapTable using given Column Sorts
setAgGridColumnDefinitions(columnDefinitions)	Sets the Column Definitions for the Grid
setCellValue(cellUpdateRequest)	Updates cell in AdapTable (first performs Cell & Server Validation)
setCellValues(cellUpdateRequests)	Updates multiple cells
setRowGroupColumns(columnIds)	Sets the grid to Row Group
showTransposedView(transposeConfig)	Opens a window with a transposed view of Grid
undoCellEdit(cellDataChangedInfo)	Reverses a data change (if triggered by cell edit)
unHighlightAllCells()	Unhighlights all highlighted Cells in AdapTable
unHighlightAllColumns()	Unhighlights all highlighted Columns in AdapTable
unHighlightAllRows()	Remove all highlighted rows
unHighlightCell(primaryKeyValue, columnId)	Unhighlights a Cell in AdapTable
unHighlightColumn(columnId)	Unhighlights a Column in AdapTable
unHighlightRow(primaryKeyValue)	Remove highlight from Row
unHighlightRows(primaryKeyValues)	Remove highlight from given Rows
updateAgGridColumnDefinition(columnDefinition)	Updates Column Definition for given Column; use to update NON-STATEFUL AG Grid Column props (which are merged with existing Column Def)
updateAgGridColumnDefinitions(columnDefinitions)	Updates Column Definition for given Columns; use to update NON-STATEFUL AG Grid Column props (which are merged with existing Column Def)
updateAgGridColumnState(columnState)	Updates Ag Grid Column State for a given Column; use to update STATEFUL AG Grid Column props
updateAgGridColumnStates(columnStates)	Updates Ag Grid Column State for given Columns; use to update STATEFUL AG Grid Column props
updateGridData(dataRows, config)	Updates AdapTable (and AG Grid) with rows that have changed

Method Details

addAgGridColumnDefinition

Adds a Column Definition to the Grid

TypeScript

addAgGridColumnDefinition(columnDefinition: ColDefWithId): void;

Parameters

Parameter	Type	Description
columnDefinition	`ColDefWithId`	the new Column Definition

Returns

void

addGridData

Adds rows to AdapTable (and AG Grid)

TypeScript

addGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;

Parameters

Parameter	Type	Description
dataRows	`any[]`	rows to add; ensure all 'mandatory' fields are included and Primary Key is unique
config	`DataUpdateConfig`	batch option and callback function to run post addition

Returns

Promise<IRowNode[]>

addOrUpdateGridData

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

TypeScript

addOrUpdateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<{
        addedRows: IRowNode[];
        updatedRows: IRowNode[];
    }>;

Parameters

Parameter	Type	Description
dataRows	`any[]`	rows to add or update
config	`DataUpdateConfig`	batch option and callback function to run post change

Returns

Promise<\{ addedRows: IRowNode[]; updatedRows: IRowNode[]; \}>

applyFiltering

Applies current Filtering in AdapTable

TypeScript

applyFiltering(): void;

Returns

void

clearAdaptableSorting

Removes Column Sorts in AdapTable

TypeScript

clearAdaptableSorting(): void;

Returns

void

clearFiltering

Removes all current Filters in AdapTable

TypeScript

clearFiltering(): void;

Returns

void

clearRowGroupColumns

Clears Row Grouping in the Grid

TypeScript

clearRowGroupColumns(): void;

Returns

void

closeTransposedView

Closes the transposed view of the Grid (if open)

TypeScript

closeTransposedView(): void;

Returns

void

collapseAllRowGroups

Collapse all open groups in Row Grouping

TypeScript

collapseAllRowGroups(): void;

Returns

void

deleteGridData

Deletes rows from AdapTable (and AG Grid)

TypeScript

deleteGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;

Parameters

Parameter	Type	Description
dataRows	`any[]`	rows which should be deleted
config	`DataUpdateConfig`	batch option and callback function to run post deletion

Returns

Promise<IRowNode[]>

deselectAll

Deselects all selected rows, cells and ranges

TypeScript

deselectAll(): void;

Returns

void

deSelectNode

Deselects the AG Grid Row Node in AdapTable

TypeScript

deSelectNode(rowNode: IRowNode, clearSelection: boolean): void;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Node to DeSelect
clearSelection	`boolean`	Whether to clear current selection in grid

Returns

void

deSelectNodes

AG Grid Row Nodes in AdapTable

TypeScript

deSelectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;

Parameters

Parameter	Type	Description
rowNodes	`IRowNode[]`	Nodes to DeSelect
clearSelection	`boolean`	Whether to clear current selection in grid

Returns

void

deSelectRow

Deselects Row with given Primary Key Value

TypeScript

deSelectRow(primaryKeyValue: any, clearSelection: boolean): void;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	Primary Key Value of Row to deselect
clearSelection	`boolean`	Whether to clear current selection in grid

Returns

void

deSelectRows

Deselects Row with given Primary Key Values

TypeScript

deSelectRows(primaryKeyValues: any[], clearSelection: boolean): void;

Parameters

Parameter	Type	Description
primaryKeyValues	`any[]`	Primary Key Values of Rows to deselect
clearSelection	`boolean`	Whether to clear current selection in grid

Returns

void

expandAllRowGroups

Expands all closed groups in Row Grouping

TypeScript

expandAllRowGroups(): void;

Returns

void

expandRowGroupsForValues

Expands Row Groups that contain given keys

TypeScript

expandRowGroupsForValues(columnValues: any[]): void;

Parameters

Parameter	Type	Description
columnValues	`any[]`	values to open Row Groups for

Returns

void

getAgGridRowModelType

Returns AG Grid Row Model Type

TypeScript

getAgGridRowModelType(): RowModelType;

Returns

RowModelType

getAllAgGridColumns

Return all AG Grid columns

TypeScript

getAllAgGridColumns(): Column<any>[];

Returns

Column<any>[]

getAllRowNodes

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

TypeScript

getAllRowNodes(config?: {
        includeGroupRows?: boolean;
        filterFn?(rowNode: IRowNode): boolean;
    }): IRowNode[];

Parameters

Parameter	Type	Description
config	`\{ includeGroupRows?: boolean; filterFn?(rowNode: IRowNode): boolean; \}`	configuration

Returns

IRowNode[]

getCellDisplayValue

Retrieves Display Value for a given cell

TypeScript

getCellDisplayValue(primaryKeyValue: any, columnId: string): any | undefined;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	(unique) value in Primary Key Column
columnId	`string`	name of Column which contains the cell

Returns

any | undefined

getCellNormalisedValue

Retrieves Normalised Value for a given cell

TypeScript

getCellNormalisedValue(primaryKeyValue: any, columnId: string): any | undefined;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	(unique) value in Primary Key Column
columnId	`string`	name of Column which contains the cell

Returns

any | undefined

getCellRawValue

Retrieves Raw Value for a given cell

TypeScript

getCellRawValue(primaryKeyValue: any, columnId: string): any | undefined;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	(unique) value in Primary Key Column
columnId	`string`	name of Column which contains the cell

Returns

any | undefined

getCellRawValueCount

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

TypeScript

getCellRawValueCount(columnId: string, rawValue: any): number;

Parameters

Parameter	Type	Description
columnId	`string`	ColumnId to lookup
rawValue	`any`	Raw Value to use

Returns

number

getCellSummaryInfo

Returns summary info on Selected Cells

TypeScript

getCellSummaryInfo(): CellSummmaryInfo;

Returns

CellSummmaryInfo

getColumnCount

Returns number of columns in Data Source

TypeScript

getColumnCount(): number;

Returns

number

getColumnSortForColumn

Retrieves ColumnSort for a given Column

TypeScript

getColumnSortForColumn(columnId: string): ColumnSort | undefined;

Parameters

Parameter	Type	Description
columnId	`string`	Id of Column to retrieve ColumnSort

Returns

ColumnSort | undefined

getColumnSorts

Returns Column Sort information in AdapTable

TypeScript

getColumnSorts(): ColumnSort[];

Returns

ColumnSort[]

getDisplayValueFromRawValue

Retrieves Formatted Value for a given Raw Value in given Column

TypeScript

getDisplayValueFromRawValue(rowNode: IRowNode, columnId: string, rawValue: any): string | undefined;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Node containig the Column
columnId	`string`	ColumnId to lookup
rawValue	`any`	Raw Value

Returns

string | undefined

getDisplayValueFromRowNode

Retrieves Display Value for Cell in given Row and Column

TypeScript

getDisplayValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Row to use
columnId	`string`	ColumnId to lookup

Returns

any | undefined

getFilteredData

Retrieves filtered data from the grid

TypeScript

getFilteredData(): any[];

Returns

any[]

getFirstDisplayedRowNode

Retrieves the first Displayed Row Node in AdapTable

TypeScript

getFirstDisplayedRowNode(): IRowNode | undefined;

Returns

IRowNode | undefined

getFirstRowNode

Retrieves the first Row Node in AdapTable

TypeScript

getFirstRowNode(): IRowNode | undefined;

Returns

IRowNode | undefined

getGridCellFromRowNode

Retrieves Cell in given Row and Column

TypeScript

getGridCellFromRowNode(rowNode: IRowNode, columnId: string): GridCell | undefined;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Row to use
columnId	`string`	ColumnId to lookup

Returns

GridCell | undefined

getGridCellsForDisplayValue

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

TypeScript

getGridCellsForDisplayValue(columnId: string, displayValue: any): GridCell[] | undefined;

Parameters

Parameter	Type	Description
columnId	`string`	ColumnId to lookup
displayValue	`any`	Display Value to use

Returns

GridCell[] | undefined

getGridCellsForRawValue

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

TypeScript

getGridCellsForRawValue(columnId: string, rawValue: any): GridCell[] | undefined;

Parameters

Parameter	Type	Description
columnId	`string`	ColumnId to lookup
rawValue	`any`	Raw Value to use

Returns

GridCell[] | undefined

getGridContainerElement

Returns the Grid Container in which the AdapTable Instance is present

TypeScript

getGridContainerElement(): HTMLElement | null;

Returns

HTMLElement | null

getGridData

Retrieves all data from the grid

TypeScript

getGridData(): any[];

Returns

any[]

getGroupRowNodes

Retrieves all Grouped Row Nodes currently in the Grid

TypeScript

getGroupRowNodes(config?: {
        filterFn?(rowNode: IRowNode): boolean;
    }): IRowNode[];

Parameters

Parameter	Type	Description
config	`\{ filterFn?(rowNode: IRowNode): boolean; \}`	configuration

Returns

IRowNode[]

getInternalState

Returns the Internal section from AdapTable State

TypeScript

getInternalState(): InternalState;

Returns

InternalState

getNormalisedValueFromRowNode

Retrieves Normalised Value for Cell in given Row and Column

TypeScript

getNormalisedValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Row to use
columnId	`string`	ColumnId to lookup

Returns

any | undefined

getPrimaryKeyValueForRowNode

Returns the Primary Kev Value for a given Row Node

TypeScript

getPrimaryKeyValueForRowNode(rowNode: IRowNode): any;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	rowNode to look up

Returns

any

getPrimaryKeyValuesForRowNodes

Returns the Primary Kev Values for a given Row Node collection

TypeScript

getPrimaryKeyValuesForRowNodes(rowNodes: IRowNode[]): any[];

Parameters

Parameter	Type
rowNodes	`IRowNode[]`

Returns

any[]

getRawValueFromRowNode

Retrieves Raw Value for Cell in given Row and Column

TypeScript

getRawValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Row to use
columnId	`string`	ColumnId to lookup

Returns

any | undefined

getRowCount

Returns number of rows in Data Source

TypeScript

getRowCount(): number;

Returns

number

getRowNodeForIndex

Retrieves the displayed RowNode at the given index

TypeScript

getRowNodeForIndex(rowIndex: number): IRowNode | undefined;

Parameters

Parameter	Type	Description
rowIndex	`number`	row index

Returns

IRowNode | undefined

getRowNodeForPrimaryKey

Retrieves Row Node that contains given Primary Key

TypeScript

getRowNodeForPrimaryKey(primaryKeyValue: any): IRowNode;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	Primary Key Value to look up

Returns

IRowNode

getRowNodesForPrimaryKeys

Retrieves Row Nodes that contain given Primary Keys

TypeScript

getRowNodesForPrimaryKeys(primaryKeyValues: any[]): IRowNode[];

Parameters

Parameter	Type	Description
primaryKeyValues	`any[]`	Primary Kev Values to look up

Returns

IRowNode[]

getSelectedCellInfo

Returns all current Selected Cells in AdapTable

TypeScript

getSelectedCellInfo(): SelectedCellInfo;

Returns

SelectedCellInfo

getSelectedRowInfo

Returns all current Selected Rows in AdapTable

TypeScript

getSelectedRowInfo(): SelectedRowInfo;

Returns

SelectedRowInfo

getVariant

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

TypeScript

getVariant(): AdaptableVariant;

Returns

AdaptableVariant

getVisibleColumnCount

Returns number of visible columns in Data Source

TypeScript

getVisibleColumnCount(): number;

Returns

number

getVisibleData

Retrieves visible data from the grid (filtered and sorted)

TypeScript

getVisibleData(): any[];

Returns

any[]

getVisibleRowCount

Returns number of rows in Data Source

TypeScript

getVisibleRowCount(): number;

Returns

number

getVisibleRowNodes

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

TypeScript

getVisibleRowNodes(config?: {
        includeGroupRows?: boolean;
        filterFn?(rowNode: IRowNode): boolean;
    }): IRowNode[];

Parameters

Parameter	Type	Description
config	`\{ includeGroupRows?: boolean; filterFn?(rowNode: IRowNode): boolean; \}`	configuration

Returns

IRowNode[]

highlightCell

Highlights a Cell in AdapTable

TypeScript

highlightCell(cellHighlightInfo: CellHighlightInfo): void;

Parameters

Parameter	Type	Description
cellHighlightInfo	`CellHighlightInfo`	cell to highlight

Returns

void

highlightColumn

Highlights a Column in AdapTable

TypeScript

highlightColumn(columnHighlightInfo: ColumnHighlightInfo): void;

Parameters

Parameter	Type	Description
columnHighlightInfo	`ColumnHighlightInfo`	column to highlight

Returns

void

highlightRow

Highlight a row using an adaptable style

TypeScript

highlightRow(rowHighlightInfo: RowHighlightInfo): void;

Parameters

Parameter	Type	Description
rowHighlightInfo	`RowHighlightInfo`	highlight instructions

Returns

void

highlightRows

Highlight rows using an adaptable style

TypeScript

highlightRows(rowsHighlightInfo: RowsHighlightInfo): void;

Parameters

Parameter	Type
rowsHighlightInfo	`RowsHighlightInfo`

Returns

void

isCellEditable

Checks if given Grid Cell is editable

TypeScript

isCellEditable(gridCell: GridCell): boolean;

Parameters

Parameter	Type	Description
gridCell	`GridCell`	Cell to check

Returns

boolean

isCellEdited

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

TypeScript

isCellEdited(gridCell: GridCell): boolean;

Parameters

Parameter	Type	Description
gridCell	`GridCell`	Cell to check

Returns

boolean

isEveryCellEditable

Checks if all of given Grid Cells are editable

TypeScript

isEveryCellEditable(gridCells: GridCell[]): boolean;

Parameters

Parameter	Type	Description
gridCells	`GridCell[]`	cells to check

Returns

boolean

isGrandTotalRowNode

Whether given Row Node is a Grand Total Row

TypeScript

isGrandTotalRowNode(rowNode: IRowNode): boolean;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Node to check

Returns

boolean

isGridGroupable

Whether AdapTable instance can be Row Grouped

TypeScript

isGridGroupable(): boolean;

Returns

boolean

isGridInPivotMode

Whether Grid is currently in Pivot Mode

TypeScript

isGridInPivotMode(): boolean;

Returns

boolean

isGridPivotable

Whether AdapTable instance can be pivoted

TypeScript

isGridPivotable(): boolean;

Returns

boolean

isGridRangeSelectable

Whether AdapTable instance offers cell range selection

TypeScript

isGridRangeSelectable(): boolean;

Returns

boolean

isGridRowGrouped

Whether Grid is currently showing Row Groups

TypeScript

isGridRowGrouped(): boolean;

Returns

boolean

isGridRowSelectable

Whether AdapTable instance offers row selection

TypeScript

isGridRowSelectable(): boolean;

Returns

boolean

isGridRowSelected

Whether a Row is selected

TypeScript

isGridRowSelected(primaryKeyValue: any): boolean;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	pkVaue of Row to check

Returns

boolean

isGroupRowNode

Whether given Row Node is a Row Group

TypeScript

isGroupRowNode(rowNode: IRowNode): boolean;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Node to check

Returns

boolean

isMasterDetailGrid

Whether Grid is a Master Detail Grid

TypeScript

isMasterDetailGrid(): boolean;

Returns

boolean

isQuickFilterAvailable

Whether Quick Filter is available in the Grid

TypeScript

isQuickFilterAvailable(): boolean;

Returns

boolean

isSummaryNode

Whether given Row Node is in a Summary Row

TypeScript

isSummaryNode(rowNode: IRowNode): boolean;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Node to check

Returns

boolean

isTreeDataGrid

Whether Grid displays a Tree Data (structured hierarchical data)

TypeScript

isTreeDataGrid(): boolean;

Returns

boolean

isVisibleRowNode

Whether given Row Node is visible

TypeScript

isVisibleRowNode(rowNode: IRowNode): boolean;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Node to check

Returns

boolean

jumpToCell

Grid will jump to cell in a given Row and Column

TypeScript

jumpToCell(primaryKeyValue: any, columnId: string, rowNode?: IRowNode): void;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	value in Primary Key Column
columnId	`string`	Id of Column
rowNode	`IRowNode`	AG Grid RowNode

Returns

void

jumpToColumn

Grid will jump to Column that has given ColumnId

TypeScript

jumpToColumn(columnId: string): void;

Parameters

Parameter	Type	Description
columnId	`string`	Id of Column to jump to

Returns

void

jumpToRow

Grid will jump to Row containing given Primary Kev Value

TypeScript

jumpToRow(primaryKeyValue: any): void;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	value in Primary Key Column

Returns

void

loadGridData

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

TypeScript

loadGridData(data: any): void;

Parameters

Parameter	Type	Description
data	`any`	data to load

Returns

void

manageGridData

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

TypeScript

manageGridData(dataRowConfig: DataRowConfig, dataUpdateConfig?: DataUpdateConfig): Promise<{
        addedRows: IRowNode[];
        updatedRows: IRowNode[];
        removedRows: IRowNode[];
    }>;

Parameters

Parameter	Type	Description
dataRowConfig	`DataRowConfig`	Rows to add, update or remove
dataUpdateConfig	`DataUpdateConfig`	batch option and callback function to run post transaction

Returns

Promise<\{ addedRows: IRowNode[]; updatedRows: IRowNode[]; removedRows: IRowNode[]; \}>

openGridInfoSettingsPanel

Opens Settings Panel with Grid Info section selected and visible

TypeScript

openGridInfoSettingsPanel(): void;

Returns

void

redrawGrid

Redraws AdapTable (expensive operation so use sparingly)

TypeScript

redrawGrid(): void;

Returns

void

refreshAllCells

Refreshes all Cells in the Grid

TypeScript

refreshAllCells(forceUpdate?: boolean): void;

Parameters

Parameter	Type	Description
forceUpdate	`boolean`	forces AG Grid change detection

Returns

void

refreshCell

Refresh a Cell Value in AdapTable

TypeScript

refreshCell(rowNode: IRowNode, columnId: string, suppressFlash?: boolean): void;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	AG Grid RowNode which contains cell to refresh
columnId	`string`	ColumnId which contains cell to refresh
suppressFlash	`boolean`

Returns

void

refreshCells

Refresh Cell Values in AdapTable

TypeScript

refreshCells(rowNode: IRowNode, columnIds: string[], suppressFlash?: boolean): void;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	agGrid RowNode which contains cells to refresh
columnIds	`string[]`	ColumnIds which contain cells to refresh
suppressFlash	`boolean`

Returns

void

refreshColumn

Refresh Column Values in AdapTable

TypeScript

refreshColumn(columnId: string): void;

Parameters

Parameter	Type	Description
columnId	`string`	the ID of the Column to refresh

Returns

void

refreshColumns

Refresh Columns Values in AdapTable

TypeScript

refreshColumns(columnIds: string[]): void;

Parameters

Parameter	Type	Description
columnIds	`string[]`	the IDs of the Columns to refresh

Returns

void

refreshGridCell

Refreshes a single Grid Cell

TypeScript

refreshGridCell(gridCell: GridCell): void;

Parameters

Parameter	Type	Description
gridCell	`GridCell`	GridCell to refresh

Returns

void

refreshGridCells

Refreshes a set of Grid Cells

TypeScript

refreshGridCells(gridCells: GridCell[]): void;

Parameters

Parameter	Type	Description
gridCells	`GridCell[]`	GridCells to refresh

Returns

void

refreshGroupRowNodes

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

TypeScript

refreshGroupRowNodes(): void;

Returns

void

refreshRowByPrimaryKey

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

TypeScript

refreshRowByPrimaryKey(primaryKey: any): void;

Parameters

Parameter	Type	Description
primaryKey	`any`	row primary key

Returns

void

refreshRowNode

Forces a re-render of the given row

TypeScript

refreshRowNode(rowNode: IRowNode): void;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	AG Grid Row

Returns

void

refreshRowNodes

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

TypeScript

refreshRowNodes(rowNodes?: IRowNode[]): void;

Parameters

Parameter	Type	Description
rowNodes	`IRowNode[]`	AG Grid rows

Returns

void

removeAgGridColumnDefinition

Removes the Column Definition for a given Column.

TypeScript

removeAgGridColumnDefinition(columnId: string): void;

Parameters

Parameter	Type	Description
columnId	`string`	the ColumnId to remove

Returns

void

selectAll

Select the whole Grid

TypeScript

selectAll(): void;

Returns

void

selectCellRange

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

TypeScript

selectCellRange(gridCellRange: GridCellRange, clearSelection?: boolean): void;

Parameters

Parameter	Type	Description
gridCellRange	`GridCellRange`	Range to select
clearSelection	`boolean`	Whether to clear current selection in grid

Returns

void

selectCellRangeByQuery

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

TypeScript

selectCellRangeByQuery(query: string, gridCellRange?: GridCellRange, clearSelection?: boolean): void;

Parameters

Parameter	Type	Description
query	`string`	query to use to select cells
gridCellRange	`GridCellRange`	optional range to filter results
clearSelection	`boolean`	whether to clear current selection in grid

Returns

void

selectColumn

Selects a Column in AG Grid

TypeScript

selectColumn(columnId: string): void;

Parameters

Parameter	Type	Description
columnId	`string`	Id of Column to Select

Returns

void

selectColumns

Selects Columns in AG Grid

TypeScript

selectColumns(columnIds: string[]): void;

Parameters

Parameter	Type	Description
columnIds	`string[]`	Ids of Columns to Select

Returns

void

selectNode

Selects the AG Grid Row Node in AdapTable

TypeScript

selectNode(rowNode: IRowNode, clearSelection: boolean): void;

Parameters

Parameter	Type	Description
rowNode	`IRowNode`	Node to Select
clearSelection	`boolean`	Whether to clear current selection in grid

Returns

void

selectNodes

Selects the AG Grid Row Nodes in AdapTable

TypeScript

selectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;

Parameters

Parameter	Type	Description
rowNodes	`IRowNode[]`	Nodes to Select
clearSelection	`boolean`	Whether to clear current selection in grid

Returns

void

selectRow

Selects Row with given Primary Key Value

TypeScript

selectRow(primaryKeyValue: any, clearSelection: boolean): void;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	Primary Key Value of Row to select
clearSelection	`boolean`	Whether to clear current selection in grid

Returns

void

selectRows

Selects Rows with given Primary Key Values

TypeScript

selectRows(primaryKeyValues: any[], clearSelection: boolean): void;

Parameters

Parameter	Type	Description
primaryKeyValues	`any[]`	Primary Key Values of Rows to select
clearSelection	`boolean`	Whether to clear current selection in grid

Returns

void

setAdaptableSorting

Sorts AdapTable using given Column Sorts

TypeScript

setAdaptableSorting(columnSorts: ColumnSort[]): void;

Parameters

Parameter	Type	Description
columnSorts	`ColumnSort[]`	Column Sorts to use

Returns

void

setAgGridColumnDefinitions

Sets the Column Definitions for the Grid

TypeScript

setAgGridColumnDefinitions(columnDefinitions: (ColDef | ColGroupDef)[]): void;

Parameters

Parameter	Type
columnDefinitions	`(ColDef \| ColGroupDef)[]`

Returns

void

setCellValue

Updates cell in AdapTable (first performs Cell & Server Validation)

TypeScript

setCellValue(cellUpdateRequest: CellUpdateRequest): void;

Parameters

Parameter	Type	Description
cellUpdateRequest	`CellUpdateRequest`	(contains columnId, newValue and primaryKeyValue

Returns

void

setCellValues

Updates multiple cells

TypeScript

setCellValues(cellUpdateRequests: CellUpdateRequest[]): void;

Parameters

Parameter	Type
cellUpdateRequests	`CellUpdateRequest[]`

Returns

void

setRowGroupColumns

Sets the grid to Row Group

TypeScript

setRowGroupColumns(columnIds: string[]): void;

Parameters

Parameter	Type	Description
columnIds	`string[]`	ColumnIds to row group

Returns

void

showTransposedView

Opens a window with a transposed view of Grid

TypeScript

showTransposedView(transposeConfig?: TransposeConfig): void;

Parameters

Parameter	Type
transposeConfig	`TransposeConfig`

Returns

void

undoCellEdit

Reverses a data change (if triggered by cell edit)

TypeScript

undoCellEdit(cellDataChangedInfo: CellDataChangedInfo): boolean;

Parameters

Parameter	Type	Description
cellDataChangedInfo	`CellDataChangedInfo`	data change to undo

Returns

boolean

unHighlightAllCells

Unhighlights all highlighted Cells in AdapTable

TypeScript

unHighlightAllCells(): void;

Returns

void

unHighlightAllColumns

Unhighlights all highlighted Columns in AdapTable

TypeScript

unHighlightAllColumns(): void;

Returns

void

unHighlightAllRows

Remove all highlighted rows

TypeScript

unHighlightAllRows(): void;

Returns

void

unHighlightCell

Unhighlights a Cell in AdapTable

TypeScript

unHighlightCell(primaryKeyValue: any, columnId: string): void;

Parameters

Parameter	Type	Description
primaryKeyValue	`any`	pkvalue of cell to unhilight
columnId	`string`	column id of cell to unhilight

Returns

void

unHighlightColumn

Unhighlights a Column in AdapTable

TypeScript

unHighlightColumn(columnId: string): void;

Parameters

Parameter	Type	Description
columnId	`string`	column to unhighlight

Returns

void

unHighlightRow

Remove highlight from Row

TypeScript

unHighlightRow(primaryKeyValue: RowHighlightInfo['primaryKeyValue']): void;

Parameters

Parameter	Type	Description
primaryKeyValue	`RowHighlightInfo['primaryKeyValue']`	value in Primary Key Column

Returns

void

unHighlightRows

Remove highlight from given Rows

TypeScript

unHighlightRows(primaryKeyValues: RowsHighlightInfo['primaryKeyValues']): void;

Parameters

Parameter	Type	Description
primaryKeyValues	`RowsHighlightInfo['primaryKeyValues']`	values in Primary Key Column

Returns

void

updateAgGridColumnDefinition

Updates Column Definition for given Column; use to update NON-STATEFUL AG Grid Column props (which are merged with existing Column Def)

TypeScript

updateAgGridColumnDefinition(columnDefinition: ColDefWithId): void;

Parameters

Parameter	Type	Description
columnDefinition	`ColDefWithId`	the new Column Definition

Returns

void

updateAgGridColumnDefinitions

Updates Column Definition for given Columns; use to update NON-STATEFUL AG Grid Column props (which are merged with existing Column Def)

TypeScript

updateAgGridColumnDefinitions(columnDefinitions: ColDefWithId[]): void;

Parameters

Parameter	Type
columnDefinitions	`ColDefWithId[]`

Returns

void

updateAgGridColumnState

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

TypeScript

updateAgGridColumnState(columnState: ColumnState): void;

Parameters

Parameter	Type	Description
columnState	`ColumnState`	the AG Grid ColumnState to set

Returns

void

updateAgGridColumnStates

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

TypeScript

updateAgGridColumnStates(columnStates: ColumnState[]): void;

Parameters

Parameter	Type	Description
columnStates	`ColumnState[]`	the AG Grid ColumnState to set

Returns

void

updateGridData

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

TypeScript

updateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;

Parameters

Parameter	Type	Description
dataRows	`any[]`	rows which have been updated - send whole row and AdapTable take cares of the rest
config	`DataUpdateConfig`	batch option and callback function to run post update

Returns

Promise<IRowNode[]>

PreviousGradientStyle NextGridCell

Framework: