Angular Data GridGrid API Reference

To access the api see: Grid Api.

Accessories

showColumnMenuAfterButtonClick TypeFunction	Shows the column menu after and positions it relative to the provided button element. Use in conjunction with your own header template.
showColumnMenuAfterMouseClick TypeFunction	Shows the column menu after and positions it relative to the mouse event. Use in conjunction with your own header template.
hidePopupMenu TypeFunction	Hides any visible context menu or column menu.
getSideBar TypeFunction	Returns the current side bar configuration. If a shortcut was used, returns the detailed long form. See: Side Bar API
setSideBarVisible TypeFunction	Show/hide the entire side bar, including any visible panel and the tab buttons. See: Side Bar
isSideBarVisible TypeFunction	Returns `true` if the side bar is visible. See: Side Bar
setSideBarPosition TypeFunction	Sets the side bar position relative to the grid. Possible values are `'left'` or `'right'`. See: Side Bar
openToolPanel TypeFunction	Opens a particular tool panel. Provide the ID of the tool panel to open. See: Tool Panel
closeToolPanel TypeFunction	Closes the currently open tool panel (if any). See: Tool Panel
getOpenedToolPanel TypeFunction	Returns the ID of the currently shown tool panel if any, otherwise `null`. See: Tool Panel
isToolPanelShowing TypeFunction	Returns `true` if the tool panel is showing, otherwise `false`. See: Tool Panel
refreshToolPanel TypeFunction	Force refresh all tool panels by calling their `refresh` method. See: Tool Panel
getToolPanelInstance TypeFunction	Gets the tool panel instance corresponding to the supplied `id`. See: Tool Panel Expand / Collapse Column Groups
getStatusPanel TypeFunction	Gets the status panel instance corresponding to the supplied `id`. See: Accessing Status Bar Panel Instances

Clipboard

See Clipboard for more information.

cutToClipboard TypeFunction	Cuts data to clipboard by following the same rules as pressing Ctrl+X.
copyToClipboard TypeFunction	Copies data to clipboard by following the same rules as pressing Ctrl+C.
copySelectedRangeToClipboard TypeFunction	Copies the selected ranges to the clipboard. See: Copying via the API
copySelectedRangeDown TypeFunction	Copies the selected range down, similar to `^ Ctrl`+`D` in Excel.
copySelectedRowsToClipboard TypeFunction	Copies the selected rows to the clipboard. See: Copying via the API
pasteFromClipboard TypeFunction	Pastes the data from the Clipboard into the focused cell of the grid. If no grid cell is focused, calling this method has no effect.

Column Definitions

See Updating Column Definitions for more information.

getColumnDefs TypeFunction	Returns the current column definitions. See: Column Definition Retrieval
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.

Column 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 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.

Column 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.

Column 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.

Column 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	Sets columns to adjust in size to fit the grid horizontally. Can provide params or a fixed pixel width to control how the columns are resized. 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. See: Auto-Size Columns to Fit Grid
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. See: Auto-Size Columns to Fit Cell Contents
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. See: Auto-Size Columns to Fit Cell Contents
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. See: Auto-Size Columns to Fit Cell Contents

Column State

See Column State

getColumnState TypeFunction	Gets the state of the columns. Typically used when saving column state. See: Save and Apply State
applyColumnState TypeFunction	Applies the state of the columns from a previous state. Returns `false` if one or more columns could not be found. See: Save and Apply State
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. See: Column Group State
setColumnGroupState TypeFunction	Sets the state of the column group state from a previous state. See: Column Group State
resetColumnGroupState TypeFunction	Sets the state back to match the originally provided column definitions.

Editing

See Cell Editing for more information.

