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; interface CreateRangeChartParams { { cellRange: CellRangeParams; chartType: ChartType; chartPalette?: string; chartContainer?: HTMLElement; suppressChartRanges?: boolean; aggFunc?: string | IAggFunc; processChartOptions?: (params: ProcessChartOptionsParams) => ChartOptions; } interface CellRangeParams { // start row rowStartIndex?: number; rowStartPinned?: string; // end row rowEndIndex?: number; rowEndPinned?: string; // columns columnStart?: string | Column; columnEnd?: string | Column; columns?: (string | Column)[]; } type ChartType = 'groupedColumn' | 'stackedColumn' | 'normalizedColumn' | 'groupedBar' | 'stackedBar' | 'normalizedBar' | 'line' | 'scatter' | 'bubble' | 'pie' | 'doughnut' | 'area' | 'stackedArea' | 'normalizedArea'; interface IAggFunc { (input: any[]): any; } interface ProcessChartOptionsParams { type: ChartType; options: ChartOptions; }

The provided params contains the following attributes:

  • 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 details.
  • chartType: The type of chart to create. The options are 'groupedColumn', 'stackedColumn', 'normalizedColumn', 'groupedBar', 'stackedBar', 'normalizedBar', 'line', 'scatter', 'bubble', 'pie', 'doughnut', 'area', 'stackedArea', 'normalizedArea'
  • chartPalette: The default palette to use for charts. The options are 'borneo', 'material', 'pastel', 'bright', 'flat'
  • 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: 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.
  • aggFunc: 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 above.
  • processChartOptions: A callback to configure the rendered chart. This works the same as the grid callback processChartOptions described in Chart Customisation.

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 'Gold & Silver, 5 Rows' will chart the first five rows of Gold and Silver by Country.
  • Clicking 'Bronze, All Rows' will chart Bronze by Country using all rows (the provided cell range does not specify rows).

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 processChartOptions().

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; chartPalette?: string; chartContainer?: HTMLElement; processChartOptions?: (params: ProcessChartOptionsParams) => ChartOptions; }

The attributes have the same behaviour as described earlier.

Example: Pivot Chart

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

Saving and Restoring Charts

You can access models that represent rendered charts using the getChartModels() API. The models are returned in a format that can be easily used with the other API methods to later recreate the chart.

function getChartModels(): ChartModel[]; interface ChartModel { chartId: string; cellRange: CellRangeParams; chartType: ChartType; chartPalette: string; chartOptions: ChartOptions; }

Example: Saving and restoring charts

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

  • Create a range chart from the grid, which will be shown in a container below the grid
  • Make changes to the chart type, palette, 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 chart from the saved model (if one exists), and clear the local variable

Next Up

Continue to the next section to learn how to: Provide a Chart Container.