Implements the GridOptions<TData> interface.
The grid will respond to property updates unless they are marked as Initial. See Updating Grid Options.
Accessories
status | Specifies the status bar components to use in the status bar. See: Status Bar |
side | Specifies the side bar components. See: Side Bar |
get | For customising the context menu. See: Context Menu |
suppress | 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 |
prevent | 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. |
allow | Allows context menu to show, even when ^ Ctrl key is held down. Default: falseSee: Context Menu |
get | For customising the main 'column header' menu. This property will only be read on initialisation. See: Column Menu |
column | Changes the display type of the column menu.
'new' just displays the main list of menu items. 'legacy' displays a tabbed menu.This property will only be read on initialisation. See: Column Menu |
suppress | 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.
If columnMenu = 'legacy', this will default to false instead of true.See: Column Menu |
popup | DOM element to use as the popup parent for grid popups (context menu, column menu etc). See: Popup Parent |
post | Allows user to process popups after they are created. Applications can use this if they want to, for example, reposition the popup. See: Post-Process Popup |
Clipboard
See Clipboard for more information.
copy | Set to true to also include headers when copying to clipboard using ^ Ctrl+C clipboard. Default: falseSee: Copying Cell Ranges |
copy | Set to true to also include group headers when copying to clipboard using ^ Ctrl+C clipboard. Default: false |
clipboard | Specify the delimiter to use when copying to clipboard. |
suppress | Set to true to block cut operations within the grid.See: Disabling Cut |
suppress | Set to true to copy the cell range or focused cell to the clipboard and never the selected rows.See: Copying Rows |
suppress | Set to true to copy rows instead of ranges when a range with only a single cell is selected. |
suppress | 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. |
suppress | Set to true to turn off paste operations within the grid.See: Disabling Paste |
suppress | Set to true to stop the grid trying to use the Clipboard API, if it is blocked, and immediately fallback to the workaround. |
process | 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. |
process | Allows you to process header values for the clipboard. |
process | Allows you to process group header values for the clipboard. |
process | 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. |
send | 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. |
process | 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
column | Array of Column / Column Group definitions. See: Column Definitions |
default | A default column definition. Items defined in the actual column definitions get precedence. |
default | A default column group definition. All column group definitions will use these properties. Items defined in the actual column group definition get precedence. This property will only be read on initialisation. |
column | An object map of custom column types which contain groups of properties that column definitions can reuse by referencing in their type property.See: Custom Column Types |
data | 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. |
maintain | Keeps the order of Columns maintained after new Column Definitions are updated. |
suppress | 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.
header | The height in pixels for the row containing the column label header. If not specified, it uses the theme value of header-height.See: Header Height |
group | The height in pixels for the rows containing header column groups. If not specified, it uses headerHeight.See: Header Height |
floating | The height in pixels for the row containing the floating filters. If not specified, it uses the theme value of header-height.See: Header Height |
pivot | The height in pixels for the row containing the columns when in pivot mode. If not specified, it uses headerHeight.See: Header Height |
pivot | The height in pixels for the row containing header column groups when in pivot mode. If not specified, it uses groupHeaderHeight.See: Header Height |
Column Moving
See Column Moving for more information.
allow | Allow reordering and pinning columns by dragging columns from the Columns Tool Panel to the grid. See: Columns Tool Panel |
suppress | Set to true to suppress column moving, i.e. to make the columns fixed position. |
suppress | 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 See: Moving Animation |
suppress | If true, when you drag a column out of the grid (e.g. to the group zone) the column is not hidden.See: Suppress Hide Leave |
suppress | If true, when you drag a column into a row group panel the column is not hidden. |
Column Pinning
See Column Pinning for more information.
Column Sizing
See Column Sizing for more information.
col | Set to 'shift' to have shift-resize as the default resize operation (same as user holding down ⇧ Shift while resizing).See: Shift Resizing |
auto | 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. This property will only be read on initialisation. See: Auto-Sizing Columns |
suppress | Suppresses auto-sizing columns for columns. In other words, double clicking a column's header's edge will not auto-size. This property will only be read on initialisation. |
auto | 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. |
skip | Set this to true to skip the headerName when autoSize is called by default.This property will only be read on initialisation. |
Components
See Components for more information.
components | A map of component names to components. This property will only be read on initialisation. |
Editing
See Cell Editing for more information.
edit | Set to 'fullRow' to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.See: Full Row Editing |
single | Set to true to enable Single Click Editing for cells, to start editing with a single click.See: Single Click Editing |
suppress | Set to true so that neither single nor double click starts editing.See: No Click Editing |
stop | 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.This property will only be read on initialisation. See: Stop cell editing |
enter | 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 See: Enter Key Navigation |
enter | 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 See: Enter Key Navigation |
enable | Forces Cell Editing to start when backspace is pressed. This is only relevant for MacOS users. See: Start Editing |
undo | Set to true to enable Undo / Redo while editing.This property will only be read on initialisation. See: Undo / Redo Edits |
undo | Set the size of the undo / redo stack. This property will only be read on initialisation. See: Enabling Undo / Redo |
read | 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.
default | A default configuration object used to export to CSV. See: CSV Export |
suppress | Prevents the user from exporting the grid to CSV. See: What Gets Exported |
default | A default configuration object used to export to Excel. See: Excel Export |
suppress | Prevents the user from exporting the grid to Excel. See: Excel Export |
excel | A list (array) of Excel styles to be used when exporting to Excel with styles. This property will only be read on initialisation. See: Excel Export Styles |
Filtering
See Filtering for more information.
quick | Rows are filtered using this text as a Quick Filter. See: Quick Filter |
cache | Set to true to turn on the Quick Filter cache, used to improve performance when using the Quick Filter.This property will only be read on initialisation. See: Quick Filter Cache |
include | Hidden columns are excluded from the Quick Filter by default.
To include hidden columns, set to true. |
quick | Changes how the Quick Filter splits the Quick Filter text into search terms. See: Quick Filter Parser |
quick | Changes the matching logic for whether a row passes the Quick Filter. See: Quick Filter Matcher |
apply | 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. |
is | Grid calls this method to know if an external filter is present. See: External Filter |
does | Should return true if external filter passes, otherwise false.See: External Filter |
exclude | Set to true to override the default tree data filtering behaviour to instead exclude child nodes from filter results.See: Tree Data Filtering |
enable | Set to true to enable the Advanced Filter. See: Advanced Filter |
include | Hidden columns are excluded from the Advanced Filter by default.
To include hidden columns, set to true.See: Advanced Filter |
advanced | 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 |
advanced | Customise the parameters passed to the Advanced Filter Builder. See: Advanced Filter |
Integrated Charts
See Integrated Charts for more information.
enable | Set to true to Enable Charts. |
get | Callback to be used to customise the chart toolbar items. This property will only be read on initialisation. |
create | Callback to enable displaying the chart in an alternative chart container. This property will only be read on initialisation. |
chart | The list of chart themes that a user can choose from in the chart panel. This property will only be read on initialisation. See: Provided Themes |
custom | A map containing custom chart themes. This property will only be read on initialisation. See: Custom Chart Themes |
chart | Chart theme overrides applied to all themes. This property will only be read on initialisation. |
chart | 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. This property will only be read on initialisation. |
chart | Get chart menu items. Only applies when using AG Charts Enterprise. |
Keyboard Navigation
See Keyboard Navigation for more information.
focus | Allows overriding the element that will be focused when the grid receives focus from outside elements (tabbing into the grid). See: Custom Navigation |
navigate | 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.See: Custom Navigation |
tab | 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.
As of v31.3, returning null is deprecated.See: Custom Navigation |
navigate | 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.See: Custom Navigation |
tab | 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.
As of v31.3, returning null is deprecated.See: Custom Navigation |
Loading Cell Renderers
See loadingCellRenderer for more information.
Localisation
See Localisation for more information.
locale | A map of key->value pairs for localising text within the grid. This property will only be read on initialisation. See: Localisation |
get | A callback for localising text within the grid. This property will only be read on initialisation. See: Localisation |
Master Detail
See Master Detail for more information.
master | Set to true to enable Master Detail.See: Master Detail |
is | 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.See: Dynamic Master Rows |
detail | Provide a custom detailCellRenderer to use when a master row is expanded.See: Custom Detail |
detail | 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 |
detail | Set fixed height in pixels for each detail row. This property will only be read on initialisation. See: Fixed Height |
detail | Set to true to have the detail grid dynamically change it's height to fit it's rows.This property will only be read on initialisation. See: Auto Height |
embed | Set to true to have the Full Width Rows embedded in grid's main container so they can be scrolled horizontally. |
keep | Set to true to keep detail rows for when they are displayed again.This property will only be read on initialisation. |
keep | Sets the number of details rows to keep. This property will only be read on initialisation. |
Miscellaneous
initial | Initial state for the grid. Only read once on initialization. Can be used in conjunction with api.getState() to save and restore grid state.This property will only be read on initialisation. See: Grid State |
aligned |
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. See: Aligned Grids |
context | 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. This property will only be read on initialisation. See: Context |
tab | Change this value to set the tabIndex order of the Grid within your application. This property will only be read on initialisation. |
row | 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. See: Row Buffer |
value | Set to true to turn on the value cache.This property will only be read on initialisation. See: Value Cache |
value | Set to true to configure the value cache to not expire after data updates.This property will only be read on initialisation. See: Value Cache |
enable | Set to true to allow cell expressions.This property will only be read on initialisation. See: Cell Expressions |
get | 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) |
suppress | Disables touch support (but does not remove the browser's efforts to simulate mouse events on touch). This property will only be read on initialisation. See: Touch Support |
suppress | 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. |
suppress | 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.This property will only be read on initialisation. |
suppress | Disables showing a warning message in the console if using a gridOptions or colDef property that doesn't exist.This property will only be read on initialisation. |
suppress | Disables change detection. |
debug | 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.This property will only be read on initialisation. |
Overlays
See Overlays for more information.
loading | Show or hide the loading overlay. See: Loading Overlay |
overlay | Provide a HTML string to override the default loading overlay. Supports non-empty plain text or HTML with a single root element. See: Custom Overlays |
loading | Provide a custom loading overlay component. This property will only be read on initialisation. |
loading | Customise the parameters provided to the loading overlay component. See: Overlay Component |
suppress | Set to true to prevent the no-rows overlay being shown when there is no row data.This property will only be read on initialisation. See: No rows overlay |
overlay | Provide a HTML string to override the default no-rows overlay. Supports non-empty plain text or HTML with a single root element. See: Custom Overlays |
no | Provide a custom no rows overlay component. This property will only be read on initialisation. |
no | Customise the parameters provided to the no-rows overlay component. See: Overlay Component |
Pagination
See Row Pagination for more information.
pagination | Set whether pagination is enabled. See: Row Pagination |
pagination | How many rows to load per page. If paginationAutoPageSize is specified, this property is ignored. |
pagination | 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.This property will only be read on initialisation. |
pagination | 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.This property will only be read on initialisation. |
pagination | 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 |
paginate | Set to true to have pages split children of groups when using Row Grouping or detail rows with Master Detail.This property will only be read on initialisation. |
suppress | 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. |
Pivot and Aggregation
See Pivot and Aggregation for more information
pivot | Set to true to enable pivot mode.See: Pivoting |
pivot | 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.This property will only be read on initialisation. See: Enabling Pivot Panel |
pivot | 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. |
pivot | When set and the grid is in pivot mode, automatically calculated totals will appear within the Pivot Column Groups, in the position specified. |
pivot | 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 |
pivot | 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.This property will only be read on initialisation. |
pivot | 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. |
process | Callback to be used with pivoting, to allow changing the second column definition. |
process | Callback to be used with pivoting, to allow changing the second column group definition. |
suppress | When enabled, pivot column groups will appear 'fixed', without the ability to expand and collapse the column groups. This property will only be read on initialisation. |
functions | 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 |
agg | A map of 'function name' to 'function' for custom aggregation functions. This property will only be read on initialisation. |
get | Callback to use when you need access to more then the current column for aggregation. |
suppress | When true, column headers won't include the aggFunc name, e.g. 'sum(Bank Balance)' will just be 'Bank Balance'.This property will only be read on initialisation. See: Column Headers |
always | When using aggregations, the grid will always calculate the root level aggregation value. |
aggregate | When using change detection, only the updated column will be re-aggregated. See: Change Detection |
suppress | Set to true so that aggregations are not impacted by filtering. |
group | Set to determine whether filters should be applied on aggregated group values. |
remove | Set to true to omit the value Column header when there is only a single value column.This property will only be read on initialisation. |
Rendering
animate | Set to false to disable Row Animation which is enabled by default.See: Row Animation |
cell | Sets the duration in milliseconds of how long a cell should remain in its "flashed" state.
If 0, the cell will not flash.See: How Flashing Works |
cell | Sets the duration in milliseconds of how long the "flashed" state animation takes to fade away after the timer set by cellFlashDuration has completed.See: How Flashing Works |
allow | Set to true to have cells flash after data changes even when the change is due to filtering.This property will only be read on initialisation. |
dom | See: DOM Layout |
ensure | When true, the order of rows and columns in the DOM are consistent with what is on screen.
Disables row animations.This property will only be read on initialisation. |
get | 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. |
grid | 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.This property will only be read on initialisation. |
process | Callback fired after the row is rendered into the DOM. Should not be used to initiate side effects. |
enable | Set to true to operate the grid in RTL (Right to Left) mode.This property will only be read on initialisation. See: RTL (Right to Left) |
suppress | 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.This property will only be read on initialisation. |
suppress | 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.This property will only be read on initialisation. |
suppress | 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.This property will only be read on initialisation. See: Max Rendered Rows |
Row Drag and Drop
See Row Dragging for more information.
row | Set to true to enable Managed Row Dragging.See: Managed Row Dragging |
row | Set to true to enable clicking and dragging anywhere on the row without the need for a drag handle.See: Entire Row Dragging |
row | Set to true to enable dragging multiple rows at the same time.See: Mulit-Row Dragging |
suppress | Set to true to suppress row dragging.See: Suppress Row Drag |
suppress | 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. |
row | 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.This property will only be read on initialisation. See: Custom Row Drag Text |
Row Full Width
See Full Width Rows for more information.
full | Provide your own cell renderer component to use for full width rows. |
full | Customise the parameters provided to the fullWidthCellRenderer component. |
Row Grouping
See Row Grouping for more information.
group | 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. |
group | 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. |
auto | 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. |
group | When true, preserves the current group order when sorting on non-group columns.See: Maintain Group Order |
group | When true, if you select a group, the children of the group will also be selected.See: Group Selection |
group | 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.This property will only be read on initialisation. |
group | 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. See: Group Total Rows |
grand | 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. See: Grand Total Row |
suppress | Suppress the sticky behaviour of the total rows, can be suppressed individually by passing 'grand' or 'group'. |
group | 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. |
group | If using groupSelectsChildren, then only the children that pass the current filter will get selected.See: Group Selection |
show | Shows the open group in the group column for non-group rows. See: Showing Open Groups |
is | (Client-side Row Model only) Allows groups to be open by default. |
initial | Allows default sorting of groups. See: Initial Group Order |
group | Set to true to collapse groups that only have one child. |
group | Set to true to collapse lowest level groups that only have one child. |
group | 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 |
group | 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. |
row | When to show the 'row group panel' (where you drag rows to group) at the top. |
row | Set to true to suppress sort indicators and actions from the row group panel.This property will only be read on initialisation. See: Suppress Sorting |
group | Provide the Cell Renderer to use when groupDisplayType = 'groupRows'. |
group | Customise the parameters provided to the groupRowRenderer component. |
suppress | 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 |
suppress | Set to true prevent Group Rows from sticking to the top of the grid.This property will only be read on initialisation. |
suppress | If true, when you drag a column into a row group panel the column is not hidden. |
suppress | 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. Default: false |
tree | Set to true to enable the Grid to work with Tree Data. You must also implement the getDataPath(data) callback.See: Tree Data |
get | 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.
pinned | Data to be displayed as pinned top rows in the grid. See: Row Pinning |
pinned | Data to be displayed as pinned bottom rows in the grid. See: Row Pinning |
RowModel
See Row Model for more information.
row | Sets the row model type. This property will only be read on initialisation. See: Row Model |
get | 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. This property will only be read on initialisation. See: Row IDs |
RowModel: Client-Side
Row data uses the generic type TData if provided via GridOptions<TData>. Otherwise TData will default to any.
row | Set the data to be displayed as rows in the grid. See: Updating Row Data |
reset | 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. |
async | How many milliseconds to wait before executing a batch of async transactions. See: Async transactions |
suppress | 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.
datasource | Provide the datasource for infinite scrolling. See: Datasource |
cache | 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. This property will only be read on initialisation. |
max | 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.This property will only be read on initialisation. |
cache | How many rows for each block in the store, i.e. how many rows returned from the server at a time. |
max | 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. This property will only be read on initialisation. |
infinite | 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. This property will only be read on initialisation. |
RowModel: Server-Side
See Server-Side Row Model for more information.
server | Provide the serverSideDatasource for server side row model. |
cache | How many rows for each block in the cache, i.e. how many rows returned from the server at a time. Default: 100See: Server-Side Cache |
max | 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. This property will only be read on initialisation. See: Server-Side Cache |
max | 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.This property will only be read on initialisation. |
block | How many milliseconds to wait before loading a block. Useful when scrolling over many blocks, as it prevents blocks loading until scrolling has settled. This property will only be read on initialisation. |
suppress | When true, the Server-side Row Model will not use a full width loading renderer, instead using the colDef loadingCellRenderer if present.See: Cell Loading |
purge | 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 |
server | Used to split pivot field strings for generating pivot result columns when pivotResultFields is provided as part of a getRows success.This property will only be read on initialisation. |
server | 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. |
server | When enabled, sorts fully loaded groups in the browser instead of requesting from the server. |
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. This property will only be read on initialisation. See: Filters |
server | Set how many loading rows to display to the user for the root level group. This property will only be read on initialisation. |
get | Allows setting the child count for a group row. This property will only be read on initialisation. |
get | Allows providing different params for different levels of grouping. This property will only be read on initialisation. |
is | Allows groups to be open by default. See: Open by Default |
is | Allows cancelling transactions. |
is | SSRM Tree Data: Allows specifying which rows are expandable. See: SSRM Tree Data |
get | SSRM Tree Data: Allows specifying group keys. See: SSRM Tree Data |
RowModel: Viewport
See Viewport Row Model for more information.
Scrolling
Selection
See Selection Overview for more information.
row | Type of Row Selection. See: Row Selection |
row | Set to true to allow multiple rows to be selected using single click. |
is | Callback to be used to determine which rows are selectable. By default rows are selectable, so return false to make a row un-selectable. |
suppress | If true, rows will not be deselected if you hold down ^ Ctrl and click the row or press ␣ Space. Default: falseSee: Row Selection |
suppress | If true, row selection won't happen when rows are clicked. Use when you only want checkbox selection.See: Row Selection |
suppress | 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.See: Suppress Cell Focus |
suppress | 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. |
suppress | If true, only a single range can be selected. |
enable | 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. |
enable | Set to true to enable Range Selection.See: Range Selection |
enable | Set to true to enable the Range Handle.See: Range Handle |
enable | Set to true to enable the Fill Handle.See: Fill Handle |
fill | Set to 'x' to force the fill handle direction to horizontal, or set to 'y' to force the fill handle direction to vertical.See: Fill Handle Axis |
fill | Callback to fill values instead of simply copying values or increasing number values using linear progression. See: Custom User Function |
suppress | 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.
sorting | Array defining the order in which sorting occurs (if sorting is enabled). Values can be 'asc', 'desc' or null. For example: sortingOrder: ['asc', 'desc']. |
accented | 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 |
un | Set to true to show the 'no sort' icon. |
suppress | Set to true to suppress multi-sort when the user shift-clicks a column header.See: Multi Column Sorting |
always | Set to true to always multi-sort when the user clicks a column header, regardless of key presses.See: Multi Column Sorting |
multi | Set to 'ctrl' to have multi sorting work using the ^ Ctrl (or Command ⌘ for Mac) key.See: Multi Column Sorting |
suppress | Set to true to suppress sorting of un-sorted data to match original row data. |
post | Callback to perform additional sorting after the grid has sorted the rows. See: Post Sort |
delta | When enabled, sorts only the rows added/updated by a transaction. See: Delta sorting |
Styling
icons | Icons to use inside the grid instead of the grid's default icons. This property will only be read on initialisation. See: Custom Icons |
row | Default row height in pixels. See: Row Height |
get | 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 |
row | The style properties to apply to all rows. Set to an object of key (style names) and values (style values). See: Row Style |
get | 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 |
row | CSS class(es) for all rows. Provide either a string (class name) or array of strings (array of class names). See: Row Class |
get | 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 |
row | Rules which can be applied to include certain CSS classes. See: Row Class Rules |
is | Tells the grid if this row should be rendered as full width. See: Full Width Rows |
suppress | Set to true to not highlight rows by adding the ag-row-hover CSS class. |
suppress | Uses CSS top instead of CSS transform for positioning rows. Useful if the transform function is causing issues such as used in row spanning. Default: falseThis property will only be read on initialisation. |
column | Set to true to highlight columns by adding the ag-column-hover CSS class. |
Tooltips
See Tooltip Component for more information.
enable | Set to true to use the browser's default tooltip instead of using the grid's Tooltip Component.This property will only be read on initialisation. |
tooltip | 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. |
tooltip | 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. |
tooltip | Set to true to have tooltips follow the cursor once they are displayed.This property will only be read on initialisation. See: Mouse Tracking |
tooltip | 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}. |
tooltip | 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. This property will only be read on initialisation. |
tooltip | 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.This property will only be read on initialisation. See: Interactive Tooltips |