Framework:Javascript Data GridAngular Data GridReact Data GridVue Data Grid

JavaScript Data Grid: Chart API

In addition to users creating their own charts from the grid, charts can also be generated by using the Chart API.

Range Charts

Charts can be created programmatically from a range via the grid's createRangeChart() API. The interface is as follows:

function createRangeChart(params: CreateRangeChartParams): ChartRef | undefined;
chartType
The type of chart to create.
Options: 'groupedColumn', 'stackedColumn', 'normalizedColumn', 'groupedBar', 'stackedBar', 'normalizedBar', 'line', 'scatter', 'bubble', 'pie', 'doughnut', 'area', 'stackedArea', 'normalizedArea'
cellRange
Defines the range of cells to be charted. A range is normally defined with start and end rows and a list of columns. If the start and end rows are omitted, the range covers all rows (i.e. entire columns are selected). The columns can either be defined using a start and end column (the range will cover the start and end columns and all columns in between), or columns can be supplied specifically in cases where the required columns are not adjacent to each other. See Add Cell Range for more information.
See cellRange for more details.
chartThemeName
string
The default theme to use for the created chart. In addition to the default options you listed, you can also provide your own custom chart themes.
Options: 'ag-default', 'ag-default-dark', 'ag-material', 'ag-material-dark', 'ag-pastel', 'ag-pastel-dark', 'ag-vivid', 'ag-vivid-dark', 'ag-solar', 'ag-solar-dark'
chartContainer
If the chart is to be displayed outside of the grid then a chart container should be provided. If the chart is to be displayed using the grid's popup window mechanism then leave as undefined.
suppressChartRanges
boolean
By default, when a chart is displayed using the grid, the grid will highlight the range the chart is charting when the chart gets focus. To suppress this behaviour, set suppressChartRanges=true.
Default: false
aggFunc
Function
The aggregation function that should be applied to all series data. The built-in aggregation functions are 'sum', 'min', 'max', 'count', 'avg', 'first', 'last'. Alternatively, custom aggregation functions can be provided if they conform to the IAggFunc interface shown here.
aggFunc = (params: AggFuncParams) => any;

interface AggFuncParams {
  values: any[];
  column: Column;
  colDef: ColDef;
  rowNode: RowNode;
  data: any;
  api: GridApi;
  columnApi: ColumnApi;
  context: any;
}
unlinkChart
boolean
When enabled the chart will be unlinked from the grid after creation, any updates to the data will not be reflected in the chart. See Unlinking Charts.
Default: false
chartThemeOverrides
AgChartThemeOverrides
Allows specific chart options in the current theme to be overridden. See Overriding Existing Themes.

cellRange

params > cellRange

Defines the range of cells to be charted. A range is normally defined with start and end rows and a list of columns. If the start and end rows are omitted, the range covers all rows (i.e. entire columns are selected). The columns can either be defined using a start and end column (the range will cover the start and end columns and all columns in between), or columns can be supplied specifically in cases where the required columns are not adjacent to each other. See Add Cell Range for more information.

params: {
  ...
  cellRange: {
    rowStartIndex?: number;
    rowStartPinned?: string;
    rowEndIndex?: number;
    rowEndPinned?: string;
    columnStart?: string | Column;
    columnEnd?: string | Column;
    columns?: (string | Column)[];
  }
}
rowStartIndex
number
The index of the first row in the range.
rowStartPinned
string
Sets whether the first row is pinned.
rowEndIndex
number
The index of the last row in the range.
rowEndPinned
string
Sets whether the last row is pinned.
columnStart
string | Column
The first column of the range.
columnEnd
string | Column
The last column of the range.
columns
(string | Column)[]
The columns in the range. Used instead of columnStart and columnEnd, particularly when you want non-sequential columns.

The API returns a ChartRef object when a chartContainer is provided. This is the same structure that is provided to the createChartContainer() callback. The ChartRef provides the application with the destroyChart() method that is required when the application wants to dispose the chart.

