JavaScript Data GridGrid Options

All of these grid options are available through the generic GridOptions<TData> interface.

TData can optionally be used to represent the shape of the row data and is explained further under Typescript Generics.

Accessories

statusBar Type{ statusPanels: StatusPanelDef[]; }	Specifies the status bar components to use in the status bar. See: Status Bar
sideBar TypeSideBarDef \| string \| string[] \| boolean \| null	Specifies the side bar components. See: Side Bar
getContextMenuItems TypeGetContextMenuItems	For customising the context menu. See: Context Menu
suppressContextMenu Typeboolean Defaultfalse	Set to `true` to not show the context menu. Use if you don't want to use the default 'right click' context menu. See: Context Menu
preventDefaultOnContextMenu Typeboolean Defaultfalse	When using `suppressContextMenu`, you can use the `onCellContextMenu` function to provide your own code to handle cell `contextmenu` events. This flag is useful to prevent the browser from showing its default context menu.
allowContextMenuWithControlKey Typeboolean Defaultfalse	Allows context menu to show, even when `Ctrl` key is held down.
getMainMenuItems TypeFunction	For customising the main 'column header' menu. See: Column Menu
suppressMenuHide Typeboolean Defaultfalse	Set to `true` to always show the column menu button, rather than only showing when the mouse is over the column header. See: Column Menu
popupParent TypeHTMLElement \| null	DOM element to use as the popup parent for grid popups (context menu, column menu etc). See: Popup Parent
postProcessPopup TypeFunction	Allows user to process popups after they are created. Applications can use this if they want to, for example, reposition the popup.

Clipboard

See Clipboard for more information.

copyHeadersToClipboard Typeboolean Defaultfalse	Set to `true` to also include headers when copying to clipboard using `Ctrl`+`C` clipboard.
copyGroupHeadersToClipboard Typeboolean Defaultfalse	Set to `true` to also include group headers when copying to clipboard using `Ctrl`+`C` clipboard.
clipboardDelimiter Typestring Default\t	Specify the delimiter to use when copying to clipboard.
suppressCutToClipboard Typeboolean Defaultfalse	Set to `true` to block cut operations within the grid.
suppressCopyRowsToClipboard Typeboolean Defaultfalse	Set to `true` to copy the cell range or focused cell to the clipboard and never the selected rows.
suppressCopySingleCellRanges Typeboolean Defaultfalse	Set to `true` to copy rows instead of ranges when a range with only a single cell is selected.
suppressLastEmptyLineOnPaste Typeboolean Defaultfalse	Set to `true` to work around a bug with Excel (Windows) that adds an extra empty line at the end of ranges copied to the clipboard.
suppressClipboardPaste Typeboolean Defaultfalse	Set to `true` to turn off paste operations within the grid.
suppressClipboardApi Typeboolean Defaultfalse	Set to `true` to stop the grid trying to use the Clipboard API, if it is blocked, and immediately fallback to the workaround.
processCellForClipboard TypeFunction	Allows you to process cells for the clipboard. Handy if for example you have `Date` objects that need to have a particular format if importing into Excel.
processHeaderForClipboard TypeFunction	Allows you to process header values for the clipboard.
processGroupHeaderForClipboard TypeFunction	Allows you to process group header values for the clipboard.
processCellFromClipboard TypeFunction	Allows you to process cells from the clipboard. Handy if for example you have number fields, and want to block non-numbers from getting into the grid.
sendToClipboard TypeFunction	Allows you to get the data that would otherwise go to the clipboard. To be used when you want to control the 'copy to clipboard' operation yourself.
processDataFromClipboard TypeFunction	Allows complete control of the paste operation, including cancelling the operation (so nothing happens) or replacing the data with other data.

Column Definitions

See Column / Column Group definitions for more information

columnDefs Type(ColDef \| ColGroupDef)[] \| null	Array of Column / Column Group definitions.
defaultColDef TypeColDef	A default column definition. Items defined in the actual column definitions get precedence. See: Default Column Definition
defaultColGroupDef TypePartial<ColGroupDef>	A default column group definition. All column group definitions will use these properties. Items defined in the actual column group definition get precedence. See: Default Column Group Definition
columnTypes Type{ [key: string]: ColDef; }	An object map of custom column types which contain groups of properties that column definitions can inherit by referencing in their `type` property. See: Custom Column Types
dataTypeDefinitions Type{ [cellDataType: string]: DataTypeDefinition; }	An object map of cell data types to their definitions. Cell data types can either override/update the pre-defined data types (`'text'`, `'number'`, `'boolean'`, `'date'`, `'dateString'` or `'object'`), or can be custom data types. See: Custom Cell Data Type Definitions
maintainColumnOrder Typeboolean Defaultfalse	Keeps the order of Columns maintained after new Column Definitions are updated. See: Maintain Column Order
suppressFieldDotNotation Typeboolean Defaultfalse	If `true`, then dots in field names (e.g. `'address.firstLine'`) are not treated as deep references. Allows you to use dots in your field name if you prefer. See: Accessing Row Data Values

Column Headers

See Column Headers for more information.

headerHeight Typenumber	The height in pixels for the row containing the column label header. If not specified, it uses the theme value of `header-height`.
groupHeaderHeight Typenumber	The height in pixels for the rows containing header column groups. If not specified, it uses `headerHeight`.
floatingFiltersHeight Typenumber	The height in pixels for the row containing the floating filters. If not specified, it uses the theme value of `header-height`.
pivotHeaderHeight Typenumber	The height in pixels for the row containing the columns when in pivot mode. If not specified, it uses `headerHeight`.
pivotGroupHeaderHeight Typenumber	The height in pixels for the row containing header column groups when in pivot mode. If not specified, it uses `groupHeaderHeight`.

Column Moving

See Column Moving for more information.

