React Data GridChart Tool Panels
react logo
Enterprise

The Chart Tool Panels allow users to change the selected chart type and customise the data and chart formatting.

Open Chart Tool Panels with button to close it on the middle left of the panels
Accessing Chart Tool Panels

The Chart Tool Panels are accessed by clicking on the button highlighted above. Note they can also be opened via configuration (see examples in this section) or programmatically through the Grid API, see Open / Close Chart Tool Panels.

Settings Tool Panel

The Settings Panel can be used to change the chart type and chart theme.

Chart Settings Panel
Chart Settings Panel

It is possible to configure which chart groups and chart types are included and in which order via the chartToolPanelsDef grid option:

The full list of chart groups with the corresponding chart types are shown below:


interface ChartGroupsDef {
  columnGroup?: ('column' | 'stackedColumn' | 'normalizedColumn')[];
  barGroup?: ('bar' | 'stackedBar' | 'normalizedBar')[];
  pieGroup?: ('pie' | 'donut' | 'doughnut')[];
  lineGroup?: ('line')[];
  scatterGroup?: ('scatter' | 'bubble')[];
  areaGroup?: ('area' | 'stackedArea' | 'normalizedArea')[];
  combinationGroup?: ('columnLineCombo' | 'areaColumnCombo' | 'customCombo')[];
  polarGroup?: ('radarLine' | 'radarArea' | 'nightingale' | 'radialColumn' | 'radialBar')[];
  statisticalGroup?: ('boxPlot' | 'histogram' | 'rangeBar' | 'rangeArea')[];
  hierarchicalGroup?: ('treemap' | 'sunburst')[];
  specializedGroup?: ('heatmap' | 'waterfall')[];
}

The contents and order of chart menu items in the Context Menu will match the ChartGroupsDef configuration.

The example below shows a subset of the provided chart groups with the chart types reordered. Note the following:

  • Only the Pie, Columns and Bar chart groups are shown in the settings panel.
  • Only the Pie, Columns and Bar chart groups are shown in the Context Menu when you right click the grid.
  • Note the order of the chart groups and their chart types matches the order they are specified in chartGroupsDef.
  • The Settings Panel is configured to be open by default via defaultToolPanel: 'settings'.

Data Tool Panel

The Data Panel can be used to change the chart category and series.

Chart Data Panel
Chart Data Panel

It is possible to configure which groups are shown, the order in which they appear and whether they are opened by default via the chartToolPanelsDef grid option:

The default list and order of the Data Panel groups are as shown below:

const chartToolPanelsDef = useMemo(() => { 
	return {
        dataPanel: {
            groups: [
                { type: 'categories', isOpen: true },
                { type: 'series', isOpen: true },
                { type: 'seriesChartType', isOpen: true }
            ]
        }
    };
}, []);

<AgGridReact chartToolPanelsDef={chartToolPanelsDef} />

The seriesChartType group is only shown in Combination Charts.

The following example shows some Data Panel customisations. Note the following:

  • The Categories group is not included.
  • The Series group is closed by default.
  • The Data Panel is configured to be open by default via defaultToolPanel: 'data'.

Format Tool Panel

The Format Panel allows users to format the chart where the available formatting options differ between chart types.

Chart Format Panel
Chart Format Panel

It is possible to configure which groups are shown, the order in which they appear and whether they are opened by default via the chartToolPanelsDef grid option:

The default list and order of format groups are as follows:

const chartToolPanelsDef = useMemo(() => { 
	return {
        formatPanel: {
            groups: [
                { type: 'chart', isOpen: false },
                { type: 'legend', isOpen: false },
                { type: 'axis', isOpen: false },
                { type: 'series', isOpen: false },
                { type: 'navigator', isOpen: false }
            ]
        }
    };
}, []);

<AgGridReact chartToolPanelsDef={chartToolPanelsDef} />

The selected chart determines which groups are displayed. For example, a pie chart does not have an axis so Axis groups will not be shown even if they are listed in chartToolPanelsDef.formatPanel.groups.

The following example shows some Format Panel customisations. Note the following:

  • The format panel groups have been reordered.
  • The Axis group is open by default.
  • The Navigator group has been omitted.
  • The Format Panel is configured to be open by default via defaultToolPanel: 'format'.

Omitting & Ordering Tool Panels

The Chart Tool Panels can be omitted and ordered using the chartToolPanelsDef.panels grid option:

const chartToolPanelsDef = useMemo(() => { 
	return {
        panels: ['data', 'format', 'settings'], // default order
    };
}, []);

<AgGridReact chartToolPanelsDef={chartToolPanelsDef} />

To hide the Chart Tool Panels, the chartToolPanelsDef.panels grid option can be set to an empty array:

const chartToolPanelsDef = useMemo(() => { 
	return {
        panels: [], // No Chart Tool Panels are shown and the button is also hidden
    };
}, []);

<AgGridReact chartToolPanelsDef={chartToolPanelsDef} />

The following example shows how the Chart Tool Panels can be omitted and ordered. Note the following:

  • The Format Tool Panel has been omitted.
  • The Data Tool Panel appears before the Settings Tool Panel.
  • The Data Panel is configured to be open by default via defaultToolPanel: 'data'.

Chart Tool Panel API

The Chart Tool Panels can be opened and closed programmatically using the following grid APIs:

The example below demonstrates how you can open and close the Chart Tool Panels.

  • Click Open Chart Tool Panel to open the default Settings tab via openChartToolPanel()
  • Click Open Chart Tool Panel Format tab to open the Format tab via openChartToolPanel()
  • Click Close Chart Tool Panel to close via closeChartToolPanel()

Next Up

Continue to the next section to learn about the: Chart Toolbar.