---
title: "Grid API Reference"
framework: angular
version: "36.1.0"
---

# Grid API Reference

To access the api see: [Grid API](https://www.ag-grid.com/angular-data-grid/grid-interface/#grid-api).

### AI Toolkit

See [AI Toolkit](https://www.ag-grid.com/angular-data-grid/ai-toolkit/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getStructuredSchema` | `Function` |  |  | Returns the structured schema of the grid, which includes information about columns, data types, and relationships. This schema can be passed to AI services to ensure the response is of the correct format. See [AI Toolkit](https://www.ag-grid.com/angular-data-grid/ai-toolkit/) for more information. Module: [`AiToolkitModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Accessories

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `showColumnChooser` | `Function` |  |  | Show the column chooser. See [Column Menu API](https://www.ag-grid.com/angular-data-grid/column-menu/#column-menu-api--events) for more information. Module: [`ColumnMenuModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `showColumnFilter` | `Function` |  |  | Show the filter for the provided column. See [Column Menu API](https://www.ag-grid.com/angular-data-grid/column-menu/#column-menu-api--events) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `hideColumnFilter` | `Function` |  |  | Hide the filter popup if it is open. See [Column Menu API](https://www.ag-grid.com/angular-data-grid/column-menu/#column-menu-api--events) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `showColumnMenu` | `Function` |  |  | Show the column menu for the provided column. See [Column Menu API](https://www.ag-grid.com/angular-data-grid/column-menu/#column-menu-api--events) for more information. |
| `showContextMenu` | `Function` |  |  | Displays the AG Grid context menu Module: [`ContextMenuModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `hidePopupMenu` | `Function` |  |  | Hides any visible [Context Menu](https://www.ag-grid.com/angular-data-grid/context-menu/) or [Column Menu](https://www.ag-grid.com/angular-data-grid/column-menu/). |
| `hideColumnChooser` | `Function` |  |  | Hide the column chooser if visible. See [Column Menu API](https://www.ag-grid.com/angular-data-grid/column-menu/#column-menu-api--events) for more information. Module: [`ColumnMenuModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getSideBar` | `Function` |  |  | Returns the current side bar configuration. If a shortcut was used, returns the detailed long form. See [Side Bar API](https://www.ag-grid.com/angular-data-grid/side-bar/#side-bar-api) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setSideBarVisible` | `Function` |  |  | Show/hide the entire side bar, including any visible panel and the tab buttons. See [Side Bar](https://www.ag-grid.com/angular-data-grid/side-bar/) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isSideBarVisible` | `Function` |  |  | Returns `true` if the side bar is visible. See [Side Bar](https://www.ag-grid.com/angular-data-grid/side-bar/) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setSideBarPosition` | `Function` |  |  | Sets the side bar position relative to the grid. Possible values are `'left'` or `'right'`. See [Side Bar](https://www.ag-grid.com/angular-data-grid/side-bar/) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `openToolPanel` | `Function` |  |  | Opens a particular tool panel. Provide the ID of the tool panel to open. Optionally, provide a parent element to attach the tool panel to. See [Tool Panel](https://www.ag-grid.com/angular-data-grid/tool-panel/) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `closeToolPanel` | `Function` |  |  | Closes the currently open tool panel (if any). See [Tool Panel](https://www.ag-grid.com/angular-data-grid/tool-panel/) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getOpenedToolPanel` | `Function` |  |  | Returns the ID of the currently shown tool panel if any, otherwise `null`. See [Tool Panel](https://www.ag-grid.com/angular-data-grid/tool-panel/) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isToolPanelShowing` | `Function` |  |  | Returns `true` if the tool panel is showing, otherwise `false`. See [Tool Panel](https://www.ag-grid.com/angular-data-grid/tool-panel/) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `refreshToolPanel` | `Function` |  |  | Force refreshes all tool panels by calling their `refresh` method. See [Tool Panel](https://www.ag-grid.com/angular-data-grid/tool-panel/) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getToolPanelInstance` | `Function` |  |  | Gets the tool panel instance corresponding to the supplied `id`. See [Tool Panel Expand / Collapse Column Groups](https://www.ag-grid.com/angular-data-grid/tool-panel-columns/#expand--collapse-column-groups) for more information. Module: [`SideBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getToolbarItemInstance` | `Function` |  |  | Gets the toolbar item instance for the given `key`. Only toolbar items configured with a `key` can be accessed. See [Toolbar](https://www.ag-grid.com/angular-data-grid/toolbar/) for more information. Module: [`ToolbarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getStatusPanel` | `Function` |  |  | Gets the status panel instance corresponding to the supplied `id`. See [Accessing Status Bar Panel Instances](https://www.ag-grid.com/angular-data-grid/status-bar/) for more information. Module: [`StatusBarModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Clipboard

See [Clipboard](https://www.ag-grid.com/angular-data-grid/clipboard/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `cutToClipboard` | `Function` |  |  | Cuts data to clipboard by following the same rules as pressing Ctrl+X. Module: [`ClipboardModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `copyToClipboard` | `Function` |  |  | Copies data to clipboard by following the same rules as pressing Ctrl+C. Module: [`ClipboardModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `copySelectedRangeToClipboard` | `Function` |  |  | Copies the selected ranges to the clipboard. See [Copying via the API](https://www.ag-grid.com/angular-data-grid/clipboard/#copying-via-the-api) for more information. Module: [`ClipboardModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `copySelectedRangeDown` | `Function` |  |  | Copies the selected range down, similar to ^ Ctrl+D in Excel. Module: [`ClipboardModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `copySelectedRowsToClipboard` | `Function` |  |  | Copies the selected rows to the clipboard. See [Copying via the API](https://www.ag-grid.com/angular-data-grid/clipboard/#copying-via-the-api) for more information. Module: [`ClipboardModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `pasteFromClipboard` | `Function` |  |  | 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. Module: [`ClipboardModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Column Definitions

See [Updating Column Definitions](https://www.ag-grid.com/angular-data-grid/column-updating-definitions/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getColumnDefs` | `Function` |  |  | Returns the current column definitions. See [Column Definition Retrieval](https://www.ag-grid.com/angular-data-grid/column-updating-definitions/#column-definition-retrieval) for more information. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getColumn` | `Function` |  |  | Returns the column with the given `colKey`, which can either be the `colId` (a string) or the `colDef` (an object). Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getColumns` | `Function` |  |  | Returns all the columns, regardless of visible or not. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getAllGridColumns` | `Function` |  |  | 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. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Column Display

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `setColumnsVisible` | `Function` |  |  | Sets the visibility of columns. Key can be the column ID or `Column` object. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getDisplayNameForColumn` | `Function` |  |  | 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. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getDisplayedColAfter` | `Function` |  |  | 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. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getDisplayedColBefore` | `Function` |  |  | Same as `getVisibleColAfter` except gives column to the left. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getAllDisplayedVirtualColumns` | `Function` |  |  | 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. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getAllDisplayedColumns` | `Function` |  |  | 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. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getDisplayedCenterColumns` | `Function` |  |  | Same as `getAllDisplayedColumns` but just for the center portion of the grid. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getDisplayedLeftColumns` | `Function` |  |  | Same as `getAllDisplayedColumns` but just for the pinned left portion of the grid. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getDisplayedRightColumns` | `Function` |  |  | Same as `getAllDisplayedColumns` but just for the pinned right portion of the grid. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Column Groups

See [Column Groups](https://www.ag-grid.com/angular-data-grid/column-groups/)

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getColumnGroup` | `Function` |  |  | Returns the column group with the given name. See [Column Groups](https://www.ag-grid.com/angular-data-grid/column-groups/) for more information. |
| `getProvidedColumnGroup` | `Function` |  |  | Returns the provided column group with the given name. |
| `setColumnGroupOpened` | `Function` |  |  | Call this if you want to open or close a column group. |
| `getDisplayNameForColumnGroup` | `Function` |  |  | Returns the display name for a column group (when grouping columns). |
| `getAllDisplayedColumnGroups` | `Function` |  |  | 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` | `Function` |  |  | Same as `getAllDisplayedColumnGroups` but just for the center portion of the grid. |
| `getLeftDisplayedColumnGroups` | `Function` |  |  | Same as `getAllDisplayedColumnGroups` but just for the pinned left portion of the grid. |
| `getRightDisplayedColumnGroups` | `Function` |  |  | Same as `getAllDisplayedColumnGroups` but just for the pinned right portion of the grid. |

### Column Hover

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isColumnHovered` | `Function` |  |  | Returns true if the column is currently hovered. See [Column Hover](https://www.ag-grid.com/angular-data-grid/row-styles/#highlighting-rows-and-columns) for more information. Module: [`ColumnHoverModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Column Moving

See [Column Moving](https://www.ag-grid.com/angular-data-grid/column-moving/)

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `moveColumns` | `Function` |  |  | Moves columns to `toIndex`. The columns are first removed, then added at the `toIndex` location, thus index locations will change to the right of the column after the removal. |
| `moveColumnByIndex` | `Function` |  |  | Moves the column at `fromIndex` 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. |

### Column Pinning

See [Column Pinning](https://www.ag-grid.com/angular-data-grid/column-pinning/)

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isPinning` | `Function` |  |  | Returns `true` if pinning left or right, otherwise `false`. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isPinningLeft` | `Function` |  |  | Returns `true` if pinning left, otherwise `false`. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isPinningRight` | `Function` |  |  | Returns `true` if pinning right, otherwise `false`. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setColumnsPinned` | `Function` |  |  | Set a column's pinned / unpinned state. Key can be the column ID, field, `ColDef` object or `Column` object. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Column Sizing

See [Column Sizing](https://www.ag-grid.com/angular-data-grid/column-sizing/)

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `setColumnWidths` | `Function` |  |  | Sets the column widths of the columns provided. 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` | `Function` |  |  | Adjusts the size of columns to fit the available horizontal space. Note: it is not recommended to call this method rapidly e.g. in response to window resize events or as the container size is animated. This can cause the scrollbar to flicker. Use column flex for smoother results. If inferring cell data types with custom column types and row data is initially empty or yet to be set, 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](https://www.ag-grid.com/angular-data-grid/column-sizing/#auto-size-columns-to-fit-grid) for more information. Module: [`ColumnAutoSizeModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `autoSizeColumns` | `Function` |  |  | Auto-sizes columns based on their contents. If inferring cell data types with custom column types and row data is initially empty or yet to be set, 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](https://www.ag-grid.com/angular-data-grid/column-sizing/#auto-size-columns-to-fit-cell-contents) for more information. Module: [`ColumnAutoSizeModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `autoSizeAllColumns` | `Function` |  |  | Auto-sizes columns based on their contents. If inferring cell data types with custom column types and row data is initially empty or yet to be set, 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](https://www.ag-grid.com/angular-data-grid/column-sizing/#auto-size-columns-to-fit-cell-contents) for more information. Module: [`ColumnAutoSizeModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Column State

See [Column State](https://www.ag-grid.com/angular-data-grid/column-state/)

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getColumnState` | `Function` |  |  | Gets the state of the columns. Typically used when saving column state. See [Save and Apply State](https://www.ag-grid.com/angular-data-grid/column-state/#save-and-apply) for more information. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `applyColumnState` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/column-state/#save-and-apply) for more information. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `resetColumnState` | `Function` |  |  | Sets the state back to match the originally provided column definitions. Module: [`ColumnApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getColumnGroupState` | `Function` |  |  | Gets the state of the column groups. Typically used when saving column group state. See [Column Group State](https://www.ag-grid.com/angular-data-grid/column-state/#column-group-state) for more information. |
| `setColumnGroupState` | `Function` |  |  | Sets the state of the column group state from a previous state. See [Column Group State](https://www.ag-grid.com/angular-data-grid/column-state/#column-group-state) for more information. |
| `resetColumnGroupState` | `Function` |  |  | Sets the state back to match the originally provided column definitions. |

### Editing

See [Cell Editing](https://www.ag-grid.com/angular-data-grid/cell-editing/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `startEditingCell` | `Function` |  |  | Start editing the provided cell. If another cell is editing, the editing will be stopped in that other cell. See [Editing API](https://www.ag-grid.com/angular-data-grid/cell-editing-start-stop/#editing-api) for more information. Modules (any of): [`TextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`LargeTextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CheckboxEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SelectEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`RichSelectModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `stopEditing` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/cell-editing-start-stop/#editing-api) for more information. Modules (any of): [`TextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`LargeTextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CheckboxEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SelectEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`RichSelectModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isEditing` | `Function` |  |  | Returns `true` if the grid is editing a cell See [Editing API](https://www.ag-grid.com/angular-data-grid/cell-editing-start-stop/#editing-api) for more information. Modules (any of): [`TextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`LargeTextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CheckboxEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SelectEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`RichSelectModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getEditingCells` | `Function` |  |  | If the grid is editing, returns back details of the editing cell(s). See [Editing API](https://www.ag-grid.com/angular-data-grid/cell-editing-start-stop/#editing-api) for more information. Modules (any of): [`TextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`LargeTextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CheckboxEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SelectEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`RichSelectModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getEditRowValues` | `Function` |  |  | If the grid is editing, returns back edit values of the row if any. See [Editing API](https://www.ag-grid.com/angular-data-grid/cell-editing-start-stop/#editing-api) for more information. Modules (any of): [`TextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`LargeTextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CheckboxEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SelectEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`RichSelectModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getCellEditorInstances` | `Function` |  |  | Returns the list of active cell editor instances. Optionally provide parameters to restrict to certain columns / row nodes. See [Cell Editor Instances](https://www.ag-grid.com/angular-data-grid/cell-editors/#accessing-instances) for more information. Modules (any of): [`TextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`LargeTextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CheckboxEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SelectEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`RichSelectModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `validateEdit` | `Function` |  |  | Run validation for every instantiated editor. See [Edit Validation](https://www.ag-grid.com/angular-data-grid/cell-editing-validation/) for more information. Modules (any of): [`TextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`LargeTextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CheckboxEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SelectEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`RichSelectModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getEditValidationErrors` | `Function` |  |  | The validation errors the Grid currently holds, without running validation. Use `validateEdit()` to revalidate instead. See [Edit Validation](https://www.ag-grid.com/angular-data-grid/cell-editing-validation/) for more information. Modules (any of): [`TextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`LargeTextEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CheckboxEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SelectEditorModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`RichSelectModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Editing: Batch

See [Batch Editing](https://www.ag-grid.com/angular-data-grid/cell-editing-batch/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `startBatchEdit` | `Function` |  |  | Starts a batch editing session. While batch editing is active, cell edits are accumulated as pending values without being committed to the row data. The pending values are only written when `commitBatchEdit()` is called, or discarded when `cancelBatchEdit()` is called. Calling `startBatchEdit()` while a batch is already active is a no-op. Use `isBatchEditing()` to check whether a batch session is currently active. Any active cell editor is cancelled when the batch session starts. The `batchEditingStarted` event is fired lazily on the first actual cell edit within the batch session, not when `startBatchEdit()` is called. Only supported with the Client-Side Row Model. See [Batch Editing](https://www.ag-grid.com/angular-data-grid/cell-editing-batch/) for more information. Module: [`BatchEditModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `commitBatchEdit` | `Function` |  |  | Commits all pending batch edits to the row data and ends the batch editing session. Each accumulated pending value is written via `rowNode.setDataValue()`, and the `batchEditingStopped` event is fired with the committed edits. Calling `commitBatchEdit()` when no batch is active is a no-op. If no cells were edited during the batch session (i.e. `batchEditingStarted` was never fired), `batchEditingStopped` is not fired either. With `invalidEditValueMode: 'block'`, a commit is rejected while any edit is invalid: nothing is written, `batchEditingStopped` does not fire, and the batch and its editors stay open so the value can be corrected and the commit retried (or `cancelBatchEdit()` called). Only supported with the Client-Side Row Model. See [Batch Editing](https://www.ag-grid.com/angular-data-grid/cell-editing-batch/) for more information. Module: [`BatchEditModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `cancelBatchEdit` | `Function` |  |  | Cancels all pending batch edits, reverting cells to their original values, and ends the batch editing session. The `batchEditingStopped` event is fired with an empty edit map. Calling `cancelBatchEdit()` when no batch is active is a no-op. If no cells were edited during the batch session (i.e. `batchEditingStarted` was never fired), `batchEditingStopped` is not fired either. Only supported with the Client-Side Row Model. See [Batch Editing](https://www.ag-grid.com/angular-data-grid/cell-editing-batch/) for more information. Module: [`BatchEditModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isBatchEditing` | `Function` |  |  | Returns `true` if a batch editing session is currently active (i.e. `startBatchEdit()` has been called and neither `commitBatchEdit()` nor `cancelBatchEdit()` has been called yet). See [Batch Editing](https://www.ag-grid.com/angular-data-grid/cell-editing-batch/) for more information. Module: [`BatchEditModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Events

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `addEventListener` | `Function` |  |  | Add an event listener for the specified `eventType`. Listener will receive the `event` as a single parameter. Listeners will be automatically removed when the grid is destroyed. Module: [`EventApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `removeEventListener` | `Function` |  |  | Remove an event listener. Module: [`EventApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `addGlobalListener` | `Function` |  |  | Add an event listener for all event types coming from the grid. Listener will receive `eventType` and `event` as parameters. Listeners will be automatically removed when the grid is destroyed. If handling multiple event types it is recommended to use `event.type` to enable TypeScript to infer the event parameters. Module: [`EventApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `removeGlobalListener` | `Function` |  |  | Remove a global event listener. Module: [`EventApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `addRenderedRowListener` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/row-events/) for more information. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Export

See [Export](https://www.ag-grid.com/angular-data-grid/excel-export/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `exportDataAsCsv` | `Function` |  |  | Downloads a CSV export of the grid's data. See [CSV Export](https://www.ag-grid.com/angular-data-grid/csv-export/) for more information. Module: [`CsvExportModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getDataAsCsv` | `Function` |  |  | Similar to `exportDataAsCsv`, except returns the result as a string rather than download it. See [CSV Export](https://www.ag-grid.com/angular-data-grid/csv-export/) for more information. Module: [`CsvExportModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `exportDataAsExcel` | `Function` |  |  | Downloads an Excel export of the grid's data. See [Enabling Excel Export](https://www.ag-grid.com/angular-data-grid/excel-export/#enabling-excel-export) for more information. Module: [`ExcelExportModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getDataAsExcel` | `Function` |  |  | Similar to `exportDataAsExcel`, except instead of downloading a file, it will return a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) to be processed by the user. Module: [`ExcelExportModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getSheetDataForExcel` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/excel-export-multiple-sheets/) for more information. Module: [`ExcelExportModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `exportMultipleSheetsAsExcel` | `Function` |  |  | Downloads an Excel export of multiple sheets in one file. See [Excel Export - Multiple Sheets](https://www.ag-grid.com/angular-data-grid/excel-export-multiple-sheets/) for more information. Module: [`ExcelExportModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getMultipleSheetsAsExcel` | `Function` |  |  | Similar to `exportMultipleSheetsAsExcel`, except instead of downloading a file, it will return a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) to be processed by the user. See [Excel Export - Multiple Sheets](https://www.ag-grid.com/angular-data-grid/excel-export-multiple-sheets/) for more information. Module: [`ExcelExportModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Filtering

See [Filtering](https://www.ag-grid.com/angular-data-grid/filtering-overview/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getQuickFilter` | `Function` |  |  | Only supported for Client-Side Row Model. Get the current Quick Filter text from the grid, or `undefined` if none is set. See [Checking the Quick Filter](https://www.ag-grid.com/angular-data-grid/filter-quick/#checking-the-quick-filter) for more information. Module: [`QuickFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `resetQuickFilter` | `Function` |  |  | Only supported for Client-Side Row Model. Reset the Quick Filter cache text on every rowNode. See [Reset Cache Text](https://www.ag-grid.com/angular-data-grid/filter-quick/#reset-cache-text) for more information. Module: [`QuickFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isQuickFilterPresent` | `Function` |  |  | Only supported for Client-Side Row Model. Returns `true` if the Quick Filter is set, otherwise `false`. See [Checking the Quick Filter](https://www.ag-grid.com/angular-data-grid/filter-quick/#checking-the-quick-filter) for more information. Module: [`QuickFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isColumnFilterPresent` | `Function` |  |  | Returns `true` if any column filter is set, otherwise `false`. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isAnyFilterPresent` | `Function` |  |  | Returns `true` if any filter is set. This includes quick filter, column filter, external filter or advanced filter. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`QuickFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ExternalFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`AdvancedFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getColumnFilterInstance` | `Function` |  |  | Returns the filter component instance for a column. For getting/setting models for individual column filters, use `getColumnFilterModel` and `setColumnFilterModel` instead of this. `key` can be a column ID or a `Column` object. See [Accessing Individual Filters](https://www.ag-grid.com/angular-data-grid/filter-api/#accessing-individual-filters) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getColumnFilterHandler` | `Function` |  |  | Returns the filter handler instance for a column. Used when `enableFilterHandlers = true`, or when using a grid-provided filter. If using a `SimpleColumnFilter`, this will be an object containing the provided `doesFilterPass` callback. `key` can be a column ID or a `Column` object. See [Accessing Individual Filters](https://www.ag-grid.com/angular-data-grid/filter-api/#accessing-individual-filters) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getFilterModel` | `Function` |  |  | Gets the current state of all the column filters. Used for saving filter state. See [Get / Set All Filter Models](https://www.ag-grid.com/angular-data-grid/filter-api/#get--set-all-filter-models) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setFilterModel` | `Function` |  |  | 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 initially empty or 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](https://www.ag-grid.com/angular-data-grid/filter-api/#get--set-all-filter-models) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getColumnFilterModel` | `Function` |  |  | Gets the current filter model for the specified column. Will return `null` if no active filter. See [Get / Set Individual Filter Model](https://www.ag-grid.com/angular-data-grid/filter-api/#get--set-individual-filter-model) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setColumnFilterModel` | `Function` |  |  | Sets the filter model for the specified column. Setting a `model` of `null` will reset the filter (make inactive). Must wait on the response before calling `api.onFilterChanged()`. See [Get / Set Individual Filter Model](https://www.ag-grid.com/angular-data-grid/filter-api/#get--set-individual-filter-model) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `onFilterChanged` | `FilterChangedEventSourceType` |  |  | 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](https://www.ag-grid.com/angular-data-grid/filter-api/#re-running-grid-filtering) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`QuickFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ExternalFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`AdvancedFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `destroyFilter` | `Function` |  |  | Destroys a filter. Useful to force a particular filter to be created from scratch again. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `doFilterAction` | `Function` |  |  | Perform the provided filter action for the column specified, or all columns. Requires `enableFilterHandlers = true`. See [Applying the UI Model](https://www.ag-grid.com/angular-data-grid/filter-applying/#applying-the-ui-model) for more information. Modules (any of): [`TextFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`NumberFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`DateFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`SetFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`MultiFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`CustomFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getAdvancedFilterModel` | `Function` |  |  | Get the state of the Advanced Filter. Used for saving Advanced Filter state See [Advanced Filter](https://www.ag-grid.com/angular-data-grid/filter-advanced/#filter-model--api) for more information. Module: [`AdvancedFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setAdvancedFilterModel` | `Function` |  |  | Set the state of the Advanced Filter or used for restoring Advanced Filter state. If inferring cell data types, and row data is initially empty or 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 [Advanced Filter](https://www.ag-grid.com/angular-data-grid/filter-advanced/#filter-model--api) for more information. Module: [`AdvancedFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `showAdvancedFilterBuilder` | `Function` |  |  | Open the Advanced Filter Builder dialog (if enabled). See [Advanced Filter](https://www.ag-grid.com/angular-data-grid/filter-advanced/#configuring-advanced-filter-builder) for more information. Module: [`AdvancedFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `hideAdvancedFilterBuilder` | `Function` |  |  | Closes the Advanced Filter Builder dialog (if enabled). Un-applied changes are discarded. See [Advanced Filter](https://www.ag-grid.com/angular-data-grid/filter-advanced/#configuring-advanced-filter-builder) for more information. Module: [`AdvancedFilterModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Find

See [Find](https://www.ag-grid.com/angular-data-grid/find/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `findNext` | `Function` |  |  | Go to the next match. See [Find](https://www.ag-grid.com/angular-data-grid/find/) for more information. Module: [`FindModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `findPrevious` | `Function` |  |  | Go to the previous match. See [Find](https://www.ag-grid.com/angular-data-grid/find/) for more information. Module: [`FindModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `findGetTotalMatches` | `Function` |  |  | Get the total number of matches. See [Find](https://www.ag-grid.com/angular-data-grid/find/) for more information. Module: [`FindModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `findGoTo` | `Function` |  |  | Go to the provided match (first match is `1`). By default, if the provided match is already active, this will do nothing. If `force` is set to `true`, this will instead reset the active match to that provided (e.g. scroll the grid). See [Find](https://www.ag-grid.com/angular-data-grid/find/) for more information. Module: [`FindModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `findClearActive` | `Function` |  |  | Clear the active match. See [Find](https://www.ag-grid.com/angular-data-grid/find/) for more information. Module: [`FindModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `findGetActiveMatch` | `Function` |  |  | Get the active match, or `undefined` if no active match. See [Find](https://www.ag-grid.com/angular-data-grid/find/) for more information. Module: [`FindModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `findGetNumMatches` | `Function` |  |  | Get the number of matches within the provided cell. See [Using Find with Cell Components](https://www.ag-grid.com/angular-data-grid/find/#using-find-with-cell-components) for more information. Module: [`FindModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `findGetParts` | `Function` |  |  | Get the parts of a cell value, including matches and active match. Used for custom cell components. See [Using Find with Cell Components](https://www.ag-grid.com/angular-data-grid/find/#using-find-with-cell-components) for more information. Module: [`FindModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `findRefresh` | `Function` |  |  | This will re-run the search with the current value. This is normally done automatically. This should only be called in situations where data is mutated outside of the grid, and `api.refreshCells()` or `api.redrawRows()` are being used (`api.findRefresh()` should be called after these). See [Content to Search](https://www.ag-grid.com/angular-data-grid/find/#content-to-search) for more information. Module: [`FindModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Grid Options

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getGridOption` | `Function` |  |  | Returns the grid option value for a provided key. See [GridOptions](https://www.ag-grid.com/angular-data-grid/grid-options/) for more information. |
| `setGridOption` | `Function` |  |  | Updates a single gridOption to the new value provided. (Cannot be used on `Initial` properties.) If updating multiple options, it is recommended to instead use `api.updateGridOptions()` which batches update logic. See [GridOptions](https://www.ag-grid.com/angular-data-grid/grid-options/) for more information. |
| `updateGridOptions` | `Function` |  |  | Updates the provided subset of gridOptions with the provided values. (Cannot be used on `Initial` properties.) See [GridOptions](https://www.ag-grid.com/angular-data-grid/grid-options/) for more information. |

### Grid State

See [Grid State](https://www.ag-grid.com/angular-data-grid/grid-state/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getState` | `Function` |  |  | Get the current state of the grid. Can be used in conjunction with the `initialState` grid option or `api.setState()` to save and restore grid state. See [Saving and Restoring State](https://www.ag-grid.com/angular-data-grid/grid-state/#saving-and-restoring-state) for more information. Module: [`GridStateModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setState` | `Function` |  |  | Set the current state of the grid. Can be used in conjunction with `api.getState()` or `onStateUpdated` to save and restore grid state. This method should only be used to restore state; it should not be called on every state update (the grid does not support being used as a controlled component). See [Setting State](https://www.ag-grid.com/angular-data-grid/grid-state/#setting-state) for more information. |

### Integrated Charts

See [Integrated Charts](https://www.ag-grid.com/angular-data-grid/integrated-charts/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `createRangeChart` | `Function` |  |  | Used to programmatically create charts from a range. See [Range Chart API](https://www.ag-grid.com/angular-data-grid/integrated-charts-api-range-chart/) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `createPivotChart` | `Function` |  |  | Used to programmatically create pivot charts from a grid. See [Pivot Chart API](https://www.ag-grid.com/angular-data-grid/integrated-charts-api-pivot-chart/) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `createCrossFilterChart` | `Function` |  |  | Used to programmatically create cross filter charts from a range. See [Cross-filter API](https://www.ag-grid.com/angular-data-grid/integrated-charts-api-cross-filter-chart/) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `updateChart` | `Function` |  |  | Used to programmatically update a chart. See [Event Driven Chart Updates](https://www.ag-grid.com/angular-data-grid/integrated-charts-events/#event-driven-chart-updates) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getChartRef` | `Function` |  |  | Returns the `ChartRef` using the supplied `chartId`. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getChartModels` | `Function` |  |  | Returns a list of models with information about the charts that are currently rendered from the grid. See [Saving / Restoring Charts](https://www.ag-grid.com/angular-data-grid/integrated-charts-api-save-restore-charts/) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `restoreChart` | `Function` |  |  | Restores a chart using the `ChartModel` that was previously obtained from `getChartModels()`. See [Saving / Restoring Charts](https://www.ag-grid.com/angular-data-grid/integrated-charts-api-save-restore-charts/) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getChartImageDataURL` | `Function` |  |  | Returns a base64-encoded image data URL for the referenced chartId. See [Downloading Chart Image](https://www.ag-grid.com/angular-data-grid/integrated-charts-api-downloading-image/) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `downloadChart` | `Function` |  |  | Starts a browser-based image download for the referenced chartId. See [Downloading Chart Image](https://www.ag-grid.com/angular-data-grid/integrated-charts-api-downloading-image/) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `openChartToolPanel` | `Function` |  |  | Open the Chart Tool Panel. See [Open Chart Tool Panel](https://www.ag-grid.com/angular-data-grid/integrated-charts-chart-tool-panels/#chart-tool-panel-api) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `closeChartToolPanel` | `Function` |  |  | Close the Chart Tool Panel. See [Close Chart Tool Panel](https://www.ag-grid.com/angular-data-grid/integrated-charts-chart-tool-panels/#chart-tool-panel-api) for more information. Module: [`IntegratedChartsModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Keyboard Navigation

See [Keyboard Navigation](https://www.ag-grid.com/angular-data-grid/keyboard-navigation/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getFocusedCell` | `Function` |  |  | Returns the focused cell (or the last focused cell if the grid lost focus). |
| `setFocusedCell` | `Function` |  |  | Sets the focus to the specified cell. `rowPinned` can be either 'top', 'bottom' or null (for not pinned). |
| `clearFocusedCell` | `Function` |  |  | Clears the focused cell. |
| `tabToNextCell` | `Function` |  |  | Navigates the grid focus to the next cell, as if tabbing. See [Custom Navigation](https://www.ag-grid.com/angular-data-grid/keyboard-navigation/#custom-navigation) for more information. |
| `tabToPreviousCell` | `Function` |  |  | Navigates the grid focus to the previous cell, as if shift-tabbing. See [Custom Navigation](https://www.ag-grid.com/angular-data-grid/keyboard-navigation/#custom-navigation) for more information. |
| `setFocusedHeader` | `Function` |  |  | Sets the focus to the specified header. If `floatingFilter` is true, the Column's floatingFilter element will be focused. |

### Master Detail

See [Master Detail](https://www.ag-grid.com/angular-data-grid/master-detail/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getDetailGridInfo` | `Function` |  |  | Returns the `DetailGridInfo` corresponding to the supplied `detailGridId`. See [Accessing Detail Grids](https://www.ag-grid.com/angular-data-grid/master-detail-grids/#accessing-detail-grids) for more information. Module: [`MasterDetailModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `forEachDetailGridInfo` | `Function` |  |  | Iterates through each `DetailGridInfo` in the grid and calls the supplied callback on each. See [Accessing Detail Grids](https://www.ag-grid.com/angular-data-grid/master-detail-grids/#accessing-detail-grids) for more information. Module: [`MasterDetailModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `addDetailGridInfo` | `Function` |  |  | Register a detail grid with the master grid when it is created. See [Register Detail Grid](https://www.ag-grid.com/angular-data-grid/master-detail-custom-detail/#register-detail-grid) for more information. Module: [`MasterDetailModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `removeDetailGridInfo` | `Function` |  |  | Unregister a detail grid from the master grid when it is destroyed. See [Register Detail Grid](https://www.ag-grid.com/angular-data-grid/master-detail-custom-detail/#register-detail-grid) for more information. Module: [`MasterDetailModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Miscellaneous

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getCellValue` | `Function` |  |  | Gets the cell value for the given column and `rowNode` (row). Will return the cell value or the formatted value depending on the value of `params.useFormatter`. The `params.from` option controls which value is resolved, including `'transformed'` to read the displayed [Show Values As](https://www.ag-grid.com/angular-data-grid/aggregation-show-values-as/) value. Module: [`CellApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `expireValueCache` | `Function` |  |  | Expire the value cache. See [Value Cache](https://www.ag-grid.com/angular-data-grid/value-cache/) for more information. Module: [`ValueCacheModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `destroy` | `Function` |  |  | 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` | `Function` |  |  | Returns `true` if the grid has been destroyed. |
| `setGridAriaProperty` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/accessibility/#aria-attributes) for more information. Module: [`RenderApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getGridId` | `Function` |  |  | Returns the `gridId` for the current grid as specified via the gridOptions property `gridId` or the auto assigned grid id if none was provided. |
| `getGridElement` | `Function` |  |  | Returns the outermost DOM element created by the grid. This is a direct child of the host element provided by the application. |
| `isModuleRegistered` | `Function` |  |  | Check if a Module is registered with the current grid instance via its equivalent string name. |
| `isAnimationFrameQueueEmpty` | `Function` |  |  | Returns `true` when there are no more animation frames left to process. Module: [`RenderApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Notes

See [Notes](https://www.ag-grid.com/angular-data-grid/notes/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getNote` | `Function` |  |  | Return the current note for a cell. See [Notes API](https://www.ag-grid.com/angular-data-grid/notes/#api-reference) for more information. Module: [`NotesModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setNote` | `Function` |  |  | Set or remove the note for a cell. Pass `note: undefined` to remove the note. See [Notes API](https://www.ag-grid.com/angular-data-grid/notes/#api-reference) for more information. Module: [`NotesModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `refreshNotes` | `Function` |  |  | Refresh note presence for the currently rendered cells. See [Notes API](https://www.ag-grid.com/angular-data-grid/notes/#api-reference) for more information. Module: [`NotesModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Overlays

See [Overlays](https://www.ag-grid.com/angular-data-grid/overlays/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `showNoRowsOverlay` | `Function` |  |  | Show the no-rows overlay. If `loading` is true, this will not do anything. - **Prefer `setGridOption('activeOverlay', 'agNoRowsOverlay')` .** |
| `hideOverlay` | `Function` |  |  | Hide the no-rows overlay if it is showing. - **Prefer `setGridOption('activeOverlay', undefined)` .** |

### Pagination

See [Row Pagination](https://www.ag-grid.com/angular-data-grid/row-pagination/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `paginationIsLastPageFound` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/infinite-scrolling/). Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `paginationGetPageSize` | `Function` |  |  | Returns how many rows are being shown per page. Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `paginationGetCurrentPage` | `Function` |  |  | Returns the 0-based index of the page which is showing. Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `paginationGetTotalPages` | `Function` |  |  | Returns the total number of pages. Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `paginationGetRowCount` | `Function` |  |  | Returns the total number of pageable rows, as impacted by `gridOptions.paginateChildRows: true`. It is recommended to instead use `gridApi.getDisplayedRowCount()` if not using pagination, or if `gridOption.paginateChildRows=true`. Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `paginationGoToPage` | `Function` |  |  | Goes to the specified page. If the page requested doesn't exist, it will go to the last page. Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `paginationGoToNextPage` | `Function` |  |  | Navigates to the next page. Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `paginationGoToPreviousPage` | `Function` |  |  | Navigates to the previous page. Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `paginationGoToFirstPage` | `Function` |  |  | Navigates to the first page. Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `paginationGoToLastPage` | `Function` |  |  | Navigates to the last page. Module: [`PaginationModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Refresh

See [View Refresh](https://www.ag-grid.com/angular-data-grid/view-refresh/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `refreshCells` | `Function` |  |  | Performs change detection on all cells, refreshing cells where required. See [Refresh Cells](https://www.ag-grid.com/angular-data-grid/view-refresh/#refresh-cells) for more information. Module: [`RenderApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `redrawRows` | `Function` |  |  | Remove row(s) from the DOM and recreate them again from scratch. See [Redraw Rows](https://www.ag-grid.com/angular-data-grid/view-refresh/#redraw-rows) for more information. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `refreshHeader` | `Function` |  |  | Redraws the header. Useful if a column name changes, or something else that changes how the column header is displayed. Module: [`RenderApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `refreshFormulas` | `Function` |  |  | Invalidate the grid's formula cache so the next render re-queries `formulaDataSource.getFormula` and re-evaluates affected formulas. Call this when the formula store has been mutated outside the grid (e.g. synced from a backend). In-grid edits and Client-Side Row Model updates invalidate automatically. - No argument: invalidates every cached formula. - `RowNode`: invalidates that row and its pinned / group-footer siblings. - `string` (row id): resolved against the main row model, pinned-top and pinned-bottom. Every match is invalidated — so if a statically-pinned row shares an id with a body row, both are refreshed. An unknown id is a silent no-op. See [Formula Caching](https://www.ag-grid.com/angular-data-grid/formulas/#caching) for more information. Module: [`FormulaModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `flashCells` | `Function` |  |  | Flash rows, columns or individual cells. See [Flashing Cells](https://www.ag-grid.com/angular-data-grid/change-cell-renderers/) for more information. Module: [`HighlightChangesModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Rendering

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getRenderedNodes` | `Function` |  |  | Retrieve rendered nodes. Due to virtualisation this will contain only the current visible rows and those in the buffer. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getCellRendererInstances` | `Function` |  |  | Returns the list of active cell renderer instances. See [Cell Renderer Instances](https://www.ag-grid.com/angular-data-grid/component-cell-renderer/#accessing-instances) for more information. Module: [`RenderApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getSizesForCurrentTheme` | `Function` |  |  | 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. Module: [`RenderApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `resetRowHeights` | `Function` |  |  | Tells the grid to recalculate the row heights. See [Changing Row Height](https://www.ag-grid.com/angular-data-grid/row-height/#changing-row-height) for more information. Modules (any of): [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `onRowHeightChanged` | `Function` |  |  | Tells the grid a row height has changed. To be used after calling `rowNode.setRowHeight(newHeight)`. See [Changing Row Height](https://www.ag-grid.com/angular-data-grid/row-height/#changing-row-height) for more information. |

### Row Aggregation

See [Aggregation](https://www.ag-grid.com/angular-data-grid/aggregation/) for more information

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getValueColumns` | `Function` |  |  | Get a list of the existing value columns. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `addValueColumns` | `Function` |  |  | Add the given list of columns to the existing set of value columns. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `removeValueColumns` | `Function` |  |  | Remove the given list of columns from the existing set of value columns. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setValueColumns` | `Function` |  |  | Set the value columns to the provided list of columns. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setColumnAggFunc` | `Function` |  |  | 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. Modules (any of): [`RowGroupingModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`TreeDataModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `addAggFuncs` | `Function` |  |  | Add aggregations function with the specified keys. See [Registering Custom Functions](https://www.ag-grid.com/angular-data-grid/aggregation-custom-functions/#registering-custom-functions) for more information. Modules (any of): [`RowGroupingModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`TreeDataModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `clearAggFuncs` | `Function` |  |  | Clears all aggregation functions (including those provided by the grid). Modules (any of): [`RowGroupingModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`TreeDataModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Row Displayed

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getDisplayedRowAtIndex` | `Function` |  |  | Returns the displayed `RowNode` at the given `index`. See [Rendering API](https://www.ag-grid.com/angular-data-grid/dom-virtualisation/) for more information. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getDisplayedRowCount` | `Function` |  |  | Returns the total number of displayed rows. See [Rendering API](https://www.ag-grid.com/angular-data-grid/dom-virtualisation/) for more information. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getFirstDisplayedRowIndex` | `Function` |  |  | Get the index of the first displayed row due to scrolling (includes invisible rendered rows in the buffer). See [Rendering API](https://www.ag-grid.com/angular-data-grid/dom-virtualisation/) for more information. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getLastDisplayedRowIndex` | `Function` |  |  | Get the index of the last displayed row due to scrolling (includes invisible rendered rows in the buffer). See [Rendering API](https://www.ag-grid.com/angular-data-grid/dom-virtualisation/) for more information. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Row Drag and Drop

See [Row Dragging](https://www.ag-grid.com/angular-data-grid/row-dragging/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `addRowDropZone` | `Function` |  |  | Adds a drop zone outside of the grid where rows can be dropped. See [Row Dragging to an External DropZone](https://www.ag-grid.com/angular-data-grid/row-dragging-to-external-dropzone/) for more information. Module: [`RowDragModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `removeRowDropZone` | `Function` |  |  | Removes an external drop zone added by `addRowDropZone`. See [Row Dragging to an External DropZone](https://www.ag-grid.com/angular-data-grid/row-dragging-to-external-dropzone/) for more information. Module: [`RowDragModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getRowDropZoneParams` | `Function` |  |  | Returns the `RowDropZoneParams` to be used by another grid's `addRowDropZone` method. See [Row Dragging Between Grids](https://www.ag-grid.com/angular-data-grid/row-dragging-to-grid/) for more information. Module: [`RowDragModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setRowDropPositionIndicator` | `Function` |  |  | Sets the current highlighted row drop target. This is useful for implementing custom unmanaged row drag and drop logic, to highlight the target row. See [Row Drag and Drop Usage](https://www.ag-grid.com/angular-data-grid/row-dragging/) for more information. Module: [`RowDragModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getRowDropPositionIndicator` | `Function` |  |  | Gets the currently highlighted drop target row, set by `setRowDropPositionIndicator` or managed drag ad drop. See [Row Drag and Drop Usage](https://www.ag-grid.com/angular-data-grid/row-dragging/) for more information. Module: [`RowDragModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Row Expand and Collapse

See [Row Grouping](https://www.ag-grid.com/angular-data-grid/grouping-opening-groups/), [Master Detail](https://www.ag-grid.com/angular-data-grid/master-detail/) or [Tree Data](https://www.ag-grid.com/angular-data-grid/tree-data-opening-groups/) for more information

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `expandAll` | `Function` |  |  | Expand all groups. See [Expanding Groups](https://www.ag-grid.com/angular-data-grid/grouping-opening-groups/#api) for more information. Modules (any of): [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `collapseAll` | `Function` |  |  | Collapse all groups. See [Expanding Groups](https://www.ag-grid.com/angular-data-grid/grouping-opening-groups/#api) for more information. Modules (any of): [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `resetRowGroupExpansion` | `Function` |  |  | Reset all group expansion to defaults, as determined by `groupDefaultExpanded`, `isGroupOpenByDefault`, or `isServerSideGroupOpenByDefault`. Any user-initiated expand/collapse overrides are discarded. See [Reset Group Expansion](https://www.ag-grid.com/angular-data-grid/grouping-opening-groups/#reset-group-expansion) for more information. Modules (any of): [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setRowNodeExpanded` | `Function` |  |  | Expand or collapse a specific row node, optionally expanding/collapsing all of its parent nodes. By default rows are expanded asynchronously for best performance. Set `forceSync: true` if you need to interact with the expanded row immediately after this function. See [Expand to a Row](https://www.ag-grid.com/angular-data-grid/grouping-opening-groups/#expand-row-ancestors) for more information. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `onGroupExpandedOrCollapsed` | `Function` |  |  | 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. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Row Grouping

See [Row Grouping](https://www.ag-grid.com/angular-data-grid/grouping/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getRowGroupColumns` | `Function` |  |  | Get row group columns. Module: [`RowGroupingModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setRowGroupColumns` | `Function` |  |  | Set the row group columns. Module: [`RowGroupingModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `addRowGroupColumns` | `Function` |  |  | Add columns to the row groups. Module: [`RowGroupingModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `removeRowGroupColumns` | `Function` |  |  | Remove columns from the row groups. Module: [`RowGroupingModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `moveRowGroupColumn` | `Function` |  |  | Move the column to a new position in the row grouping order. Module: [`RowGroupingModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Row Nodes

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getRowNode` | `Function` |  |  | 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. Special IDs for built-in row types (import constants from `ag-grid-community`): - `ROOT_NODE_ID` — the invisible root node (level -1, always a group) - `GRAND_TOTAL_ROW_ID` — the grand total footer row (when `grandTotalRow` is enabled) - `GROUP_TOTAL_ROW_ID_PREFIX + groupId` — a group total footer row for the group with the given ID - `DETAIL_ROW_ID_PREFIX + masterRowId` — the detail row for the master row with the given ID See [Application Assigned IDs](https://www.ag-grid.com/angular-data-grid/row-ids/#row-ids) for more information. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `forEachNode` | `Function` |  |  | 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. It is not called on any pinned row nodes. If using the Infinite Row Model, then this gets called for each page loaded in the page cache. See [Iterating Rows](https://www.ag-grid.com/angular-data-grid/accessing-data/#iterating-rows) for more information. Module: [`RowApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `forEachNodeAfterFilter` | `Function` |  |  | Similar to `forEachNode`, except skips any filtered out data. See [Iterating Rows](https://www.ag-grid.com/angular-data-grid/accessing-data/#iterating-rows) for more information. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `forEachNodeAfterFilterAndSort` | `Function` |  |  | Similar to `forEachNodeAfterFilter`, except the callbacks are called in the order the rows are displayed in the grid. See [Iterating Rows](https://www.ag-grid.com/angular-data-grid/accessing-data/#iterating-rows) for more information. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `forEachLeafNode` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/accessing-data/#iterating-rows) for more information. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Row Pinning

See [Row Pinning](https://www.ag-grid.com/angular-data-grid/row-pinning/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getPinnedTopRowCount` | `Function` |  |  | Gets the number of top pinned rows. Module: [`PinnedRowModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getPinnedBottomRowCount` | `Function` |  |  | Gets the number of bottom pinned rows. Module: [`PinnedRowModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getPinnedTopRow` | `Function` |  |  | Gets the top pinned row with the specified index. Module: [`PinnedRowModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getPinnedBottomRow` | `Function` |  |  | Gets the bottom pinned row with the specified index. Module: [`PinnedRowModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `forEachPinnedRow` | `Function` |  |  | Iterates over each pinned row, calling the provided callback for each row Module: [`PinnedRowModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Row Pivoting

See [Pivot](https://www.ag-grid.com/angular-data-grid/pivoting/)  for more information

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isPivotMode` | `Function` |  |  | Returns whether pivot mode is currently active. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getPivotColumns` | `Function` |  |  | Get the columns which the grid is pivoting on. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setPivotColumns` | `Function` |  |  | Set the columns for the grid to pivot on. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `addPivotColumns` | `Function` |  |  | Add columns for the grid to pivot on. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `removePivotColumns` | `Function` |  |  | Stops the grid from pivoting on the provided columns. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getPivotResultColumn` | `Function` |  |  | Returns the pivot result column for the given `pivotKeys` and `valueColId`. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setPivotResultColumns` | `Function` |  |  | Set explicit pivot column definitions yourself. Used for advanced use cases only. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getPivotResultColumns` | `Function` |  |  | Returns the grid's pivot result columns. Module: [`PivotModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### RowModel: Client-Side

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `applyTransaction` | `Function` |  |  | Update row data. Pass a transaction object with lists for `add`, `remove` and `update`. See [Transaction Updates](https://www.ag-grid.com/angular-data-grid/data-update-transactions/) for more information. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `applyTransactionAsync` | `Function` |  |  | Same as `applyTransaction` except executes asynchronously for efficiency. See [High Frequency Updates](https://www.ag-grid.com/angular-data-grid/data-update-high-frequency/) for more information. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `flushAsyncTransactions` | `Function` |  |  | Executes any remaining asynchronous grid transactions, if any are waiting to be executed. See [Flush Async Transactions](https://www.ag-grid.com/angular-data-grid/data-update-high-frequency/#flush-async-transactions) for more information. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `refreshClientSideRowModel` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/data-update-single-row-cell/#sort--filter--group-refresh) for more information. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isRowDataEmpty` | `Function` |  |  | Returns `true` if the Client-Side row model has no rows. It is not impacted by filtering and does not include pinned rows. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `resetRowHeights` | `Function` |  |  | Tells the grid to recalculate the row heights. See [Changing Row Height](https://www.ag-grid.com/angular-data-grid/row-height/#changing-row-height) for more information. Modules (any of): [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### RowModel: Infinite

See [Infinite Row Model](https://www.ag-grid.com/angular-data-grid/infinite-scrolling/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `refreshInfiniteCache` | `Function` |  |  | 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. Module: [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `purgeInfiniteCache` | `Function` |  |  | 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. Module: [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isLastRowIndexKnown` | `Function` |  |  | Returns `false` if grid allows for scrolling past the last row to load more rows, thus providing infinite scroll. Modules (any of): [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setRowCount` | `Function` |  |  | 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. Modules (any of): [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getCacheBlockState` | `Function` |  |  | Returns an object representing the state of the cache. This is useful for debugging and understanding how the cache is working. Modules (any of): [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### RowModel: Server-Side

See [Server-Side Row Model](https://www.ag-grid.com/angular-data-grid/server-side-model/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `setRowCount` | `Function` |  |  | 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. Modules (any of): [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `refreshServerSide` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/server-side-model-updating-refresh/) for more information. Module: [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getServerSideGroupLevelState` | `Function` |  |  | Returns info on all server side group levels. Module: [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `retryServerSideLoads` | `Function` |  |  | Gets all failed server side loads to retry. See [Retry Loads](https://www.ag-grid.com/angular-data-grid/server-side-model-retry/) for more information. Module: [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `applyServerSideTransaction` | `Function` |  |  | Apply transactions to the server side row model. See [Transactions](https://www.ag-grid.com/angular-data-grid/server-side-model-updating-transactions/) for more information. Module: [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `applyServerSideTransactionAsync` | `Function` |  |  | Batch apply transactions to the server side row model. See [Transactions](https://www.ag-grid.com/angular-data-grid/server-side-model-updating-transactions/#asynchronous-updates) for more information. Module: [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `applyServerSideRowData` | `Function` |  |  | 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. See [Providing Additional Data](https://www.ag-grid.com/angular-data-grid/server-side-model-configuration/#providing-additional-data) for more information. Module: [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getServerSideSelectionState` | `Function` |  |  | Returns an object containing rules matching the selected rows in the SSRM. If `rowSelection.groupSelects` is `'self'` the returned object will be flat, and will conform to `IServerSideSelectionState`. If `rowSelection.groupSelects` is `'descendants'` or `'filteredDescendants'` the returned object will be hierarchical, and will conform to `IServerSideGroupSelectionState`. See [Selection](https://www.ag-grid.com/angular-data-grid/server-side-model-selection/#api-reference) for more information. Module: [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setServerSideSelectionState` | `Function` |  |  | Set the rules matching the selected rows in the SSRM. If `rowSelection.groupSelects` is `'self'` the param will be flat, and should conform to `IServerSideSelectionState`. If `rowSelection.groupSelects` is `'descendants'` or `'filteredDescendants'` the param will be hierarchical, and should conform to `IServerSideGroupSelectionState`. See [Selection](https://www.ag-grid.com/angular-data-grid/server-side-model-selection/#api-reference) for more information. Module: [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getCacheBlockState` | `Function` |  |  | 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](https://www.ag-grid.com/angular-data-grid/server-side-model-configuration/#debug-info) for more information. Modules (any of): [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isLastRowIndexKnown` | `Function` |  |  | Returns `false` if grid allows for scrolling past the last row to load more rows, thus providing infinite scroll. Modules (any of): [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `resetRowHeights` | `Function` |  |  | Tells the grid to recalculate the row heights. See [Changing Row Height](https://www.ag-grid.com/angular-data-grid/row-height/#changing-row-height) for more information. Modules (any of): [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`ServerSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Scrolling

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `ensureIndexVisible` | `Function` |  |  | 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. Module: [`ScrollApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `ensureNodeVisible` | `Function` |  |  | 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. Module: [`ScrollApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `ensureColumnVisible` | `Function` |  |  | Ensures the column is visible by scrolling the table if needed. This will have no effect before the firstDataRendered event has fired. Module: [`ScrollApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getHorizontalPixelRange` | `Function` |  |  | 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 Module: [`ScrollApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getVerticalPixelRange` | `Function` |  |  | 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 Module: [`ScrollApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Selection

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `selectAll` | `Function` |  |  | Select all rows. By default this ignores filtering, expansion and pagination settings. Pass the appropriate select all mode as an argument in order to select only rows that satisfy the filter, or those rows on the current page. Module: [`RowSelectionModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `deselectAll` | `Function` |  |  | Clear all row selections. By default this ignores filtering, expansion and pagination settings. Pass the appropriate select all mode as an argument in order to select only rows that satisfy the filter, or those rows on the current page. Module: [`RowSelectionModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getSelectedNodes` | `Function` |  |  | 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. Module: [`RowSelectionModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getSelectedRows` | `Function` |  |  | Returns an unsorted list of selected rows (i.e. row data that you provided). Module: [`RowSelectionModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `setNodesSelected` | `Function` |  |  | Set all of the provided nodes selection state to the provided value. Module: [`RowSelectionModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getBestCostNodeSelection` | `Function` |  |  | 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. Module: [`ClientSideRowModelApiModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getCellRanges` | `Function` |  |  | Returns the list of selected cell ranges. The start is the first cell the user clicked on and the end is the cell where the user stopped dragging. Do not assume that the start cell's index is numerically before the end cell, as the user could have dragged up. See [getCellRanges](https://www.ag-grid.com/angular-data-grid/cell-selection-api-reference/#reference-selection-getCellRanges) for more information. Module: [`CellSelectionModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `addCellRange` | `Function` |  |  | Adds the provided cell range to the selected ranges. This keeps any previous ranges. If you wish to only have the new range selected, then call `clearCellSelection()` first. See [addCellRange](https://www.ag-grid.com/angular-data-grid/cell-selection-api-reference/#reference-selection-addCellRange) for more information. Module: [`CellSelectionModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `clearCellSelection` | `Function` |  |  | Clears the selected cell ranges. See [clearCellSelection](https://www.ag-grid.com/angular-data-grid/cell-selection-api-reference/#reference-selection-clearCellSelection) for more information. Module: [`CellSelectionModule`](https://www.ag-grid.com/angular-data-grid/modules/). |

### Sorting

See [Row Sorting](https://www.ag-grid.com/angular-data-grid/row-sorting/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `onSortChanged` | `OnSortChanged` |  |  | 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](https://www.ag-grid.com/angular-data-grid/undo-redo-edits/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `undoCellEditing` | `Function` |  |  | Reverts the last cell edit. Module: [`UndoRedoEditModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `redoCellEditing` | `Function` |  |  | Re-applies the most recently undone cell edit. Module: [`UndoRedoEditModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getCurrentUndoSize` | `Function` |  |  | Returns current number of available cell edit undo operations. Module: [`UndoRedoEditModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getCurrentRedoSize` | `Function` |  |  | Returns current number of available cell edit redo operations. Module: [`UndoRedoEditModule`](https://www.ag-grid.com/angular-data-grid/modules/). |