React Data GridPivot Chart API
react logo

This section shows how Pivot Charts can be created via the Grid API.

Creating Pivot Charts

Pivot Charts can be created through gridApi.createPivotChart() as shown below:

     chartType: 'groupedColumn',
     // other options...

The snippet above creates a Pivot Chart with the groupedColumn chart type. For a full list of options see Pivot Chart API.

The following example demonstrates how Pivot Charts can be created programmatically via gridApi.createPivotChart():

Pivot Chart API

Pivot Charts can be created programmatically using:

Properties available on the CreatePivotChartParams interface.

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'
See: Overriding Existing Themes

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

Next Up

Continue to the next section to learn about: Cross Filter API.