Chart Toolbar

This section covers the functionality that is available via the chart toolbar along with configuration details.

    The chart toolbar appears when the mouse hovers over the top right area of the chart. It allows users to perform the following:

    • Change the chart type
    • Change the colour palette
    • Select categories and series columns
    • Format the chart
    • Download the chart

The following sections discuss these toolbar features along with details on how to configure toolbar items.

Chart Settings

The chart settings panel allows users to change the chart type as well as the colour palette used in the chart as demonstrated below:

Chart Settings

Notice that charts are organised into different groups and the current chart can be changed by selecting the icon of a different chart.

The colour palette used by the chart can also be changed via the carousel located at the bottom of the chart setting panel.

Chart Data

The chart data panel is used to dynamically change the data being charted as shown below:

Chart Data

Using the chart data panel the category used in the chart can be changed via radio button selections. Multiple series can be charted and these can also be changed via checkbox selection.

Grid columns can either be configured as categories or series for charting or left for the grid to infer based on the data contained in the columns.

For more details on how the grid determines which columns are to be used as chart categories and series see the section on Defining Categories and Series.

Chart Format

The chart format panel allows users to change the appearance of the chart as shown below:

Chart Format

Chart options corresponding to the currently selected chart type appear in the format panel. This gives users full control over the appearance of the chart.

Unlinking Charts

Charts are linked to the data in the grid by default. However it is sometimes desirable to unlink a chart for the grid data after it has been created. For instance, users may want to prevent a chart from being updated when subsequent sorts and filters are applied in the grid.

Unlinking a chart is achieved through the 'Unlink Chart' toolbar item as shown below:

Unlinking Charts

Notice that the chart range disappears from the grid when the chart has been unlinked and grid sorting doesn't impact the chart.

Chart Download

The 'Download Chart' toolbar item will download the chart as a PNG file. Note that the chart is drawn using Canvas in the browser and as such the user can also right click on the chart and save just like any other image on a web page.

Configuring Toolbar Items

By default all available toolbar items are included by default. However items can be removed and reordered via the gridOptions.getChartToolbarItems() callback function.

The interface for the gridOptions.getChartToolbarItems() callback function is shown below:

interface GridOptions { getChartToolbarItems(params: GetChartToolbarItemsParams): string[]; } interface GetChartToolbarItemsParams { defaultItems: string[]; api: GridApi; columnApi: ColumnApi; }

This function receives the GetChartToolbarItemsParams object which contains the list of items that are shown by default in defaultItems along with the grid APIs.

The list returned by the gridOptions.getChartToolbarItems() callback can be modified to reorder and omit items from the toolbar. For instance, returning an empty array will hide all toolbar items.

The list of available toolbar items are as follows: 'chartSettings', 'chartData', 'chartFormat', 'downloadChart'.

Example - Custom Toolbar Layout

The example below shows how the toolbar layout can be customised. Notice the following:

  • Download Chart - has been positioned as the first toolbar item.
  • Chart Data Panel - appears first in the tabbed menu.
  • Chart Format Panel - has been removed from the tabbed menu.
  • Unlink Toolbar Item - has been removed from the toolbar.

Next Up

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