allowDragFromColumnsToolPanel Typeboolean Defaultfalse	Allow reordering and pinning columns by dragging columns from the Columns Tool Panel to the grid. See: Columns Tool Panel
suppressMovableColumns Typeboolean Defaultfalse	Set to `true` to suppress column moving, i.e. to make the columns fixed position.
suppressColumnMoveAnimation Typeboolean Defaultfalse	If `true`, the `ag-column-moving` class is not added to the grid while columns are moving. In the default themes, this results in no animation when moving columns.
suppressDragLeaveHidesColumns Typeboolean Defaultfalse	If `true`, when you drag a column out of the grid (e.g. to the group zone) the column is not hidden.
suppressRowGroupHidesColumns Typeboolean Defaultfalse	If `true`, when you drag a column into a row group panel the column is not hidden.

Column Sizing

See Column Sizing for more information.

colResizeDefault Type'shift'	Set to `'shift'` to have shift-resize as the default resize operation (same as user holding down `Shift` while resizing).
suppressAutoSize Typeboolean Defaultfalse	Suppresses auto-sizing columns for columns. In other words, double clicking a column's header's edge will not auto-size. See: Auto-sizing Columns
autoSizePadding Typenumber Default20	Number of pixels to add to a column width after the auto-sizing calculation. Set this if you want to add extra room to accommodate (for example) sort icons, or some other dynamic nature of the header. See: Auto-sizing Columns
skipHeaderOnAutoSize Typeboolean Defaultfalse	Set this to `true` to skip the `headerName` when `autoSize` is called by default. See: Resizing Example

Components

See Components for more information.

Type{ [p: string]: any; }

A map of component names to components.

Editing

See Cell Editing for more information.

editType Type'fullRow'	Set to `'fullRow'` to enable Full Row Editing. Otherwise leave blank to edit one cell at a time. See: Full Row Editing
singleClickEdit Typeboolean Defaultfalse	Set to `true` to enable Single Click Editing for cells, to start editing with a single click. See: Single Click Editing
suppressClickEdit Typeboolean Defaultfalse	Set to `true` so that neither single nor double click starts editing. See: No Click Editing
stopEditingWhenCellsLoseFocus Typeboolean Defaultfalse	Set this to `true` to stop cell editing when grid loses focus. The default is that the grid stays editing until focus goes onto another cell. See: Stop cell editing
enterNavigatesVertically Typeboolean Defaultfalse	Set to `true` along with `enterNavigatesVerticallyAfterEdit` to have Excel-style behaviour for the `Enter` key, i.e. pressing the `Enter` key will move down to the cell beneath. See: Enter Key Navigation
enterNavigatesVerticallyAfterEdit Typeboolean Defaultfalse	Set to `true` along with `enterNavigatesVertically` to have Excel-style behaviour for the `Enter` key, i.e. pressing the `Enter` key will move down to the cell beneath. See: Enter Key Navigation
enableCellEditingOnBackspace Typeboolean	Forces Cell Editing to start when backspace is pressed. This is only relevant for MacOS users.
undoRedoCellEditing Typeboolean	Set to `true` to enable Undo / Redo while editing. See: Undo / Redo Edits
undoRedoCellEditingLimit Typenumber Default10	Set the size of the undo / redo stack.
readOnlyEdit Typeboolean Defaultfalse	Set to `true` to stop the grid updating data after `Edit`, `Clipboard` and `Fill Handle` operations. When this is set, it is intended the application will update the data, eg in an external immutable store, and then pass the new dataset to the grid. Note: `rowNode.setDataValue()` does not update the value of the cell when this is `True`, it fires `onCellEditRequest` instead. See: Read Only Edit

Export

See Export for more information.

defaultCsvExportParams TypeCsvExportParams	A default configuration object used to export to CSV. See: CSV Export
suppressCsvExport Typeboolean Defaultfalse	Prevents the user from exporting the grid to CSV.
defaultExcelExportParams TypeExcelExportParams	A default configuration object used to export to Excel. See: Excel Export
suppressExcelExport Typeboolean Defaultfalse	Prevents the user from exporting the grid to Excel.
excelStyles TypeExcelStyle[]	A list (array) of Excel styles to be used when exporting to Excel with styles. See: Excel Export Styles

Filtering

See Filtering for more information.

quickFilterText Typestring	Rows are filtered using this text as a Quick Filter. See: Quick Filter
cacheQuickFilter Typeboolean Defaultfalse	Set to `true` to turn on the Quick Filter cache, used to improve performance when using the Quick Filter. See: Quick Filter Cache
includeHiddenColumnsInQuickFilter Typeboolean Defaultfalse	Hidden columns are excluded from the Quick Filter by default. To include hidden columns, set to `true`. See: Include Hidden Columns
quickFilterParser TypeFunction	Changes how the Quick Filter splits the Quick Filter text into search terms. See: Quick Filter Parser
quickFilterMatcher TypeFunction	Changes the matching logic for whether a row passes the Quick Filter. See: Quick Filter Matcher
isExternalFilterPresent TypeFunction	Grid calls this method to know if an external filter is present. See: External Filter
doesExternalFilterPass TypeFunction	Should return `true` if external filter passes, otherwise `false`. See: External Filter
excludeChildrenWhenTreeDataFiltering Typeboolean Defaultfalse	Set to `true` to override the default tree data filtering behaviour to instead exclude child nodes from filter results. See: Tree Data Filtering
enableAdvancedFilter Typeboolean Defaultfalse	Set to true to enable the Advanced Filter. See: Advanced Filter
advancedFilterModel TypeAdvancedFilterModel \| null	Allows the state of the Advanced Filter to be set before the grid is loaded. See: Advanced Filter
includeHiddenColumnsInAdvancedFilter Typeboolean Defaultfalse	Hidden columns are excluded from the Advanced Filter by default. To include hidden columns, set to `true`. See: Advanced Filter
advancedFilterParent TypeHTMLElement \| null	DOM element to use as the parent for the Advanced Filter to allow it to appear outside of the grid. Set to `null` or `undefined` to appear inside the grid. See: Advanced Filter
advancedFilterBuilderParams TypeIAdvancedFilterBuilderParams	Customise the parameters passed to the Advanced Filter Builder. See: Advanced Filter

Integrated Charts

See Integrated Charts for more information.

