React Data Grid: Tool Panels
This section covers Tool Panels, available via the grid's Side Bar, which allow for easy access to powerful grid operations such as grouping, pivoting, and filtering. Custom Tool Panels can also be provided to the grid.
Tool Panels are panels that sit in the Side Bar to the right of the grid. The Side Bar allows access to the tool panels via buttons that work like tabs. The Side Bar and a Tool Panel are highlighted in the screenshot below.
The grid provides the following Tool Panels:
- Columns Tool Panel - to control aggregations, grouping and pivoting.
- Filters Tool Panel - to perform multiple column filters.
In addition to the provided Tool Panels, it is also possible to provide custom Tool Panels.
For more details refer to the section: Custom Tool Panel Components.
gridApi has the following methods that can be used to interact with the tool panel.
Opens a particular tool panel. Provide the ID of the tool panel to open.
Closes the currently open tool panel (if any).
Returns the ID of the currently shown tool panel if any, otherwise
Force refresh all tool panels by calling their
Gets the tool panel instance corresponding to the supplied
The following events are emitted from the tool panel.
The tool panel was hidden or shown. Use
The tool panel size has been changed.
Before covering the Tool Panels in detail, continue to the next section to learn about the Side Bar.