React Data GridColumn API

Below are listed all the column API methods.

Column Keys

Some of the API methods take Column Key (named colKey) which has type Column | string. This means you can pass either a Column object (that you receive from calling one of the other methods) or you pass in the Column ID (which is a string). The Column ID is a property of the column definition. If you do not provide the Column ID, the grid will create one for you (first by trying to use the field if it is unique, otherwise it will generate an ID).

Column Groups

See Column Groups

getColumnGroup TypeFunction	Returns the column group with the given name. See: Column Groups
getProvidedColumnGroup TypeFunction	Returns the provided column group with the given name.
setColumnGroupOpened TypeFunction	Call this if you want to open or close a column group.

Columns

getColumn TypeFunction	Returns the column with the given `colKey`, which can either be the `colId` (a string) or the `colDef` (an object).
getColumns TypeFunction	Returns all the columns, regardless of visible or not.
getAllGridColumns TypeFunction	Returns all the grid columns, same as `getColumns()`, except a) it has the order of the columns that are presented in the grid b) it's after the 'pivot' step, so if pivoting, has the value columns for the pivot.

Moving

See Column Moving

moveColumn TypeFunction	Moves a column to `toIndex`. The column is first removed, then added at the `toIndex` location, thus index locations will change to the right of the column after the removal.
moveColumns TypeFunction	Same as `moveColumn` but works on list.
moveColumnByIndex TypeFunction	Same as `moveColumn` but works on index locations.

Pinning

See Column Pinning

isPinning TypeFunction	Returns `true` if pinning left or right, otherwise `false`.
isPinningLeft TypeFunction	Returns `true` if pinning left, otherwise `false`.
isPinningRight TypeFunction	Returns `true` if pinning right, otherwise `false`.
setColumnPinned TypeFunction	Sets the column pinned / unpinned. Key can be the column ID, field, `ColDef` object or `Column` object.
setColumnsPinned TypeFunction	Same as `setColumnPinned`, but provide a list of column keys.

Pivoting

See Pivoting

isPivotMode TypeFunction	Get the pivot mode.
setPivotMode TypeFunction	Set the pivot mode.
getPivotColumns TypeFunction	Get the pivot columns.
setPivotColumns TypeFunction	Set the pivot columns.
addPivotColumn TypeFunction	Add a pivot column.
addPivotColumns TypeFunction	Same as `addPivotColumn` but provide a list of columns.
removePivotColumn TypeFunction	Remove a pivot column.
removePivotColumns TypeFunction	Same as `removePivotColumn` but provide a list of columns.
getPivotResultColumn TypeFunction	Returns the pivot result column for the given `pivotKeys` and `valueColId`. Useful to then call operations on the pivot column.
setPivotResultColumns TypeFunction	Set the pivot result columns.
getPivotResultColumns TypeFunction	Returns the grid's pivot result columns. See: Columns vs Pivot Result Columns

Row Grouping

See Row Grouping

getRowGroupColumns TypeFunction	Get row group columns.
setRowGroupColumns TypeFunction	Set the row group columns.
addRowGroupColumn TypeFunction	Add a column to the row groups.
addRowGroupColumns TypeFunction	Same as `addRowGroupColumn` but provide a list of columns.
removeRowGroupColumn TypeFunction	Remove a column from the row groups.
removeRowGroupColumns TypeFunction	Same as `removeRowGroupColumn` but provide a list of columns.
moveRowGroupColumn TypeFunction	Move the column to a new position in the row grouping order.

Sizing

See Column Sizing

setColumnWidth TypeFunction	Sets the column width on a single column. The finished flag gets included in the resulting event and not used internally by the grid. The finished flag is intended for dragging, where a dragging action will produce many `columnWidth` events, so the consumer of events knows when it receives the last event in a stream. The finished parameter is optional, and defaults to `true`.
setColumnWidths TypeFunction	Sets the column widths on multiple columns. This method offers better performance than calling `setColumnWidth` multiple times. The finished flag gets included in the resulting event and not used internally by the grid. The finished flag is intended for dragging, where a dragging action will produce many `columnWidth` events, so the consumer of events knows when it receives the last event in a stream. The finished parameter is optional, and defaults to `true`.
sizeColumnsToFit TypeFunction	Gets the grid to size the columns to the specified width in pixels, e.g. `sizeColumnsToFit(900)`. To have the grid fit the columns to the grid's width, use the Grid API `gridApi.sizeColumnsToFit()` instead. If inferring cell data types with custom column types and row data is provided asynchronously, the column sizing will happen asynchronously when row data is added. To always perform this synchronously, set `cellDataType = false` on the default column definition.
autoSizeColumn TypeFunction	Auto-sizes a column based on its contents. If inferring cell data types with custom column types and row data is provided asynchronously, the column sizing will happen asynchronously when row data is added. To always perform this synchronously, set `cellDataType = false` on the default column definition.
autoSizeColumns TypeFunction	Same as `autoSizeColumn`, but provide a list of column keys. If inferring cell data types with custom column types and row data is provided asynchronously, the column sizing will happen asynchronously when row data is added. To always perform this synchronously, set `cellDataType = false` on the default column definition.
autoSizeAllColumns TypeFunction	Calls `autoSizeColumns` on all displayed columns. If inferring cell data types with custom column types and row data is provided asynchronously, the column sizing will happen asynchronously when row data is added. To always perform this synchronously, set `cellDataType = false` on the default column definition.

