AdapTable Layouts and AG Grid GridOptions
Summary
- Most AG Grid GridOptions properties will work just the same when AdapTable is being used
- However there are some GridOptions properties which are ignored (in favoour of AdapTable alternatives)
- And there are other properties which must be provided, for some AdapTable functionality to work
The vast majority of properties in AG Grid's GridOptions object work as normal when using AdapTable.
In other words, AdapTable has no opinions on whether or not they should be provided.
However there are some GridOptions properties which are affected when using AdapTable.
These properties can be divided into 2 groups:
- ignored by AdapTable (as alternatives are provided in the Layout)
- required by AdapTable for some functionality
Ignored Grid Options Props
Some GridOptions properties will be ignored by AdapTable and their value will not be reflected in the Grid.
Note
- This most usually occurs when AdapTable provides the same functionality at a Layout level
- Per-Layout configuration allows you to set different behaviour for different use cases
The more important of these properties are:
| GridOptions property | AdapTable Layout Property | Notes |
|---|---|---|
grandTotalRow | GrandTotalRow | Can be one of: top bottom pinnedTop pinnedBottom boolean |
suppressAggFuncInHeader | SuppressAggFuncInHeader | Allows this to be set on a per-Layout basis |
Leveraged Grid Options Props
Some functionality in AdapTable requires that relevant GridOptions properties be appropriately configured.
This primarily occurs where AdapTable adds its own content into AG Grid's UI components.
Status Bar
To DO
Tool Panel
AdapTable adds its own Tool Panel to the AG Grid Sidebar, providing access to core AdapTable functionality.
In order to see the AdapTable Tool Panel, the GridOptions sideBar property must:
- either be set to true
gridOptions.sideBar = true- explicitly list it in the array, e.g.
gridOptions.sideBar = ['adaptable', 'filters']Find Out More
See Configuring the Tool Panel for more information