Example: Charts in Grid Popup Window

This example shows how charts can be created in the grid's provided popup window. The following can be noted:

  • Clicking 'Top 5 Medal Winners' will chart the first five rows of Gold and Silver medals by Country.
  • Clicking 'Bronze Medals by Country' will chart Bronze by Country using all rows (the provided cell range does not specify rows).
  • Note the 'Bronze Medals by Country' chart is unlinked from the grid as chartUnlinked=true. Notice that sorting in the grid does not affect the chart and there is no chart range in the grid.

Example: Charts in Dashboard

This example passes a chartContainer to the API to place the chart in a location other than the grid's popup window. The following can be noted:

  • The charts are placed in div elements outside of the grid.
  • The two pie charts are showing aggregations rather than charting individual rows.
  • Clicking on a chart highlights the range in the grid for which the chart is based.
  • The bar chart is sensitive to changes in the rows. For example if you sort, the chart updates to always chart the first five rows.
  • All data is editable in the grid. Changes to the grid data is reflected in the charts.
  • The two pie charts have legends beneath. This is configured in the chartThemeOverrides.

Pivot Charts

You can also use the API to create a pivot chart. There are fewer parameters available as the pivot chart is always generated from all data in the grid:

function createPivotChart(params: CreatePivotChartParams): ChartRef | undefined;

interface CreatePivotChartParams {
    chartType: ChartType;
    chartThemeName?: string;
    chartContainer?: HTMLElement;
    chartThemeOverrides?: AgChartTheme;
    unlinkChart?: boolean;
}

The pivot chart params share the same behaviour as the Range Chart Params above.

This is an example showing the pivot chart API in action, using a specified chart container.

Saving and Restoring Charts

A chart model that represent all the state information about the rendered charts can be obtained using getChartModels(). These models are returned in a format that can be easily used with the other API methods to later restore the chart.

function getChartModels(): ChartModel[];

interface ChartModel {
    modelType: ChartModelType; // 'range' | 'pivot';
    chartId: string;
    chartType: ChartType;
    cellRange: CellRangeParams;
    chartThemeName?: string;
    chartOptions: ChartOptions<any>;
    suppressChartRanges?: boolean;
    aggFunc?: string | IAggFunc;
    unlinkChart?: boolean;
}

These models can then be supplied to the following grid api method to restore the charts:

function restoreChart(model: ChartModel, chartContainer?: HTMLElement): ChartRef

Note that an optional chartContainer can be specified when restoring a chart.

The example below demonstrates how you can save and then later restore a chart. You can make changes to the chart type, theme, data and formatting options and note how the restored chart looks the same as the chart that was saved.

  • Create a range chart from the grid, which will be shown in a container below the grid.
  • Change the chart type, theme, data and/or formatting in order to see the changes restored later.
  • Click "Save chart" to persist a model of the visible chart into a local variable. An alert will be shown to confirm that this has happened.
  • Click "Clear chart" to destroy the existing chart.
  • Click "Restore chart" to restore the previously saved chart.

Downloading Chart Image

It is possible to retrieve a base64 encoded image rendered from the chart using the getChartImageDataURL() API. This API returns a string containing the requested data URL which is ideal for saving to a database and downloading the chart image.

function getChartImageDataURL(params: GetChartImageDataUrlParams): string | undefined;
chartId
string
The id of the created chart.
fileFormat
string
A string indicating the image format. The default format type is image/png.
Options: 'image/png', 'image/jpeg'

The example below demonstrates how you can retrieve images rendered from the chart in multiple formats.

  • Click "Download chart PNG" to download a PNG format image.
  • Click "Download chart JPEG" to download a JPEG format image.
  • Click "Open PNG" to open a PNG format image of the chart in a new window.
  • Click "Open JPEG" to open a JPEG format image of the chart in a new window.

Next Up

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