React Data GridGrid API
All of these grid methods are available through the api
property of GridOptions
.
Accessories
set | DOM element to use as the popup parent for grid popups (context menu, column menu etc). See: Popup Parent |
show | Shows the column menu after and positions it relative to the provided button element. Use in conjunction with your own header template. |
show | Shows the column menu after and positions it relative to the mouse event. Use in conjunction with your own header template. |
hide | Hides any visible context menu or column menu. |
set | Resets the side bar to the provided configuration. The parameter is the same as the sideBar grid property. The side bar is re-created from scratch with the new config. See: Side Bar |
get | Returns the current side bar configuration. If a shortcut was used, returns the detailed long form. |
set | Show/hide the entire side bar, including any visible panel and the tab buttons. |
is | Returns true if the side bar is visible. |
set | Sets the side bar position relative to the grid. Possible values are 'left' or 'right' . |
open | Opens a particular tool panel. Provide the ID of the tool panel to open. See: Tool Panel |
close | Closes the currently open tool panel (if any). |
get | Returns the ID of the currently shown tool panel if any, otherwise null . |
is | Returns true if the tool panel is showing, otherwise false . |
refresh | Force refresh all tool panels by calling their refresh method. |
get | Gets the tool panel instance corresponding to the supplied id . |
get | Gets the status panel instance corresponding to the supplied id . |
Clipboard
See Clipboard for more information.
Column Definitions
See Updating Column Definitions for more information.
get | Returns the current column definitions.
|
set | Call to set new column definitions. The grid will redraw all the column headers, and then redraw all of the rows.
|
set | Call to set new auto group column definition. The grid will recreate any auto-group columns if present. |
set | Call to set new Default Column Definition. |
size | Sets columns to adjust in size to fit the grid horizontally. 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: Size Columns to Fit |
Column Headers
See Column Headers for more information.
Editing
See Cell Editing for more information.
start | Start editing the provided cell. If another cell is editing, the editing will be stopped in that other cell. See: Editing API |
stop | 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 |
get | If the grid is editing, returns back details of the editing cell(s). See: Editing API |
get | Returns the list of active cell editor instances. Optionally provide parameters to restrict to certain columns / row nodes. |
Events
Export
See Export for more information.
export | Downloads a CSV export of the grid's data. |
get | Similar to exportDataAsCsv , except returns the result as a string rather than download it. |
export | Downloads an Excel export of the grid's data. |
get | Similar to exportDataAsExcel , except instead of downloading a file, it will return a Blob to be processed by the user. |
get | 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() . |
export | Downloads an Excel export of multiple sheets in one file. |
get | Similar to exportMultipleSheetsAsExcel , except instead of downloading a file, it will return a Blob to be processed by the user. |
Filtering
See Filtering for more information.
get | Get the current Quick Filter text from the grid, or undefined if none is set. |
set | Pass a Quick Filter text into the grid for filtering. |
reset | Reset the Quick Filter cache text on every rowNode. See: Reset Cache Text |
is | Returns true if the Quick Filter is set, otherwise false . |
set | Updates the includeHiddenColumnsInQuickFilter grid option. By default hidden columns are excluded from the Quick Filter. Set to true to include them.
|
set | Updates the quickFilterParser grid option, which changes how the Quick Filter splits the Quick Filter text into search terms.
See: Quick Filter Parser |
set | Updates the quickFilterMatcher grid option, which changes the matching logic for whether a row passes the Quick Filter.
See: Quick Filter Matcher |
is | Returns true if any column filter is set, otherwise false . |
is | Returns true if any filter is set. This includes quick filter, column filter, external filter or advanced filter. |
get | 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.
|
get | Gets the current state of all the column filters. Used for saving filter state. |
set | 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.
|
on | Informs the grid that a filter has changed. This is typically called after a filter change through one of the filter APIs.
source The source of the filter change event. If not specified defaults to 'api' .
|
destroy | Destroys a filter. Useful to force a particular filter to be created from scratch again. |
get | Get the state of the Advanced Filter. Used for saving Advanced Filter state See: Advanced Filter |
set | Set the state of the Advanced Filter. Used for restoring Advanced Filter state See: Advanced Filter |
set | Enable/disable the Advanced Filter See: Advanced Filter |
set | Updates the includeHiddenColumnsInAdvancedFilter grid option. By default hidden columns are excluded from the Advanced Filter. Set to true to include them.
See: Advanced Filter |
set | DOM element to use as the parent for the Advanced Filter, to allow it to appear outside of the grid. Set to null to appear inside the grid.
See: Advanced Filter |
set | Updates the Advanced Filter Builder parameters. See: Advanced Filter |
show | Open the Advanced Filter Builder dialog (if enabled). See: Advanced Filter |
Integrated Charts
See Integrated Charts for more information.
create | Used to programmatically create charts from a range. See: Range Chart API |
create | Used to programmatically create pivot charts from a grid. See: Pivot Chart API |
create | Used to programmatically create cross filter charts from a range. See: Cross-filter API |
update | Used to programmatically update a chart. |
get | Returns the ChartRef using the supplied chartId . |
get | Returns a list of models with information about the charts that are currently rendered from the grid. |
restore | Restores a chart using the ChartModel that was previously obtained from getChartModels() . |
get | Returns a base64-encoded image data URL for the referenced chartId. |
download | Starts a browser-based image download for the referenced chartId. |
open | Open the Chart Tool Panel. |
close | Close the Chart Tool Panel. |
Keyboard Navigation
See Keyboard Navigation for more information.
Master Detail
See Master Detail for more information.
get | Returns the DetailGridInfo corresponding to the supplied detailGridId . |
for | Iterates through each DetailGridInfo in the grid and calls the supplied callback on each. |
add | Register a detail grid with the master grid when it is created. See: Register Detail Grid |
remove | Unregister a detail grid from the master grid when it is destroyed. See: Register Detail Grid |
Miscellaneous
get | 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.
|
set | Switch between layout options: normal , autoHeight , print . Defaults to normal if no domLayout provided.
See: DOM Layout |
destroyTypeFunction | 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. |
set | 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. |
get | Returns the gridId for the current grid as specified via the gridOptions property gridId or the auto assigned grid id if none was provided. |
is | Returns true when there are no more animation frames left to process. |
Overlays
See Overlays for more information.
show | Show the 'loading' overlay. |
show | Show the 'no rows' overlay. |
hide | Hides the overlay if showing. |
Pagination
See Row Pagination for more information.
set | Set whether the grid paginates the data or not. true to enable pagination false to disable pagination |
pagination | 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. |
pagination | Returns how many rows are being shown per page. |
pagination | Sets the paginationPageSize , then re-paginates the grid so the changes are applied immediately. |
pagination | Returns the 0-based index of the page which is showing. |
pagination | Returns the total number of pages. Returns null if paginationIsLastPageFound() === false . |
pagination | The total number of rows. Returns null if paginationIsLastPageFound() === false . |
pagination | Goes to the specified page. If the page requested doesn't exist, it will go to the last page. |
pagination | Navigates to the next page. |
pagination | Navigates to the previous page. |
pagination | Navigates to the first page. |
pagination | Navigates to the last page. |
Pivot and Aggregation
See Pivot and Aggregation for more information
Refresh
See View Refresh for more information.
refresh | Performs change detection on all cells, refreshing cells where required. See: Refresh Cells |
redraw | Remove row(s) from the DOM and recreate them again from scratch. See: Redraw Rows |
refresh | Redraws the header. Useful if a column name changes, or something else that changes how the column header is displayed. |
flash | Flash rows, columns or individual cells. See: Flashing Cells |
Rendering
Row Displayed
Row Drag and Drop
See Row Dragging for more information.
set | Sets the suppressRowDrag property. See: Suppress Row Drag |
set | Sets the suppressMoveWhenRowDragging property. |
add | Adds a drop zone outside of the grid where rows can be dropped. |
remove | Removes an external drop zone added by addRowDropZone . |
get | Returns the RowDropZoneParams to be used by another grid's addRowDropZone method. |
Row Grouping
See Row Grouping for more information.
expand | Expand all groups. |
collapse | Collapse all groups. |
set | Expand or collapse a specific row node, optionally expanding/collapsing all of its parent nodes. |
on | 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.
|
set | Sets the treeData property. See: Tree Data |
set | Sets the groupIncludeFooter property
|
set | Sets the groupIncludeTotalFooter property
|
Row Nodes
get | 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.
|
for | 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. |
for | Similar to forEachNode , except skips any filtered out data. |
for | Similar to forEachNodeAfterFilter , except the callbacks are called in the order the rows are displayed in the grid. |
for | 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.
|
Row Pinning
See Row Pinning for more information.
RowModel
See Row Model for more information.
RowModel: Client-Side
See Client-Side Row Model for more information.
RowModel: Infinite
See Infinite Row Model for more information.
RowModel: Server-Side
See Server-Side Row Model for more information.
set | Set new datasource for Server-Side Row Model. |
set | Updates the cacheBlockSize when requesting data from the server if suppressServerSideInfiniteScroll is not enabled. Note this purges all the cached data and reloads all the rows of the grid. |
set | 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.
|
refresh | 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 |
get | Returns info on all server side group levels. |
retry | Gets all failed server side loads to retry. See: Retry Loads |
apply | Apply transactions to the server side row model. See: Transactions |
apply | Batch apply transactions to the server side row model. See: Transactions |
apply | 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
|
get | 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 |
set | 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 |
get | 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 |
RowModel: Viewport
See Viewport Row Model for more information.
set | Set new datasource for Viewport Row Model. |
Scrolling
See Scrolling for more information.
Selection
See Selection Overview for more information.
select | Select all rows, regardless of filtering and rows that are not visible due to grouping being enabled and their groups not expanded.
source Source property that will appear in the selectionChanged event, defaults to 'apiSelectAll'
|
deselect | Clear all row selections, regardless of filtering.
source Source property that will appear in the selectionChanged event, defaults to 'apiSelectAll'
|
select | Select all filtered rows.
source Source property that will appear in the selectionChanged event, defaults to 'apiSelectAllFiltered'
|
deselect | Clear all filtered selections.
source Source property that will appear in the selectionChanged event, defaults to 'apiSelectAllFiltered'
|
select | Select all rows on the current page.
source Source property that will appear in the selectionChanged event, defaults to 'apiSelectAllCurrentPage'
|
deselect | Clear all filtered on the current page.
source Source property that will appear in the selectionChanged event, defaults to 'apiSelectAllCurrentPage'
|
get | 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.
|
get | Returns an unsorted list of selected rows (i.e. row data that you provided). |
set | Set all of the provided nodes selection state to the provided value.
|
get | 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.
|
get | Returns the list of selected cell ranges. |
add | Adds the provided cell range to the selected ranges. |
clear | Clears the selected ranges. |
set | Sets the suppressRowClickSelection property. |
set | Sets the enableCellTextSelection property. See: Cell Text Selection |
set | Sets the preferred direction for the selection fill handle. See: Fill Handle |
Sorting
See Row Sorting for more information.
on | 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.
|
set | Sets the deltaSort property See: Delta sorting |
Undo / Redo
See Undo/Redo Edits for more information.