Implements the GridOptions<TData> interface.
The grid will respond to property updates unless they are marked as Initial. See Updating Grid Options.
Accessories
Specifies the status bar components to use in the status bar. |
Specifies the side bar components. |
For customising the context menu. |
Set to true to not show the context menu. Use if you don't want to use the default 'right click' context menu. |
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. |
Allows context menu to show, even when ^ Ctrl key is held down. Default: false |
For customising the main 'column header' menu. |
Changes the display type of the column menu.
'new' just displays the main list of menu items. 'legacy' displays a tabbed menu. |
Only recommended for use if columnMenu = 'legacy'.
When true, the column menu button will always be shown.
When false, the column menu button will only show when the mouse is over the column header.
When using columnMenu = 'legacy', this will default to false instead of true. |
DOM element to use as the popup parent for grid popups (context menu, column menu etc). |
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.
Set to true to also include headers when copying to clipboard using ^ Ctrl+C clipboard. Default: false |
Set to true to also include group headers when copying to clipboard using ^ Ctrl+C clipboard. Default: false |
Specify the delimiter to use when copying to clipboard. |
Set to true to block cut operations within the grid. |
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. |
Set to true to turn off paste operations within the grid. |
Set to true to stop the grid trying to use the Clipboard API, if it is blocked, and immediately fallback to the workaround. |
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. |
Allows you to process header values for the clipboard. |
Allows you to process group header values for the clipboard. |
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. |
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. |
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
Array of Column / Column Group definitions. |
A default column definition. Items defined in the actual column definitions get precedence. |
A default column group definition. All column group definitions will use these properties. Items defined in the actual column group definition get precedence. |
An object map of custom column types which contain groups of properties that column definitions can reuse by referencing in their type property. |
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. |
Keeps the order of Columns maintained after new Column Definitions are updated. |
Resets pivot column order when impacted by filters, data or configuration changes |
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. |
Column Headers
See Column Headers for more information.
The height in pixels for the row containing the column label header. If not specified, it uses the theme value of header-height. |
The height in pixels for the rows containing header column groups. If not specified, it uses headerHeight. |
The height in pixels for the row containing the floating filters. If not specified, it uses the theme value of header-height. |
The height in pixels for the row containing the columns when in pivot mode. If not specified, it uses headerHeight. |
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.
Allow reordering and pinning columns by dragging columns from the Columns Tool Panel to the grid. |
Set to true to suppress column moving, i.e. to make the columns fixed position. |
Set to true to suppress moving columns while dragging the Column Header. This option highlights the position where the column will be placed and it will only move it on mouse up. |
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. Default: false |
If true, when you drag a column out of the grid (e.g. to the group zone) the column is not hidden. |
Column Pinning
See Column Pinning for more information.
Allows the user to process the columns being removed from the pinned section because the viewport is too small to accommodate them.
Returns an array of columns to be removed from the pinned areas. |
Column Sizing
See Column Sizing for more information.
Set to 'shift' to have shift-resize as the default resize operation (same as user holding down ⇧ Shift while resizing). |
Auto-size the columns when the grid is loaded. Can size to fit the grid width, fit a provided width, or fit the cell contents. |
Suppresses auto-sizing columns for columns. In other words, double clicking a column's header's edge will not auto-size. |
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. |
Set this to true to skip the headerName when autoSize is called by default. |
Editing
See Cell Editing for more information.
Set to 'fullRow' to enable Full Row Editing. Otherwise leave blank to edit one cell at a time. |
Set to true to enable Single Click Editing for cells, to start editing with a single click. |
Set to true so that neither single nor double click starts editing. |
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. |
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. Default: false |
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. Default: false |
Forces Cell Editing to start when backspace is pressed. This is only relevant for MacOS users. |
Set to true to enable Undo / Redo while editing. |
Set the size of the undo / redo stack. |
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. |
Export
See Export for more information.
A default configuration object used to export to CSV. |
Prevents the user from exporting the grid to CSV. |
A default configuration object used to export to Excel. |
Prevents the user from exporting the grid to Excel. |
A list (array) of Excel styles to be used when exporting to Excel with styles. |
Filtering
See Filtering for more information.
Rows are filtered using this text as a Quick Filter.
Only supported for Client-Side Row Model. |
Set to true to turn on the Quick Filter cache, used to improve performance when using the Quick Filter. |
Hidden columns are excluded from the Quick Filter by default.
To include hidden columns, set to true. |
Changes how the Quick Filter splits the Quick Filter text into search terms. |
Changes the matching logic for whether a row passes the Quick Filter. |
When pivoting, Quick Filter is only applied on the pivoted data
(or aggregated data if groupAggFiltering = true).
Set to true to apply Quick Filter before pivoting (/aggregating) instead. |
Grid calls this method to know if an external filter is present. |
Should return true if external filter passes, otherwise false. |
Set to true to override the default tree data filtering behaviour to instead exclude child nodes from filter results. |
When using AG Grid Enterprise, the Set Filter is used by default when filter: true is set on column definitions.
Set to true to prevent this and instead use the Text Filter, Number Filter or Date Filter based on the cell data type,
the same as when using AG Grid Community. |
Set to true to enable the Advanced Filter. |
Hidden columns are excluded from the Advanced Filter by default.
To include hidden columns, set to true. |
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. |
Customise the parameters passed to the Advanced Filter Builder. |
Allows rows to always be displayed, even if they don't match the applied filtering.
Return true for the provided row to always be displayed.
Only works with the Client-Side Row Model. |
Integrated Charts
See Integrated Charts for more information.
Set to true to Enable Charts. |
Callback to be used to customise the chart toolbar items. |
Callback to enable displaying the chart in an alternative chart container. |
The list of chart themes that a user can choose from in the chart panel. |
A map containing custom chart themes. |
Chart theme overrides applied to all themes. |
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 chart panel. |
Get chart menu items. Only applies when using AG Charts Enterprise. |
Keyboard Navigation
See Keyboard Navigation for more information.
Allows overriding the element that will be focused when the grid receives focus from outside elements (tabbing into the grid).
Returns: True if this function should override the grid's default behavior, False to allow the grid's default behavior. |
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. |
Allows overriding the default behaviour for when user hits Tab key when a header is focused.
Return the next header position to navigate to, true to stay on the current header,
or false to let the browser handle the tab behaviour. |
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. |
Allows overriding the default behaviour for when user hits Tab key when a cell is focused.
Return the next cell position to navigate to, true to stay on the current cell,
or false to let the browser handle the tab behaviour. |
Loading Cell Renderers
See loadingCellRenderer for more information.
Provide your own loading cell renderer to use when data is loading via a DataSource. |
Params to be passed to the loadingCellRenderer component. |
Callback to select which loading cell renderer to be used when data is loading via a DataSource. |
Localisation
See Localisation for more information.
A map of key->value pairs for localising text within the grid. |
A callback for localising text within the grid. |
Master Detail
See Master Detail for more information.
Set to true to enable Master Detail. |
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. |
Provide a custom detailCellRenderer to use when a master row is expanded. |
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. |
Set fixed height in pixels for each detail row. |
Set to true to have the detail grid dynamically change it's height to fit it's rows. |
Set to true to have the Full Width Rows embedded in grid's main container so they can be scrolled horizontally. |
Set to true to keep detail rows for when they are displayed again. |
Sets the number of details rows to keep. |
Miscellaneous
Initial state for the grid. Only read once on initialization. Can be used in conjunction with api.getState() to save and restore grid state. |
A list of grids to treat as Aligned Grids.
Provide a list if the grids / apis already exist or return via a callback to allow the aligned grids to be retrieved asynchronously.
If grids are aligned then the columns and horizontal scrolling will be kept in sync. |
Provides a context object that is provided to different callbacks the grid uses. Used for passing additional information to the callbacks used by your application. |
Change this value to set the tabIndex order of the Grid within your application. |
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. |
Configure the Row Numbers Feature. |
Text to find within the grid. |
Options for the Find feature. |
Set to true to turn on the value cache. |
Set to true to configure the value cache to not expire after data updates. |
Set to true to allow cell expressions. |
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) |
Disables touch support (but does not remove the browser's efforts to simulate mouse events on touch). |
Provide a custom drag and drop image component. |
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. |
Disables change detection. |
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.
Show or hide the loading overlay. |
Provide a HTML string to override the default loading overlay. Supports non-empty plain text or HTML with a single root element. |
Provide a custom loading overlay component. |
Customise the parameters provided to the loading overlay component. |
Set to true to prevent the no-rows overlay being shown when there is no row data. |
Provide a HTML string to override the default no-rows overlay. Supports non-empty plain text or HTML with a single root element. |
Provide a custom no rows overlay component. |
Customise the parameters provided to the no-rows overlay component. |
Pagination
See Row Pagination for more information.
Set whether pagination is enabled. |
How many rows to load per page. If paginationAutoPageSize is specified, this property is ignored. |
Determines if the page size selector is shown in the pagination panel or not.
Set to an array of values to show the page size selector with custom list of possible page sizes.
Set to true to show the page size selector with the default page sizes [20, 50, 100].
Set to false to hide the page size selector. |
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. |
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. |
Set to true to have pages split children of groups when using Row Grouping or detail rows with Master Detail. |
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. |
Rendering
Set to false to disable Row Animation which is enabled by default. |
Sets the duration in milliseconds of how long a cell should remain in its "flashed" state.
If 0, the cell will not flash. |
Sets the duration in milliseconds of how long the "flashed" state animation takes to fade away after the timer set by cellFlashDuration has completed. |
Set to true to have cells flash after data changes even when the change is due to filtering. |
When true, the order of rows and columns in the DOM are consistent with what is on screen.
Disables row animations. |
Return a business key for the node. If implemented, each row in the DOM will have an attribute row-business-key='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. |
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. |
Callback fired after the row is rendered into the DOM. Should not be used to initiate side effects. |
Set to true to operate the grid in RTL (Right to Left) mode. |
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. |
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. |
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. |
When true, enables the cell span feature allowing for the use of the colDef.spanRows property. |
Row Aggregation
See Aggregation for more information
A map of 'function name' to 'function' for custom aggregation functions. |
When provided, an extra row group total row will be inserted into row groups at the specified position, to display
when the group is expanded. This row will contain the aggregate values for the group. If a callback function is
provided, it can be used to selectively determine which groups will have a total row added. |
When provided, an extra grand total row will be inserted into the grid at the specified position.
This row displays the aggregate totals of all rows in the grid. |
When true, column headers won't include the aggFunc name, e.g. 'sum(Bank Balance)' will just be 'Bank Balance'. |
When using change detection, only the updated column will be re-aggregated. |
Set to true so that aggregations are not impacted by filtering. |
Set to determine whether filters should be applied on aggregated group values. |
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. |
Suppress the sticky behaviour of the total rows, can be suppressed individually by passing 'grand' or 'group'. |
When using aggregations, the grid will always calculate the root level aggregation value. |
Callback to use when you need access to more then the current column for aggregation. |
Row Drag and Drop
See Row Dragging for more information.
Set to true to enable Managed Row Dragging. |
Set to true to enable clicking and dragging anywhere on the row without the need for a drag handle. |
Set to true to enable dragging multiple rows at the same time. |
Set to true to suppress row dragging. |
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. |
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. |
Row Full Width
See Full Width Rows for more information.
Provide your own cell renderer component to use for full width rows. |
Customise the parameters provided to the fullWidthCellRenderer component. |
Row Grouping
See Row Grouping for more information.
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. |
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. |
Provide the Cell Renderer to use when groupDisplayType = 'groupRows'. |
Customise the parameters provided to the groupRowRenderer component. |
Shows the open group in the group column for non-group rows. |
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. |
Enable to display the child row in place of the group row when the group only has a single child. |
Allows default sorting of groups. |
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. |
When true, preserves the current group order when sorting on non-group columns. |
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. |
(Client-side Row Model only) Allows groups to be open by default. |
Set to true prevent Group Rows from sticking to the top of the grid. |
When to show the 'row group panel' (where you drag rows to group) at the top. |
Set to true to suppress sort indicators and actions from the row group panel. |
If grouping, locks the group settings of a number of columns, e.g. 0 for no group locking. 1 for first group column locked, -1 for all group columns locked. |
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. Default: false |
Enable to prevent column visibility changing when grouped columns are changed. |
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.
Data to be displayed as pinned top rows in the grid. |
Data to be displayed as pinned bottom rows in the grid. |
Row Pivoting
See Pivot for more information
Set to true to enable pivot mode. |
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. |
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. |
When set and the grid is in pivot mode, automatically calculated totals will appear for each value column in the position specified. |
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. |
The maximum number of generated columns before the grid halts execution. Upon reaching this number, the grid halts generation of columns
and triggers a pivotMaxColumnsExceeded event. -1 for no limit. |
Callback for the mutation of the generated pivot result column definitions |
Callback for the mutation of the generated pivot result column group definitions |
When enabled, pivot column groups will appear 'fixed', without the ability to expand and collapse the column groups. |
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. |
Set to true to omit the value Column header when there is only a single value column. |
RowModel
See Row Model for more information.
Sets the row model type. |
Provide a pure function that returns a string ID to uniquely identify a given row. This enables the grid to work optimally with data changes and updates. |
RowModel: Client-Side
Row data uses the generic type TData if provided via GridOptions<TData>. Otherwise TData will default to any.
Set the data to be displayed as rows in the grid. |
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. |
How many milliseconds to wait before executing a batch of async transactions. |
Prevents Transactions changing sort, filter, group or pivot state when transaction only contains updates. Default: false |
RowModel: Infinite
See Infinite Row Model for more information.
Provide the datasource for infinite scrolling. |
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. |
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. |
How many rows for each block in the store, i.e. how many rows returned from the server at a time. |
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. |
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.
Provide the serverSideDatasource for server side row model. |
How many rows for each block in the cache, i.e. how many rows returned from the server at a time. Default: 100 |
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. |
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. |
How many milliseconds to wait before loading a block. Useful when scrolling over many blocks, as it prevents blocks loading until scrolling has settled. |
When true, the Server-side Row Model will not use a full width loading renderer, instead using the colDef loadingCellRenderer if present. |
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. Default: false |
Used to split pivot field strings for generating pivot result columns when pivotResultFields is provided as part of a getRows success. |
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. |
When enabled, sorts fully loaded groups in the browser instead of requesting from the server. |
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. |
Set how many loading rows to display to the user for the root level group. |
Allows setting the child count for a group row. |
Allows providing different params for different levels of grouping. |
Allows groups to be open by default. |
Allows cancelling transactions. |
SSRM Tree Data: Allows specifying which rows are expandable. |
SSRM Tree Data: Allows specifying group keys. |
RowModel: Viewport
See Viewport Row Model for more information.
To use the viewport row model you need to provide the grid with a viewportDatasource. |
When using viewport row model, sets the page size for the viewport. |
When using viewport row model, sets the buffer size for the viewport. |
Scrolling
Set to true to always show the horizontal scrollbar. Windows and Mac OS both have settings to control scrollbar visibility. Depending on your browser, you may need to adjust the scrollbar settings in your OS to have this property take effect. |
Set to true to always show the vertical scrollbar. Windows and Mac OS both have settings to control scrollbar visibility. Depending on your browser, you may need to adjust the scrollbar settings in your OS to have this property take effect. |
Set to true to debounce the vertical scrollbar. Can provide smoother scrolling on slow machines. |
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.) |
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. |
When true, the grid will not allow mousewheel / touchpad scroll when popup elements are present. |
When true, the grid will not use animation frames when drawing rows while scrolling. Use this if and only if the grid is working fast enough on all users machines and you want to avoid the temporarily empty rows.
Note: It is not recommended to set suppressAnimationFrame to true in most use cases as this can seriously degrade the user experience as all cells are rendered synchronously blocking the UI thread from scrolling. |
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. |
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. |
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
Configure cell selection |
Use the RowSelectionOptions object to configure row selection. The string values 'single' and 'multiple' are deprecated. |
Configure the selection column, used for displaying checkboxes.
Note that due to the nature of this column, this type is a subset of ColDef, which does not support several normal column features such as editing, pivoting and grouping. |
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. |
If true, header cells won't be focusable. This means keyboard navigation will be disabled for grid header cells, but remain enabled in other elements of the grid such as grid cells and tool panels. |
Set to true to be able to select the text within cells.
Note: When this is set to true, the clipboard service is disabled and only selected text is copied. |
Sorting
See Row Sorting for more information.
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. |
Set to true to suppress multi-sort when the user shift-clicks a column header. |
Set to true to always multi-sort when the user clicks a column header, regardless of key presses. |
Set to 'ctrl' to have multi sorting work using the ^ Ctrl (or Command ⌘ for Mac) key. |
Set to true to suppress sorting of un-sorted data to match original row data. |
Callback to perform additional sorting after the grid has sorted the rows. |
When enabled, sorts only the rows added/updated by a transaction. |
Styling
Icons to use inside the grid instead of the grid's default icons. |
Default row height in pixels. |
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. |
The style properties to apply to all rows. Set to an object of key (style names) and values (style values). |
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. |
CSS class(es) for all rows. Provide either a string (class name) or array of strings (array of class names). |
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. |
Rules which can be applied to include certain CSS classes. |
Set to true to not highlight rows by adding the ag-row-hover CSS class. |
Set to true to highlight columns by adding the ag-column-hover CSS class. |
Theme
See Theming for more information.
Theme to apply to the grid, or the string "legacy" to opt back into the
v32 style of theming where themes were imported as CSS files and applied
by setting a class name on the parent element. |
If your theme uses a font that is available on Google Fonts, pass true to load it from Google's CDN. |
An element to insert style elements into when injecting styles into the
grid. If undefined, styles will be added to the document head for grids
rendered in the main document fragment, or to the grid wrapper element
for other grids (e.g. those rendered in a shadow DOM or detached from the
document). |
The CSS layer that this theme should be rendered onto. If your
application loads its styles into a CSS layer, use this to load the grid
styles into a previous layer so that application styles can override grid
styles. |
The nonce attribute to set on style elements added to the document by
themes. If "foo" is passed to this property, the grid can use the Content
Security Policy style-src 'nonce-foo', instead of the less secure
style-src 'unsafe-inline'.
Note: CSP nonces are global to a page, where a page has multiple grids,
every one must have the same styleNonce set. |
Tooltips
See Tooltip Component for more information.
Set to true to use the browser's default tooltip instead of using the grid's Tooltip Component. |
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. |
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. |
Set to true to have tooltips follow the cursor once they are displayed. |
This defines when tooltip will show up for Cells, Headers and SetFilter Items. standard - The tooltip always shows up when the items configured with Tooltips are hovered. whenTruncated - The tooltip will only be displayed when the items hovered have truncated (showing ellipsis) values. This property does not work when enableBrowserTooltips={true}. |
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. |
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. |
Tree Data
Tree Data provides a way to supply the grid with structured hierarchical data.
See Tree Data for more information.
Set to true to enable the Grid to work with Tree Data.
You must also implement the getDataPath(data) callback. |
Callback to be used when working with Tree Data when treeData = true. |
The name of the field to use in a data item to retrieve the array of children nodes of a node when while using treeData=true.
It supports accessing nested fields using the dot notation. |
The name of the field to use in a data item to find the parent node of a node when using treeData=true.
The tree will be constructed via relationships between nodes using this field.
getRowId callback need to be provided as well for this to work.
It supports accessing nested fields using the dot notation. |
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. |
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. |
(Client-side Row Model only) Allows groups to be open by default. |
Set to true prevent Group Rows from sticking to the top of the grid. |
Grid Options
All the above properties can also be specified on a single gridOptions object. If an option is set via gridOptions, as well as directly on the component, then the component value will take precedence. gridOptions is only read during initialisation, if you change it afterwards it will not impact the grid. |