enableCharts Typeboolean Defaultfalse	Set to `true` to Enable Charts. See: Enabling User Created Charts
suppressChartToolPanelsButton Typeboolean Defaultfalse	Set to `true` to show the 'hamburger' menu option from the Chart Toolbar and display the remaining toolbar buttons. See: Suppress Chart Tool Panels Button
getChartToolbarItems TypeFunction	Callback to be used to customise the chart toolbar items. See: Configuring Toolbar Items
createChartContainer TypeFunction	Callback to enable displaying the chart in an alternative chart container. See: Configuring Toolbar Items
chartThemes Typestring[] Default['ag-default', 'ag-material', 'ag-pastel', 'ag-vivid', 'ag-solar' ]	The list of chart themes that a user can chose from in the chart settings panel. See: Provided Themes
customChartThemes Type{ [name: string]: AgChartTheme }	A map containing custom chart themes. See: Custom Chart Themes
chartThemeOverrides TypeAgChartThemeOverrides	Chart theme overrides applied to all themes. See: Chart Groups and Types Customisation
chartToolPanelsDef TypeChartToolPanelsDef	Allows customisation of the Chart Tool Panels, such as changing the tool panels visibility and order, as well as choosing which charts should be displayed in the settings panel. See: Chart Tool Panel customisation

Keyboard Navigation

See Keyboard Navigation for more information.

navigateToNextHeader TypeFunction	Allows overriding the default behaviour for when user hits navigation (arrow) key when a header is focused. Return the next Header position to navigate to or `null` to stay on current header.
tabToNextHeader TypeFunction	Allows overriding the default behaviour for when user hits `Tab` key when a header is focused.
navigateToNextCell TypeFunction	Allows overriding the default behaviour for when user hits navigation (arrow) key when a cell is focused. Return the next Cell position to navigate to or `null` to stay on current cell.
tabToNextCell TypeFunction	Allows overriding the default behaviour for when user hits `Tab` key when a cell is focused.

Loading Cell Renderers

See loadingCellRenderer for more information.

loadingCellRenderer Typeany	Provide your own loading cell renderer to use when data is loading via a DataSource. See: Loading Cell Renderer
loadingCellRendererParams Typeany	Params to be passed to the `loadingCellRenderer` component.
loadingCellRendererSelector TypeLoadingCellRendererSelectorFunc	Callback to select which loading cell renderer to be used when data is loading via a DataSource. See: Loading Cell Renderer Selector

Localisation

See Localisation for more information.

localeText Type{ [key: string]: string }	A map of key->value pairs for localising text within the grid.
getLocaleText TypeFunction	A callback for localising text within the grid.

Master Detail

See Master Detail for more information.

masterDetail Typeboolean Defaultfalse	Set to `true` to enable Master Detail.
isRowMaster TypeIsRowMaster	Callback to be used with Master Detail to determine if a row should be a master row. If `false` is returned no detail row will exist for this row.
detailCellRenderer Typeany	Provide a custom `detailCellRenderer` to use when a master row is expanded. See: Custom Detail
detailCellRendererParams Typeany	Specifies the params to be used by the Detail Cell Renderer. Can also be a function that provides the params to enable dynamic definitions of the params. See: Detail Grids
detailRowHeight Typenumber	Set fixed height in pixels for each detail row. See: Fixed Height
detailRowAutoHeight Typeboolean	Set to `true` to have the detail grid dynamically change it's height to fit it's rows. See: Auto Height
embedFullWidthRows Typeboolean	Set to `true` to have the Full Width Rows embedded in grid's main container so they can be scrolled horizontally . See: Syncing Detail Scrolling with Master
keepDetailRows Typeboolean Defaultfalse	Set to `true` to keep detail rows for when they are displayed again.
keepDetailRowsCount Typenumber Default10	Sets the number of details rows to keep.

Miscellaneous