startEditingCell TypeFunction	Start editing the provided cell. If another cell is editing, the editing will be stopped in that other cell. See: Editing API
stopEditing TypeFunction	If a cell is editing, it stops the editing. Pass `true` if you want to cancel the editing (i.e. don't accept changes). See: Editing API
getEditingCells TypeFunction	If the grid is editing, returns back details of the editing cell(s). See: Editing API
getCellEditorInstances TypeFunction	Returns the list of active cell editor instances. Optionally provide parameters to restrict to certain columns / row nodes. See: Cell Editor Instances

Events

addEventListener TypeFunction	Add an event listener for the specified `eventType`. Works similar to `addEventListener` for a browser DOM element. Listeners will be automatically removed when the grid is destroyed.
addGlobalListener TypeFunction	Add an event listener for all event types coming from the grid. Listeners will be automatically removed when the grid is destroyed.
removeEventListener TypeFunction	Remove an event listener.
removeGlobalListener TypeFunction	Remove a global event listener.
addRenderedRowListener TypeFunction	Registers a callback to a virtual row. A virtual row is a row that is visually rendered on the screen (rows that are not visible because of the scroll position are not rendered). Unlike normal events, you do not need to unregister rendered row listeners. When the rendered row is removed from the grid, all associated rendered row listeners will also be removed. listen for this event if your `cellRenderer` needs to do cleanup when the row no longer exists. See: Row Events

Export

See Export for more information.

exportDataAsCsv TypeFunction	Downloads a CSV export of the grid's data. See: CSV Export
getDataAsCsv TypeFunction	Similar to `exportDataAsCsv`, except returns the result as a string rather than download it. See: CSV Export
exportDataAsExcel TypeFunction	Downloads an Excel export of the grid's data. See: Enabling Excel Export
getDataAsExcel TypeFunction	Similar to `exportDataAsExcel`, except instead of downloading a file, it will return a Blob to be processed by the user.
getSheetDataForExcel TypeFunction	This is method to be used to get the grid's data as a sheet, that will later be exported either by `getMultipleSheetsAsExcel()` or `exportMultipleSheetsAsExcel()`. See: Excel Export - Multiple Sheets
exportMultipleSheetsAsExcel TypeFunction	Downloads an Excel export of multiple sheets in one file. See: Excel Export - Multiple Sheets
getMultipleSheetsAsExcel TypeFunction	Similar to `exportMultipleSheetsAsExcel`, except instead of downloading a file, it will return a Blob to be processed by the user. See: Excel Export - Multiple Sheets

Filtering

See Filtering for more information.

getQuickFilter TypeFunction	Get the current Quick Filter text from the grid, or `undefined` if none is set. See: Checking the Quick Filter
resetQuickFilter TypeFunction	Reset the Quick Filter cache text on every rowNode. See: Reset Cache Text
isQuickFilterPresent TypeFunction	Returns `true` if the Quick Filter is set, otherwise `false`. See: Checking the Quick Filter
isColumnFilterPresent TypeFunction	Returns `true` if any column filter is set, otherwise `false`.
isAnyFilterPresent TypeFunction	Returns `true` if any filter is set. This includes quick filter, column filter, external filter or advanced filter.
getFilterInstance TypeFunction	Returns the filter component instance for a column. `key` can be a string field name or a ColDef object (matches on object reference, useful if field names are not unique). If your filter is created asynchronously, `getFilterInstance` will return `null` so you will need to use the `callback` to access the filter instance instead. See: Accessing Individual Filter Component Instances
getFilterModel TypeFunction	Gets the current state of all the column filters. Used for saving filter state. See: Get / Set All Filter Models
setFilterModel TypeFunction	Sets the state of all the column filters. Provide it with what you get from `getFilterModel()` to restore filter state. If inferring cell data types, and row data is provided asynchronously and is yet to be set, the filter model will be applied asynchronously after row data is added. To always perform this synchronously, set `cellDataType = false` on the default column definition, or provide cell data types for every column. See: Get / Set All Filter Models
onFilterChanged TypeFunction	Informs the grid that a filter has changed. This is typically called after a filter change through one of the filter APIs. See: Re-running Grid Filtering
destroyFilter TypeFunction	Destroys a filter. Useful to force a particular filter to be created from scratch again.
getAdvancedFilterModel TypeFunction	Get the state of the Advanced Filter. Used for saving Advanced Filter state See: Advanced Filter
setAdvancedFilterModel TypeFunction	Set the state of the Advanced Filter. Used for restoring Advanced Filter state See: Advanced Filter
showAdvancedFilterBuilder TypeFunction	Open the Advanced Filter Builder dialog (if enabled). See: Advanced Filter

Grid Options

getGridOption TypeFunction	Returns the grid option value for a provided key. See: GridOptions
setGridOption TypeFunction	Updates a single `Managed` gridOption to the new value provided. If updating multiple options, it is recommended to instead use `api.updateGridOptions()` which batches update logic. See: GridOptions
updateGridOptions TypeFunction	Updates the provided subset of `Managed` gridOptions with the provided values. See: GridOptions

Integrated Charts

See Integrated Charts for more information.

createRangeChart TypeFunction	Used to programmatically create charts from a range. See: Range Chart API
createPivotChart TypeFunction	Used to programmatically create pivot charts from a grid. See: Pivot Chart API
createCrossFilterChart TypeFunction	Used to programmatically create cross filter charts from a range. See: Cross-filter API
updateChart TypeFunction	Used to programmatically update a chart. See: Event Driven Chart Updates
getChartRef TypeFunction	Returns the `ChartRef` using the supplied `chartId`.
getChartModels TypeFunction	Returns a list of models with information about the charts that are currently rendered from the grid. See: Saving / Restoring Charts
restoreChart TypeFunction	Restores a chart using the `ChartModel` that was previously obtained from `getChartModels()`. See: Saving / Restoring Charts
getChartImageDataURL TypeFunction	Returns a base64-encoded image data URL for the referenced chartId. See: Downloading Chart Image
downloadChart TypeFunction	Starts a browser-based image download for the referenced chartId. See: Downloading Chart Image
openChartToolPanel TypeFunction	Open the Chart Tool Panel. See: Open Chart Tool Panel
closeChartToolPanel TypeFunction	Close the Chart Tool Panel. See: Close Chart Tool Panel

See Keyboard Navigation for more information.

getFocusedCell TypeFunction	Returns the focused cell (or the last focused cell if the grid lost focus).
setFocusedCell TypeFunction	Sets the focus to the specified cell. `rowPinned` can be either 'top', 'bottom' or null (for not pinned).
clearFocusedCell TypeFunction	Clears the focused cell.
tabToNextCell TypeFunction	Navigates the grid focus to the next cell, as if tabbing. See: Custom Navigation
tabToPreviousCell TypeFunction	Navigates the grid focus to the previous cell, as if shift-tabbing. See: Custom Navigation

Master Detail

See Master Detail for more information.

getDetailGridInfo TypeFunction	Returns the `DetailGridInfo` corresponding to the supplied `detailGridId`. See: Accessing Detail Grids
forEachDetailGridInfo TypeFunction	Iterates through each `DetailGridInfo` in the grid and calls the supplied callback on each. See: Accessing Detail Grids
addDetailGridInfo TypeFunction	Register a detail grid with the master grid when it is created. See: Register Detail Grid
removeDetailGridInfo TypeFunction	Unregister a detail grid from the master grid when it is destroyed. See: Register Detail Grid

Miscellaneous

getValue TypeFunction	Gets the value for a column for a particular `rowNode` (row). This is useful if you want the raw value of a cell e.g. if implementing your own CSV export.
destroy TypeFunction	Will destroy the grid and release resources. If you are using a framework you do not need to call this, as the grid links in with the framework lifecycle. However if you are using Web Components or native JavaScript, you do need to call this, to avoid a memory leak in your application.
isDestroyed TypeFunction	Returns `true` if the grid has been destroyed.
setGridAriaProperty TypeFunction	Sets an ARIA property in the grid panel (element with `role="grid"`), and removes an ARIA property when the value is null. Example: `api.setGridAriaProperty('label', 'my grid')` will set `aria-label="my grid"`. `api.setGridAriaProperty('label', null)` will remove the `aria-label` attribute from the grid element. See: ARIA Attributes
getGridId TypeFunction	Returns the `gridId` for the current grid as specified via the gridOptions property `gridId` or the auto assigned grid id if none was provided.
isAnimationFrameQueueEmpty TypeFunction	Returns `true` when there are no more animation frames left to process.

Overlays

See Overlays for more information.

showLoadingOverlay TypeFunction	Show the 'loading' overlay.
showNoRowsOverlay TypeFunction	Show the 'no rows' overlay.
hideOverlay TypeFunction	Hides the overlay if showing.

Pagination

See Row Pagination for more information.

paginationIsLastPageFound TypeFunction	Returns `true` when the last page is known; this will always be the case if you are using the Client-Side Row Model for pagination. Returns `false` when the last page is not known; this only happens when using Infinite Row Model.
paginationGetPageSize TypeFunction	Returns how many rows are being shown per page.
paginationGetCurrentPage TypeFunction	Returns the 0-based index of the page which is showing.
paginationGetTotalPages TypeFunction	Returns the total number of pages. Returns `null` if `paginationIsLastPageFound() === false`.
paginationGetRowCount TypeFunction	The total number of rows. Returns `null` if `paginationIsLastPageFound() === false`.
paginationGoToPage TypeFunction	Goes to the specified page. If the page requested doesn't exist, it will go to the last page.
paginationGoToNextPage TypeFunction	Navigates to the next page.
paginationGoToPreviousPage TypeFunction	Navigates to the previous page.
paginationGoToFirstPage TypeFunction	Navigates to the first page.
paginationGoToLastPage TypeFunction	Navigates to the last page.

Pivot and Aggregation

See Pivot and Aggregation for more information

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.
addAggFunc TypeFunction	Add an aggregation function with the specified key. See: Registering Custom Functions
addAggFuncs TypeFunction	Add aggregations function with the specified keys.
clearAggFuncs TypeFunction	Clears all aggregation functions (including those provided by the grid).

Pivoting

See Pivoting

isPivotMode TypeFunction	Get 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. See: Looking up Pivot Result Columns
setPivotResultColumns TypeFunction	Set the pivot result columns. See: Creating Pivot Result Columns
getPivotResultColumns TypeFunction	Returns the grid's pivot result columns. See: Columns vs Pivot Result Columns

Refresh

See View Refresh for more information.

refreshCells TypeFunction	Performs change detection on all cells, refreshing cells where required. See: Refresh Cells
redrawRows TypeFunction	Remove row(s) from the DOM and recreate them again from scratch. See: Redraw Rows
refreshHeader TypeFunction	Redraws the header. Useful if a column name changes, or something else that changes how the column header is displayed.
flashCells TypeFunction	Flash rows, columns or individual cells. See: Flashing Cells

Rendering

getRenderedNodes TypeFunction	Retrieve rendered nodes. Due to virtualisation this will contain only the current visible rows and those in the buffer.
getCellRendererInstances TypeFunction	Returns the list of active cell renderer instances. See: Cell Renderer Instances
getSizesForCurrentTheme TypeFunction	Gets the sizes that various UI elements will be rendered at with the current theme. If you override the row or header height using `gridOptions`, the override value you provided will be returned.
resetRowHeights TypeFunction	Tells the grid to recalculate the row heights. See: Changing Row Height
onRowHeightChanged TypeFunction	Tells the grid a row height has changed. To be used after calling `rowNode.setRowHeight(newHeight)`. See: Changing Row Height

Row Displayed

getDisplayedRowAtIndex TypeFunction	Returns the displayed `RowNode` at the given `index`. See: Rendering API
getDisplayedRowCount TypeFunction	Returns the total number of displayed rows. See: Rendering API
getFirstDisplayedRow TypeFunction	Get the index of the first displayed row due to scrolling (includes invisible rendered rows in the buffer). See: Rendering API
getLastDisplayedRow TypeFunction	Get the index of the last displayed row due to scrolling (includes invisible rendered rows in the buffer). See: Rendering API

Row Drag and Drop

See Row Dragging for more information.

addRowDropZone TypeFunction	Adds a drop zone outside of the grid where rows can be dropped. See: Row Dragging to an External DropZone
removeRowDropZone TypeFunction	Removes an external drop zone added by `addRowDropZone`. See: Row Dragging to an External DropZone
getRowDropZoneParams TypeFunction	Returns the `RowDropZoneParams` to be used by another grid's `addRowDropZone` method. See: Row Dragging Between Grids

Row Grouping

See Row Grouping for more information.

expandAll TypeFunction	Expand all groups. See: Expand / Collapse Groups via API
collapseAll TypeFunction	Collapse all groups. See: Expand / Collapse Groups via API
setRowNodeExpanded TypeFunction	Expand or collapse a specific row node, optionally expanding/collapsing all of its parent nodes. See: Expand / Collapse Groups via API
onGroupExpandedOrCollapsed TypeFunction	Informs the grid that row group expanded state has changed and it needs to rerender the group nodes. Typically called after updating the row node expanded state explicitly, i.e `rowNode.expanded = false`, across multiple groups and you want to update the grid view in a single rerender instead of on every group change.
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.

Row Nodes

getRowNode TypeFunction	Returns the row node with the given ID. The row node ID is the one you provide from the callback `getRowId(params)`, otherwise the ID is a number (cast as string) auto-generated by the grid when the row data is set. See: Application Assigned IDs
forEachNode TypeFunction	Iterates through each node (row) in the grid and calls the callback for each node. This works similar to the `forEach` method on a JavaScript array. This is called for every node, ignoring any filtering or sorting applied within the grid. If using the Infinite Row Model, then this gets called for each page loaded in the page cache. See: Iterating Rows
forEachNodeAfterFilter TypeFunction	Similar to `forEachNode`, except skips any filtered out data. See: Iterating Rows
forEachNodeAfterFilterAndSort TypeFunction	Similar to `forEachNodeAfterFilter`, except the callbacks are called in the order the rows are displayed in the grid. See: Iterating Rows
forEachLeafNode TypeFunction	Similar to `forEachNode`, except lists all the leaf nodes. This effectively goes through all the data that you provided to the grid before the grid performed any grouping. If using tree data, goes through all the nodes for the data you provided, including nodes that have children, but excluding groups the grid created where gaps were missing in the hierarchy. See: Iterating Rows

Row Pinning

See Row Pinning for more information.

getPinnedTopRowCount TypeFunction	Gets the number of top pinned rows.
getPinnedBottomRowCount TypeFunction	Gets the number of bottom pinned rows.
getPinnedTopRow TypeFunction	Gets the top pinned row with the specified index.
getPinnedBottomRow TypeFunction	Gets the bottom pinned row with the specified index.

RowModel

See Row Model for more information.

TypeFunction

Returns the row model inside the table. From here you can see the original rows, rows after filter has been applied, rows after aggregation has been applied, and the final set of 'to be displayed' rows.

RowModel: Client-Side

See Client-Side Row Model for more information.

applyTransaction TypeFunction	Update row data. Pass a transaction object with lists for `add`, `remove` and `update`. See: Transaction Updates
applyTransactionAsync TypeFunction	Same as `applyTransaction` except executes asynchronously for efficiency. See: High Frequency Updates
flushAsyncTransactions TypeFunction	Executes any remaining asynchronous grid transactions, if any are waiting to be executed. See: Flush Async Transactions
refreshClientSideRowModel TypeFunction	Refresh the Client-Side Row Model, executing the grouping, filtering and sorting again. Optionally provide the step you wish the refresh to apply from. Defaults to `everything`. See: Sort / Filter / Group Refresh

RowModel: Infinite

See Infinite Row Model for more information.

refreshInfiniteCache TypeFunction	Marks all the currently loaded blocks in the cache for reload. If you have 10 blocks in the cache, all 10 will be marked for reload. The old data will continue to be displayed until the new data is loaded.
purgeInfiniteCache TypeFunction	Purges the cache. The grid is then told to refresh. Only the blocks required to display the current data on screen are fetched (typically no more than 2). The grid will display nothing while the new blocks are loaded. Use this to immediately remove the old data from the user.
getInfiniteRowCount TypeFunction	The row count defines how many rows the grid allows scrolling to.
isLastRowIndexKnown TypeFunction	Returns `true` if grid allows for scrolling past the last row to load more rows, thus providing infinite scroll.
setRowCount TypeFunction	Sets the `rowCount` and `maxRowFound` properties. The second parameter, `maxRowFound`, is optional and if left out, only `rowCount` is set. Set `rowCount` to adjust the height of the vertical scroll. Set `maxRowFound` to enable / disable searching for more rows. Use this method if you add or remove rows into the dataset and need to reset the number of rows or instruct the grid that the entire row count is no longer known.
getCacheBlockState TypeFunction	Returns an object representing the state of the cache. This is useful for debugging and understanding how the cache is working.

RowModel: Server-Side

See Server-Side Row Model for more information.

setRowCount TypeFunction	Sets the `rowCount` and `maxRowFound` properties. The second parameter, `maxRowFound`, is optional and if left out, only `rowCount` is set. Set `rowCount` to adjust the height of the vertical scroll. Set `maxRowFound` to enable / disable searching for more rows. Use this method if you add or remove rows into the dataset and need to reset the number of rows or instruct the grid that the entire row count is no longer known.
refreshServerSide TypeFunction	Refresh a server-side store level. If you pass no parameters, then the top level store is refreshed. To refresh a child level, pass in the string of keys to get to the desired level. Once the store refresh is complete, the storeRefreshed event is fired. See: Purging Groups
getServerSideGroupLevelState TypeFunction	Returns info on all server side group levels.
retryServerSideLoads TypeFunction	Gets all failed server side loads to retry. See: Retry Loads
applyServerSideTransaction TypeFunction	Apply transactions to the server side row model. See: Transactions
applyServerSideTransactionAsync TypeFunction	Batch apply transactions to the server side row model. See: Transactions
applyServerSideRowData TypeFunction	Applies row data to a server side store. New rows will overwrite rows at the same index in the same way as if provided by a datasource success callback. startRow is only applicable when `suppressServerSideInfiniteScroll=true` See: Providing Additional Data
getServerSideSelectionState TypeFunction	Returns an object containing rules matching the selected rows in the SSRM. If `groupSelectsChildren=false` the returned object will be flat, and will conform to IServerSideSelectionState. If `groupSelectsChildren=true` the returned object will be hierarchical, and will conform to IServerSideGroupSelectionState. See: Selection
setServerSideSelectionState TypeFunction	Set the rules matching the selected rows in the SSRM. If `groupSelectsChildren=false` the param will be flat, and should conform to IServerSideSelectionState. If `groupSelectsChildren=true` the param will be hierarchical, and should conform to IServerSideGroupSelectionState. See: Selection
getCacheBlockState TypeFunction	Returns an object representing the state of the cache. This is useful for debugging and understanding how the cache is working. See: Cache Block State

Scrolling

See Scrolling for more information.

ensureIndexVisible TypeFunction	Vertically scrolls the grid until the provided row index is inside the visible viewport. If a position is provided, the grid will attempt to scroll until the row is at the given position within the viewport. This will have no effect before the firstDataRendered event has fired. See: firstDataRendered event
ensureNodeVisible TypeFunction	Vertically scrolls the grid until the provided row (or a row matching the provided comparator) is inside the visible viewport. If a position is provided, the grid will attempt to scroll until the row is at the given position within the viewport. This will have no effect before the firstDataRendered event has fired. See: firstDataRendered event
ensureColumnVisible TypeFunction	Ensures the column is visible by scrolling the table if needed. This will have no effect before the firstDataRendered event has fired. See: firstDataRendered event
getHorizontalPixelRange TypeFunction	Returns an object with two properties: `left`: The left pixel position of the current scroll in the grid `right`: The right pixel position of the current scroll in the grid
getVerticalPixelRange TypeFunction	Returns an object with two properties: `top`: The top pixel position of the current scroll in the grid `bottom`: The bottom pixel position of the current scroll in the grid

Selection

See Selection Overview for more information.

selectAll TypeFunction	Select all rows, regardless of filtering and rows that are not visible due to grouping being enabled and their groups not expanded.
deselectAll TypeFunction	Clear all row selections, regardless of filtering.
selectAllFiltered TypeFunction	Select all filtered rows.
deselectAllFiltered TypeFunction	Clear all filtered selections.
selectAllOnCurrentPage TypeFunction	Select all rows on the current page.
deselectAllOnCurrentPage TypeFunction	Clear all filtered on the current page.
getSelectedNodes TypeFunction	Returns an unsorted list of selected nodes. Getting the underlying node (rather than the data) is useful when working with tree / aggregated data, as the node can be traversed.
getSelectedRows TypeFunction	Returns an unsorted list of selected rows (i.e. row data that you provided).
setNodesSelected TypeFunction	Set all of the provided nodes selection state to the provided value.
getBestCostNodeSelection TypeFunction	Returns a list of all selected nodes at 'best cost', a feature to be used with groups / trees. If a group has all its children selected, then the group appears in the result, but not the children. Designed for use with `'children'` as the group selection type, where groups don't actually appear in the selection normally.
getCellRanges TypeFunction	Returns the list of selected cell ranges. See: getCellRanges
addCellRange TypeFunction	Adds the provided cell range to the selected ranges. See: addCellRange
clearRangeSelection TypeFunction	Clears the selected ranges. See: clearRangeSelection

Sorting

See Row Sorting for more information.

TypeFunction

Gets the grid to act as if the sort was changed. Useful if you update some values and want to get the grid to reorder them according to the new values.

Undo / Redo

See Undo/Redo Edits for more information.

undoCellEditing TypeFunction	Reverts the last cell edit.
redoCellEditing TypeFunction	Re-applies the most recently undone cell edit.
getCurrentUndoSize TypeFunction	Returns current number of available cell edit undo operations.
getCurrentRedoSize TypeFunction	Returns current number of available cell edit redo operations.

Accessories

showColumnMenuAfterButtonClick

showColumnMenuAfterMouseClick

hidePopupMenu

getSideBar

setSideBarVisible

isSideBarVisible

setSideBarPosition

openToolPanel

closeToolPanel

getOpenedToolPanel

isToolPanelShowing

refreshToolPanel

getToolPanelInstance

getStatusPanel

Clipboard

cutToClipboard

copyToClipboard

copySelectedRangeToClipboard

copySelectedRangeDown

copySelectedRowsToClipboard

pasteFromClipboard

Column Definitions

getColumnDefs

getColumn

getColumns

getAllGridColumns

Column Display

setColumnVisible

setColumnsVisible

getDisplayNameForColumn

getDisplayNameForColumnGroup

getDisplayedColAfter

getDisplayedColBefore

getAllDisplayedVirtualColumns

getAllDisplayedColumns

getDisplayedCenterColumns

getDisplayedLeftColumns

getDisplayedRightColumns

getAllDisplayedColumnGroups

getCenterDisplayedColumnGroups

getLeftDisplayedColumnGroups

getRightDisplayedColumnGroups

Column Groups

getColumnGroup

getProvidedColumnGroup

setColumnGroupOpened

Column Moving

moveColumn

moveColumns

moveColumnByIndex

Column Pinning

isPinning

isPinningLeft

isPinningRight

setColumnPinned

setColumnsPinned

Column Sizing

setColumnWidth

setColumnWidths

sizeColumnsToFit

autoSizeColumn

autoSizeColumns

autoSizeAllColumns

Column State

getColumnState

applyColumnState

resetColumnState

getColumnGroupState

setColumnGroupState

resetColumnGroupState

Editing

startEditingCell

stopEditing

getEditingCells

getCellEditorInstances

Events

addEventListener

addGlobalListener

removeEventListener