State

See Column State

getColumnState TypeFunction	Gets the state of the columns. Typically used when saving column state.
applyColumnState TypeFunction	Applies the state of the columns from a previous state. Returns `false` if one or more columns could not be found.
resetColumnState TypeFunction	Sets the state back to match the originally provided column definitions.
getColumnGroupState TypeFunction	Gets the state of the column groups. Typically used when saving column group state.
setColumnGroupState TypeFunction	Sets the state of the column group state from a previous state.
resetColumnGroupState TypeFunction	Sets the state back to match the originally provided column definitions.

Value Columns

Methods for management of value column aggregates (for aggregating when grouping or pivoting).

getValueColumns TypeFunction	Get a list of the existing value columns.
addValueColumn TypeFunction	Add the given column to the set of existing value columns.
addValueColumns TypeFunction	Like `addValueColumn` but add the given list of columns to the existing set of value columns.
removeValueColumn TypeFunction	Remove the given column from the existing set of value columns.
removeValueColumns TypeFunction	Like `removeValueColumn` but remove the given list of columns from the existing set of value columns.
setValueColumns TypeFunction	Set the value columns to the provided list of columns.
setColumnAggFunc TypeFunction	Sets the agg function for a column. `aggFunc` can be one of the built-in aggregations or a custom aggregation by name or direct function.

Visibility and Display

setColumnVisible TypeFunction	Sets the visibility of a column. Key can be the column ID or `Column` object.
setColumnsVisible TypeFunction	Same as `setColumnVisible`, but provide a list of column keys.
getDisplayNameForColumn TypeFunction	Returns the display name for a column. Useful if you are doing your own header rendering and want the grid to work out if `headerValueGetter` is used, or if you are doing your own column management GUI, to know what to show as the column name.
getDisplayNameForColumnGroup TypeFunction	Returns the display name for a column group (when grouping columns).
getDisplayedColAfter TypeFunction	Returns the column to the right of the provided column, taking into consideration open / closed column groups and visible columns. This is useful if you need to know what column is beside yours e.g. if implementing your own cell navigation.
getDisplayedColBefore TypeFunction	Same as `getVisibleColAfter` except gives column to the left.
getAllDisplayedVirtualColumns TypeFunction	Same as `getAllGridColumns()`, except only returns rendered columns, i.e. columns that are not within the viewport and therefore not rendered, due to column virtualisation, are not displayed.
getAllDisplayedColumns TypeFunction	Returns all columns currently displayed (e.g. are visible and if in a group, the group is showing the columns) for the pinned left, centre and pinned right portions of the grid.
getDisplayedCenterColumns TypeFunction	Same as `getAllDisplayedColumns` but just for the center portion of the grid.
getDisplayedLeftColumns TypeFunction	Same as `getAllDisplayedColumns` but just for the pinned left portion of the grid.
getDisplayedRightColumns TypeFunction	Same as `getAllDisplayedColumns` but just for the pinned right portion of the grid.
getAllDisplayedColumnGroups TypeFunction	Returns all 'root' column headers. If you are not grouping columns, these return the columns. If you are grouping, these return the top level groups - you can navigate down through each one to get the other lower level headers and finally the columns at the bottom.
getCenterDisplayedColumnGroups TypeFunction	Same as `getAllDisplayedColumnGroups` but just for the center portion of the grid.
getLeftDisplayedColumnGroups TypeFunction	Same as `getAllDisplayedColumnGroups` but just for the pinned left portion of the grid.
getRightDisplayedColumnGroups TypeFunction	Same as `getAllDisplayedColumnGroups` but just for the pinned right portion of the grid.

Column Keys

Column Groups

getColumnGroup

getProvidedColumnGroup

setColumnGroupOpened

Columns

getColumn

getColumns

getAllGridColumns

Moving

moveColumn

moveColumns

moveColumnByIndex

Pinning

isPinning

isPinningLeft

isPinningRight

setColumnPinned

setColumnsPinned

Pivoting

isPivotMode

setPivotMode

getPivotColumns

setPivotColumns

addPivotColumn

addPivotColumns

removePivotColumn

removePivotColumns

getPivotResultColumn

setPivotResultColumns

getPivotResultColumns

Row Grouping

getRowGroupColumns

setRowGroupColumns

addRowGroupColumn

addRowGroupColumns

removeRowGroupColumn

removeRowGroupColumns

moveRowGroupColumn

Sizing

setColumnWidth

setColumnWidths

sizeColumnsToFit

autoSizeColumn

autoSizeColumns

autoSizeAllColumns

State

getColumnState

applyColumnState

resetColumnState

getColumnGroupState

setColumnGroupState

resetColumnGroupState

Value Columns

getValueColumns

addValueColumn

addValueColumns

removeValueColumn

removeValueColumns

setValueColumns

setColumnAggFunc

Visibility and Display

setColumnVisible

setColumnsVisible

getDisplayNameForColumn

getDisplayNameForColumnGroup

getDisplayedColAfter

getDisplayedColBefore

getAllDisplayedVirtualColumns

getAllDisplayedColumns

getDisplayedCenterColumns

getDisplayedLeftColumns

getDisplayedRightColumns

getAllDisplayedColumnGroups

getCenterDisplayedColumnGroups

getLeftDisplayedColumnGroups

getRightDisplayedColumnGroups