api TypeGridApi \| null	The Grid Api for interacting with the grid. Set by the grid on init, set to null on destroy. See: Grid Api
columnApi TypeColumnApi \| null	The Column Api for interacting with the grid columns. Set by the grid on init, set to null on destroy. See: Column Api
alignedGrids Type{ api?: GridApi \| null, columnApi?: ColumnApi \| null }[]	A list of grids to treat as Aligned Grids. If grids are aligned then the columns and horizontal scrolling will be kept in sync. See: Aligned Grids
context Typeany	Provides a context object that is provided to different callbacks the grid uses. Used for passing additional information to the callbacks by your application. See: Context
tabIndex Typenumber Default0	Change this value to set the tabIndex order of the Grid within your application.
rowBuffer Typenumber Default10	The number of rows rendered outside the viewable area the grid renders. Having a buffer means the grid will have rows ready to show as the user slowly scrolls vertically.
valueCache Typeboolean Defaultfalse	Set to `true` to turn on the value cache. See: Value Cache
valueCacheNeverExpires Typeboolean Defaultfalse	Set to `true` to configure the value cache to not expire after data updates. See: Value Cache
enableCellExpressions Typeboolean Defaultfalse	Set to `true` to allow cell expressions. See: Cell Expressions
getDocument TypeFunction	Allows overriding what `document` is used. Currently used by Drag and Drop (may extend to other places in the future). Use this when you want the grid to use a different `document` than the one available on the global scope. This can happen if docking out components (something which Electron supports)
suppressTouch Typeboolean Defaultfalse	Disables touch support (but does not remove the browser's efforts to simulate mouse events on touch). See: Touch Support
suppressFocusAfterRefresh Typeboolean Defaultfalse	Set to `true` to not set focus back on the grid after a refresh. This can avoid issues where you want to keep the focus on another part of the browser.
suppressAsyncEvents Typeboolean Defaultfalse	Disables the asynchronous nature of the events introduced in v10, and makes them synchronous. This property only exists for the purpose of supporting legacy code which has a dependency on synchronous events from earlier versions (v9 or earlier) of AG Grid. It is strongly recommended that you do not change this property unless you have legacy issues.
suppressBrowserResizeObserver Typeboolean Defaultfalse	The grid will check for `ResizeObserver` and use it if it exists in the browser, otherwise it will use the grid's alternative implementation. Some users reported issues with Chrome's `ResizeObserver`. Use this property to always use the grid's alternative implementation should such problems exist.
suppressPropertyNamesCheck Typeboolean Defaultfalse	Disables showing a warning message in the console if using a `gridOptions` or `colDef` property that doesn't exist.
suppressChangeDetection Typeboolean Defaultfalse	Disables change detection.
debug Typeboolean Defaultfalse	Set this to `true` to enable debug information from the grid and related components. Will result in additional logging being output, but very useful when investigating problems.

Overlays

See Overlays for more information.

overlayLoadingTemplate Typestring	Provide a template for 'loading' overlay.
loadingOverlayComponent Typeany	Provide a custom loading overlay component. See: Loading Overlay Component
loadingOverlayComponentParams Typeany	Customise the parameters provided to the loading overlay component.
suppressLoadingOverlay Typeboolean Defaultfalse	Disables the 'loading' overlay.
overlayNoRowsTemplate Typestring	Provide a template for 'no rows' overlay.
noRowsOverlayComponent Typeany	Provide a custom no rows overlay component. See: No Rows Overlay Component
noRowsOverlayComponentParams Typeany	Customise the parameters provided to the no rows overlay component.
suppressNoRowsOverlay Typeboolean Defaultfalse	Disables the 'no rows' overlay.

Pagination

See Row Pagination for more information.

pagination Typeboolean Defaultfalse	Set whether pagination is enabled.
paginationPageSize Typenumber Default100	How many rows to load per page. If `paginationAutoPageSize` is specified, this property is ignored. See: Customising Pagination
paginationNumberFormatter TypeFunction	Allows user to format the numbers in the pagination panel, i.e. 'row count' and 'page number' labels. This is for pagination panel only, to format numbers inside the grid's cells (i.e. your data), then use `valueFormatter` in the column definitions.
paginationAutoPageSize Typeboolean Defaultfalse	Set to `true` so that the number of rows to load per page is automatically adjusted by the grid so each page shows enough rows to just fill the area designated for the grid. If `false`, `paginationPageSize` is used. See: Auto Page Size
paginateChildRows Typeboolean Defaultfalse	Set to `true` to have pages split children of groups when using Row Grouping or detail rows with Master Detail. See: Pagination & Child Rows
suppressPaginationPanel Typeboolean Defaultfalse	If `true`, the default grid controls for navigation are hidden. This is useful if `pagination=true` and you want to provide your own pagination controls. Otherwise, when `pagination=true` the grid automatically shows the necessary controls at the bottom so that the user can navigate through the different pages. See: Custom Pagination Controls

Pivot and Aggregation

See Pivot and Aggregation for more information

pivotMode Typeboolean Defaultfalse	Set to `true` to enable pivot mode.
pivotPanelShow Type'always' \| 'onlyWhenPivoting' \| 'never' Defaultnever	When to show the 'pivot panel' (where you drag rows to pivot) at the top. Note that the pivot panel will never show if `pivotMode` is off.
pivotDefaultExpanded Typenumber Default0	If pivoting, set to the number of column group levels to expand by default, e.g. `0` for none, `1` for first level only, etc. Set to `-1` to expand everything. See: Opening Pivot Group Levels by Default
pivotColumnGroupTotals Type'before' \| 'after'	When set and the grid is in pivot mode, automatically calculated totals will appear within the Pivot Column Groups, in the position specified. See: Pivot Column Group Totals
pivotRowTotals Type'before' \| 'after'	When set and the grid is in pivot mode, automatically calculated totals will appear for each value column in the position specified. See: Pivot Row Totals
pivotSuppressAutoColumn Typeboolean	If `true`, the grid will not swap in the grouping column when pivoting. Useful if pivoting using Server Side Row Model or Viewport Row Model and you want full control of all columns including the group column.
processPivotResultColDef TypeFunction	Callback to be used with pivoting, to allow changing the second column definition.
processPivotResultColGroupDef TypeFunction	Callback to be used with pivoting, to allow changing the second column group definition.
suppressExpandablePivotGroups Typeboolean Defaultfalse	When enabled, pivot column groups will appear 'fixed', without the ability to expand and collapse the column groups. See: Fixed Pivot Column Groups
functionsReadOnly Typeboolean Defaultfalse	If `true`, then row group, pivot and value aggregation will be read-only from the GUI. The grid will display what values are used for each, but will not allow the user to change the selection. See: Read Only Functions
aggFuncs Type{ [key: string]: IAggFunc; }	A map of 'function name' to 'function' for custom aggregation functions. See: Custom Aggregation Functions
getGroupRowAgg TypeFunction	Callback to use when you need access to more then the current column for aggregation. See: Custom Full Row Aggregation
suppressAggFuncInHeader Typeboolean Defaultfalse	When `true`, column headers won't include the `aggFunc` name, e.g. `'sum(Bank Balance)`' will just be `'Bank Balance'`.
alwaysAggregateAtRootLevel Typeboolean Defaultfalse	When using aggregations, the grid will always calculate the root level aggregation value.
aggregateOnlyChangedColumns Typeboolean Defaultfalse	When using change detection, only the updated column will be re-aggregated. See: Change Detection
suppressAggFilteredOnly Typeboolean Defaultfalse	Set to `true` so that aggregations are not impacted by filtering. See: Custom Aggregation Functions
groupAggFiltering Typeboolean \| IsRowFilterable Defaultfalse	Set to determine whether filters should be applied on aggregated group values.
removePivotHeaderRowWhenSingleValueColumn Typeboolean Defaultfalse	Set to `true` to omit the value Column header when there is only a single value column. See: Hiding Repeated Value Column Labels

Rendering

animateRows Typeboolean Defaultfalse	Set to `true` to enable Row Animation. See: Row Animation
enableCellChangeFlash Typeboolean Defaultfalse	Set to `true` to have cells flash after data changes. See: Flashing Data Changes
cellFlashDelay Typenumber Default500	To be used in combination with `enableCellChangeFlash`, this configuration will set the delay in milliseconds of how long a cell should remain in its "flashed" state.
cellFadeDelay Typenumber Default1000	To be used in combination with `enableCellChangeFlash`, this configuration will set the delay in milliseconds of how long the "flashed" state animation takes to fade away after the timer set by `cellFlashDelay` has completed.
allowShowChangeAfterFilter Typeboolean Defaultfalse	Set to `true` to have cells flash after data changes even when the change is due to filtering. See: Flashing Data Changes
domLayout TypeDomLayoutType Defaultnormal	Switch between layout options. See Printing and Auto Height.
ensureDomOrder Typeboolean Defaultfalse	When `true`, the order of rows and columns in the DOM are consistent with what is on screen. See: Accessibility - Row and Column Order
getBusinessKeyForNode TypeFunction	Return a business key for the node. If implemented, each row in the DOM will have an attribute `row-id='abc'` where `abc` is what you return as the business key. This is useful for automated testing, as it provides a way for your tool to identify rows based on unique business keys.
gridId Typestring	Provide a custom `gridId` for this instance of the grid. Value will be set on the root DOM node using the attribute `grid-id` as well as being accessible via the `gridApi.getGridId()` method.
processRowPostCreate TypeFunction	Allows you to process rows after they are created, so you can do final adding of custom attributes etc.
enableRtl Typeboolean Defaultfalse	Set to `true` to operate the grid in RTL (Right to Left) mode. See: RTL (Right to Left)
suppressColumnVirtualisation Typeboolean Defaultfalse	Set to `true` so that the grid doesn't virtualise the columns. For example, if you have 100 columns, but only 10 visible due to scrolling, all 100 will always be rendered.
suppressRowVirtualisation Typeboolean Defaultfalse	Set to `true` so that the grid doesn't virtualise the rows. For example, if you have 100 rows, but only 10 visible due to scrolling, all 100 will always be rendered. See: Suppress Row Virtualisation
suppressMaxRenderedRowRestriction Typeboolean Defaultfalse	By default the grid has a limit of rendering a maximum of 500 rows at once (remember the grid only renders rows you can see, so unless your display shows more than 500 rows without vertically scrolling this will never be an issue). This is only relevant if you are manually setting `rowBuffer` to a high value (rendering more rows than can be seen), or `suppressRowVirtualisation` is true, or if your grid height is able to display more than 500 rows at once.

Row Drag and Drop

See Row Dragging for more information.

rowDragManaged Typeboolean Defaultfalse	Set to `true` to enable Managed Row Dragging. See: Managed Row Dragging
rowDragEntireRow Typeboolean Defaultfalse	Set to `true` to enable clicking and dragging anywhere on the row without the need for a drag handle. See: Entire Row Dragging
rowDragMultiRow Typeboolean Defaultfalse	Set to `true` to enable dragging multiple rows at the same time. See: Mulit-Row Dragging
suppressRowDrag Typeboolean Defaultfalse	Set to `true` to suppress row dragging.
suppressMoveWhenRowDragging Typeboolean Defaultfalse	Set to `true` to suppress moving rows while dragging the `rowDrag` waffle. This option highlights the position where the row will be placed and it will only move the row on mouse up.
rowDragText TypeFunction	A callback that should return a string to be displayed by the `rowDragComp` while dragging a row. If this callback is not set, the current cell value will be used. If the `rowDragText` callback is set in the ColDef it will take precedence over this, except when `rowDragEntireRow=true`. See: Custom Row Drag Text

Row Full Width

See Full Width Rows for more information.

fullWidthCellRenderer Typeany	Provide your own cell renderer component to use for full width rows. See: Full Width Cell Renderer
fullWidthCellRendererParams Typeany	Customise the parameters provided to the `fullWidthCellRenderer` component.

Row Grouping

See Row Grouping for more information.

groupDisplayType TypeRowGroupingDisplayType	Specifies how the results of row grouping should be displayed. The options are: `'singleColumn'`: single group column automatically added by the grid. `'multipleColumns'`: a group column per row group is added automatically. `'groupRows'`: group rows are automatically added instead of group columns. `'custom'`: informs the grid that group columns will be provided. See: Row Grouping - Display Types
groupDefaultExpanded Typenumber Default0	If grouping, set to the number of levels to expand by default, e.g. `0` for none, `1` for first level only, etc. Set to `-1` to expand everything. See: Opening Group Levels by Default
autoGroupColumnDef TypeColDef	Allows specifying the group 'auto column' if you are not happy with the default. If grouping, this column definition is included as the first column in the grid. If not grouping, this column is not included. See: Group Column Configuration
groupMaintainOrder Typeboolean Defaultfalse	When `true`, preserves the current group order when sorting on non-group columns. See: Maintain Group Order
groupSelectsChildren Typeboolean Defaultfalse	When `true`, if you select a group, the children of the group will also be selected. See: Group Selection
groupIncludeFooter Typeboolean \| UseGroupFooter Defaultfalse	If grouping, this controls whether to show a group footer when the group is expanded. If `true`, then by default, the footer will contain aggregate data (if any) when shown and the header will be blank. When closed, the header will contain the aggregate data regardless of this setting (as the footer is hidden anyway). This is handy for 'total' rows, that are displayed below the data when the group is open, and alongside the group when it is closed. If a callback function is provided, it can used to select which groups will have a footer added. See: Enabling Group Footers
groupIncludeTotalFooter Typeboolean Defaultfalse	Set to `true` to show a 'grand total' group footer across all groups. See: Enabling Group Footers
groupSuppressBlankHeader Typeboolean Defaultfalse	If `true`, and showing footer, aggregate data will always be displayed at both the header and footer levels. This stops the possibly undesirable behaviour of the header details 'jumping' to the footer on expand.
groupSelectsFiltered Typeboolean Defaultfalse	If using `groupSelectsChildren`, then only the children that pass the current filter will get selected. See: Group Selection
showOpenedGroup Typeboolean Defaultfalse	Shows the open group in the group column for non-group rows. See: Showing Open Groups
isGroupOpenByDefault TypeFunction	(Client-side Row Model only) Allows groups to be open by default.
initialGroupOrderComparator TypeFunction	Allows default sorting of groups. See: Initial Group Order
groupRemoveSingleChildren Typeboolean	Set to `true` to collapse groups that only have one child. See: Remove Single Children
groupRemoveLowestSingleChildren Typeboolean Defaultfalse	Set to `true` to collapse lowest level groups that only have one child. See: Remove Single Children
groupHideOpenParents Typeboolean Defaultfalse	Set to `true` to hide parents that are open. When used with multiple columns for showing groups, it can give a more pleasing user experience. See: Hide Open Parents
groupAllowUnbalanced Typeboolean Defaultfalse	Set to `true` to prevent the grid from creating a '(Blanks)' group for nodes which do not belong to a group, and display the unbalanced nodes alongside group nodes. See: Enabling Unbalanced Groups
rowGroupPanelShow Type'always' \| 'onlyWhenGrouping' \| 'never' Defaultnever	When to show the 'row group panel' (where you drag rows to group) at the top. See: Enabling Row Group Panel
rowGroupPanelSuppressSort Typeboolean Defaultfalse	Set to `true` to suppress sort indicators and actions from the row group panel. See: Suppress Sorting
groupRowRenderer Typeany	Provide the Cell Renderer to use when `groupDisplayType = 'groupRows'`. See: Group Row Cell Renderer
groupRowRendererParams Typeany	Customise the parameters provided to the `groupRowRenderer` component.
suppressDragLeaveHidesColumns Typeboolean Defaultfalse	By default, dragging a column out of the grid, i.e. to the Row Group Panel, it will be hidden in the grid. This property prevents the column becoming hidden in the grid. See: Keeping Columns Visible
suppressGroupRowsSticky Typeboolean Defaultfalse	Set to `true` prevent Group Rows from sticking to the top of the grid.
suppressRowGroupHidesColumns Typeboolean Defaultfalse	If `true`, when you drag a column into a row group panel the column is not hidden. See: Keeping Columns Visible
suppressMakeColumnVisibleAfterUnGroup Typeboolean Defaultfalse	By default, when a column is un-grouped, i.e. using the Row Group Panel, it is made visible in the grid. This property stops the column becoming visible again when un-grouping. See: Keeping Columns Visible
treeData Typeboolean	Set to `true` to enable the Grid to work with Tree Data. You must also implement the `getDataPath(data)` callback. See: Tree Data
getDataPath TypeGetDataPath	Callback to be used when working with Tree Data when `treeData = true`. See: Tree Data

Row Pinning

Row data uses the generic type TData if provided via GridOptions<TData>. Otherwise TData will default to any.

See Row Pinning for more information.

pinnedTopRowData Typeany[]	Data to be displayed as pinned top rows in the grid.
pinnedBottomRowData Typeany[]	Data to be displayed as pinned bottom rows in the grid.

RowModel

See Row Model for more information.

rowModelType TypeRowModelType DefaultclientSide	Sets the row model type.
getRowId TypeGetRowIdFunc	Allows setting the ID for a particular row node based on the data.

RowModel: Client-Side

Row data uses the generic type TData if provided via GridOptions<TData>. Otherwise TData will default to any.

See Client-Side Row Model for more information.

rowData TypeTData[] \| null	Set the data to be displayed as rows in the grid.
resetRowDataOnUpdate Typeboolean Defaultfalse	When enabled, getRowId() callback is implemented and new Row Data is set, the grid will disregard all previous rows and treat the new Row Data as new data. As a consequence, all Row State (eg selection, rendered rows) will be reset.
asyncTransactionWaitMillis Typenumber	How many milliseconds to wait before executing a batch of async transactions. See: Async transactions
suppressModelUpdateAfterUpdateTransaction Typeboolean Defaultfalse	Prevents Transactions changing sort, filter, group or pivot state when transaction only contains updates. See: Suppress Model Updates

RowModel: Infinite

See Infinite Row Model for more information.

datasource TypeIDatasource	Provide the datasource for infinite scrolling. See: Datasource
cacheOverflowSize Typenumber Default1	How many extra blank rows to display to the user at the end of the dataset, which sets the vertical scroll and then allows the grid to request viewing more rows of data.
maxConcurrentDatasourceRequests Typenumber Default2	How many requests to hit the server with concurrently. If the max is reached, requests are queued. Set to `-1` for no maximum restriction on requests.
cacheBlockSize Typenumber Default100	How many rows for each block in the store, i.e. how many rows returned from the server at a time.
maxBlocksInCache Typenumber	How many blocks to keep in the store. Default is no limit, so every requested block is kept. Use this if you have memory concerns, and blocks that were least recently viewed will be purged when the limit is hit. The grid will additionally make sure it has all the blocks needed to display what is currently visible, in case this property is set to a low value.
infiniteInitialRowCount Typenumber Default1	How many extra blank rows to display to the user at the end of the dataset, which sets the vertical scroll and then allows the grid to request viewing more rows of data.

RowModel: Server-Side

See Server-Side Row Model for more information.

serverSideDatasource TypeIServerSideDatasource	Provide the `serverSideDatasource` for server side row model. See: Registering the Datasource
cacheBlockSize Typenumber Default100	How many rows for each block in the cache, i.e. how many rows returned from the server at a time.
maxBlocksInCache Typenumber	How many blocks to keep in the cache. Default is no limit, so every requested block is kept. Use this if you have memory concerns, and blocks that were least recently viewed will be purged when the limit is hit. The grid will additionally make sure it has all the blocks needed to display what is currently visible, in case this property is set to a low value.
maxConcurrentDatasourceRequests Typenumber Default2	How many requests to hit the server with concurrently. If the max is reached, requests are queued. Set to `-1` for no maximum restriction on requests.
blockLoadDebounceMillis Typenumber	How many milliseconds to wait before loading a block. Useful when scrolling over many blocks, as it prevents blocks loading until scrolling has settled. See: Block Loading Debounce
purgeClosedRowNodes Typeboolean Defaultfalse	When enabled, closing group rows will remove children of that row. Next time the row is opened, child rows will be read from the datasource again. This property only applies when there is Row Grouping.
serverSidePivotResultFieldSeparator Typestring Default_	Used to split pivot field strings for generating pivot result columns when `pivotResultFields` is provided as part of a `getRows` success. See: Supplying Pivot Result Fields
serverSideSortAllLevels Typeboolean Defaultfalse	When enabled, always refreshes top level groups regardless of which column was sorted. This property only applies when there is Row Grouping & sorting is handled on the server.
serverSideOnlyRefreshFilteredGroups Typeboolean Defaultfalse	When enabled, only refresh groups directly impacted by a filter. This property only applies when there is Row Grouping & filtering is handled on the server.
serverSideInitialRowCount Typenumber Default1	Set how many loading rows to display to the user for the root level group. See: Initial Scroll Position
suppressServerSideInfiniteScroll Typeboolean Defaultfalse	When `true`, the Server-side Row Model will suppress Infinite Scrolling and load all the data at the current level.
serverSideSortOnServer Typeboolean Defaultfalse	When enabled, Sorting will be done on the server. Only applicable when `suppressServerSideInfiniteScroll=true`.
serverSideFilterOnServer Typeboolean Defaultfalse	When enabled, Filtering will be done on the server. Only applicable when `suppressServerSideInfiniteScroll=true`.
getChildCount TypeFunction	Allows setting the child count for a group row.
getServerSideGroupLevelParams TypeFunction	Allows providing different params for different levels of grouping.
isServerSideGroupOpenByDefault TypeFunction	Allows groups to be open by default.
isApplyServerSideTransaction TypeFunction	Allows cancelling transactions.
isServerSideGroup TypeFunction	SSRM Tree Data: Allows specifying which rows are expandable. See: SSRM Tree Data
getServerSideGroupKey TypeFunction	SSRM Tree Data: Allows specifying group keys. See: SSRM Tree Data

RowModel: Viewport

See Viewport Row Model for more information.

viewportDatasource TypeIViewportDatasource	To use the viewport row model you need to provide the grid with a `viewportDatasource`.
viewportRowModelPageSize Typenumber	When using viewport row model, sets the page size for the viewport.
viewportRowModelBufferSize Typenumber	When using viewport row model, sets the buffer size for the viewport.

Scrolling

See Scrolling for more information.

alwaysShowHorizontalScroll Typeboolean Defaultfalse	Set to `true` to always show the horizontal scrollbar.
alwaysShowVerticalScroll Typeboolean Defaultfalse	Set to `true` to always show the vertical scrollbar.
debounceVerticalScrollbar Typeboolean Defaultfalse	Set to `true` to debounce the vertical scrollbar. Can provide smoother scrolling on slow machines. See: Debounce Vertical Scroll
suppressHorizontalScroll Typeboolean Defaultfalse	Set to `true` to never show the horizontal scroll. This is useful if the grid is aligned with another grid and will scroll when the other grid scrolls. (Should not be used in combination with `alwaysShowHorizontalScroll`.) See: Aligned Grid as Footer
suppressScrollOnNewData Typeboolean Defaultfalse	When `true`, the grid will not scroll to the top when new row data is provided. Use this if you don't want the default behaviour of scrolling to the top every time you load new data.
suppressScrollWhenPopupsAreOpen Typeboolean Defaultfalse	When `true`, the grid will not allow mousewheel / touchpad scroll when popup elements are present.
suppressAnimationFrame Typeboolean Defaultfalse	When `true`, the grid will not use animation frames when drawing rows while scrolling. Use this if the grid is working fast enough that you don't need animation frames and you don't want the grid to flicker.
suppressMiddleClickScrolls Typeboolean Defaultfalse	If `true`, middle clicks will result in `click` events for cells and rows. Otherwise the browser will use middle click to scroll the grid. Note: Not all browsers fire `click` events with the middle button. Most will fire only `mousedown` and `mouseup` events, which can be used to focus a cell, but will not work to call the `onCellClicked` function.
suppressPreventDefaultOnMouseWheel Typeboolean Defaultfalse	If `true`, mouse wheel events will be passed to the browser. Useful if your grid has no vertical scrolls and you want the mouse to scroll the browser page.
scrollbarWidth Typenumber	Tell the grid how wide in pixels the scrollbar is, which is used in grid width calculations. Set only if using non-standard browser-provided scrollbars, so the grid can use the non-standard size in its calculations.

Selection

See Selection Overview for more information.

rowSelection Type'single' \| 'multiple'	Type of Row Selection. See: Row Selection
rowMultiSelectWithClick Typeboolean Defaultfalse	Set to `true` to allow multiple rows to be selected using single click. See: Multi Select Single Click
isRowSelectable TypeIsRowSelectable	Callback to be used to determine which rows are selectable. By default rows are selectable, so return `false` to make a row un-selectable. See: Specify Selectable Rows
suppressRowDeselection Typeboolean Defaultfalse	If `true`, rows will not be deselected if you hold down `Ctrl` and click the row or press `Space`.
suppressRowClickSelection Typeboolean Defaultfalse	If `true`, row selection won't happen when rows are clicked. Use when you only want checkbox selection.
suppressCellFocus Typeboolean Defaultfalse	If `true`, cells won't be focusable. This means keyboard navigation will be disabled for grid cells, but remain enabled in other elements of the grid such as column headers, floating filters, tool panels.
suppressMultiRangeSelection Typeboolean Defaultfalse	If `true`, only a single range can be selected. See: Suppress Multi Range Selection
enableCellTextSelection Typeboolean Defaultfalse	Set to `true` to be able to select the text within cells. Note: When this is set to `true`, the clipboard service is disabled.
enableRangeSelection Typeboolean Defaultfalse	Set to `true` to enable Range Selection. See: Range Selection
enableRangeHandle Typeboolean Defaultfalse	Set to `true` to enable the Range Handle. See: Range Handle
enableFillHandle Typeboolean Defaultfalse	Set to `true` to enable the Fill Handle. See: Fill Handle
fillHandleDirection Type'x' \| 'y' \| 'xy' Defaultxy	Set to `'x'` to force the fill handle direction to horizontal, or set to `'y'` to force the fill handle direction to vertical.
fillOperation TypeFunction	Callback to fill values instead of simply copying values or increasing number values using linear progression.
suppressClearOnFillReduction Typeboolean Defaultfalse	Set this to `true` to prevent cell values from being cleared when the Range Selection is reduced by the Fill Handle.

Sorting

See Row Sorting for more information.

sortingOrder Type(SortDirection)[] Default[null, 'asc', 'desc']	Array defining the order in which sorting occurs (if sorting is enabled). Values can be `'asc'`, `'desc'` or `null`. For example: `sortingOrder: ['asc', 'desc']`. See: Example Sorting Order and Animation
accentedSort Typeboolean Defaultfalse	Set to `true` to specify that the sort should take accented characters into account. If this feature is turned on the sort will be slower. See: Accented Sort
unSortIcon Typeboolean Defaultfalse	Set to `true` to show the 'no sort' icon. See: Example Custom Sorting
suppressMultiSort Typeboolean Defaultfalse	Set to `true` to suppress multi-sort when the user shift-clicks a column header.
alwaysMultiSort Typeboolean Defaultfalse	Set to `true` to always multi-sort when the user clicks a column header, regardless of key presses.
multiSortKey Type'ctrl'	Set to `'ctrl'` to have multi sorting work using the `Ctrl` (or `Command ⌘` for Mac) key. See: Multi Column Sorting
suppressMaintainUnsortedOrder Typeboolean Defaultfalse	Set to `true` to suppress sorting of un-sorted data to match original row data.
postSortRows TypeFunction	Callback to perform additional sorting after the grid has sorted the rows. When used with SSRM, only applicable when `suppressServerSideInfiniteScroll=true` See: Post Sort
deltaSort Typeboolean Defaultfalse	When enabled, sorts only the rows added/updated by a transaction. See: Delta sorting

Styling

icons Type{ [key: string]: Function \| string; }	Icons to use inside the grid instead of the grid's default icons. See: Custom Icons
rowHeight Typenumber Default25	Default row height in pixels. See: Row Height
getRowHeight TypeFunction	Callback version of property `rowHeight` to set height for each row individually. Function should return a positive number of pixels, or return `null`/`undefined` to use the default row height. See: Row Height
rowStyle TypeRowStyle	The style properties to apply to all rows. Set to an object of key (style names) and values (style values) See: Row Style
getRowStyle TypeFunction	Callback version of property `rowStyle` to set style for each row individually. Function should return an object of CSS values or undefined for no styles. See: Row Style
rowClass Typestring \| string[]	CSS class(es) for all rows. Provide either a string (class name) or array of strings (array of class names). See: Row Class
getRowClass TypeFunction	Callback version of property `rowClass` to set class(es) for each row individually. Function should return either a string (class name), array of strings (array of class names) or undefined for no class. See: Row Class
rowClassRules TypeRowClassRules	Rules which can be applied to include certain CSS classes. See: Row Class Rules
isFullWidthRow TypeFunction	Tells the grid if this row should be rendered as full width. See: Full Width Rows
suppressRowHoverHighlight Typeboolean Defaultfalse	Set to `true` to not highlight rows by adding the `ag-row-hover` CSS class.
suppressRowTransform Typeboolean Defaultfalse	Uses CSS `top` instead of CSS `transform` for positioning rows. Useful if the transform function is causing issues such as used in row spanning.
columnHoverHighlight Typeboolean Defaultfalse	Set to `true` to highlight columns by adding the `ag-column-hover` CSS class.

Tooltips

See Tooltip Component for more information.

enableBrowserTooltips Typeboolean Defaultfalse	Set to `true` to use the browser's default tooltip instead of using the grid's Tooltip Component.
tooltipShowDelay Typenumber Default2000	The delay in milliseconds that it takes for tooltips to show up once an element is hovered over. Note: This property does not work if `enableBrowserTooltips` is `true`.
tooltipHideDelay Typenumber Default10000	The delay in milliseconds that it takes for tooltips to hide once they have been displayed. Note: This property does not work if `enableBrowserTooltips` is `true` and `tooltipHideTriggers` includes `timeout`.
tooltipMouseTrack Typeboolean Defaultfalse	Set to `true` to have tooltips follow the cursor once they are displayed.
tooltipTrigger Type'hover' \| 'focus'	The trigger that will cause tooltips to show and hide. `hover` - The tooltip will show/hide when a cell/header is hovered. `focus` - The tooltip will show/hide when a cell/header is focused. Default: 'hover'
tooltipInteraction Typeboolean Defaultfalse	Set to `true` to enable tooltip interaction. When this option is enabled, the tooltip will not hide while the tooltip itself it being hovered or has focus.

Accessories

statusBar

sideBar

getContextMenuItems

suppressContextMenu

preventDefaultOnContextMenu

allowContextMenuWithControlKey

getMainMenuItems

suppressMenuHide

popupParent

postProcessPopup

Clipboard

copyHeadersToClipboard

copyGroupHeadersToClipboard

clipboardDelimiter

suppressCutToClipboard

suppressCopyRowsToClipboard

suppressCopySingleCellRanges

suppressLastEmptyLineOnPaste

suppressClipboardPaste

suppressClipboardApi

processCellForClipboard

processHeaderForClipboard

processGroupHeaderForClipboard

processCellFromClipboard

sendToClipboard

processDataFromClipboard

Column Definitions

columnDefs

defaultColDef

defaultColGroupDef

columnTypes

dataTypeDefinitions

maintainColumnOrder

suppressFieldDotNotation

Column Headers

headerHeight

groupHeaderHeight

floatingFiltersHeight

pivotHeaderHeight

pivotGroupHeaderHeight

Column Moving

allowDragFromColumnsToolPanel

suppressMovableColumns

suppressColumnMoveAnimation

suppressDragLeaveHidesColumns

suppressRowGroupHidesColumns

Column Sizing

colResizeDefault

suppressAutoSize

autoSizePadding

skipHeaderOnAutoSize

Components

components

Editing

editType

singleClickEdit

suppressClickEdit

stopEditingWhenCellsLoseFocus

enterNavigatesVertically

enterNavigatesVerticallyAfterEdit

enableCellEditingOnBackspace

undoRedoCellEditing

undoRedoCellEditingLimit

readOnlyEdit

Export

defaultCsvExportParams

suppressCsvExport

defaultExcelExportParams

suppressExcelExport

excelStyles

Filtering

quickFilterText

cacheQuickFilter

includeHiddenColumnsInQuickFilter

quickFilterParser

quickFilterMatcher

isExternalFilterPresent

doesExternalFilterPass

excludeChildrenWhenTreeDataFiltering