ChartingOptions
How charts are saved and where they open.
AG Grid chart definitions the user saves are stored in Charting state. These options decide whether that happens automatically, and which element a chart is drawn into.
export interfaceProperties
| Property | Type | Description | Default |
|---|---|---|---|
| agGridContainerName | string | Name shown for AG Grid's own chart window in the container list. | 'AG Grid Window' |
| chartContainers | ChartContainer[] | Elements a saved chart can be drawn into, offered by name when the user opens a chart. Omit this to open charts only in AG Grid's own window. | |
| externalChartingOptions | ExternalChartingOptions | Show, hide, delete and preview for charts that are not AG Grid charts. Required when the chart is drawn by the application. AdapTable calls these instead of opening an AG Grid chart. | |
| restoreChartsOnReady | boolean | 'all' | string[] | Opens persisted AG Grid charts when AdapTable is ready. - true or 'all': all charts in Charting.ChartDefinitions- string[]: chart names to open (matches each definition's Name property) | undefined (no charts opened automatically) |
| saveChartBehaviour | SaveChartBehaviour | Behaviour for saving Charts: auto, manual (via popup) or none | 'none' |
Property Details
agGridContainerName
Name shown for AG Grid's own chart window in the container list.
agGridContainerName?: string;Default Value
'AG Grid Window'
Property Value
string
chartContainers
Elements a saved chart can be drawn into, offered by name when the user opens a chart.
Omit this to open charts only in AG Grid's own window.
chartContainers?: ChartContainer[];Property Value
externalChartingOptions
Show, hide, delete and preview for charts that are not AG Grid charts.
Required when the chart is drawn by the application. AdapTable calls these instead of opening an AG Grid chart.
externalChartingOptions?: ExternalChartingOptions;Default Value
Property Value
restoreChartsOnReady
Opens persisted AG Grid charts when AdapTable is ready.
trueor'all': all charts inCharting.ChartDefinitionsstring[]: chart names to open (matches each definition'sNameproperty)
restoreChartsOnReady?: boolean | 'all' | string[];Default Value
undefined (no charts opened automatically)
Property Value
boolean | 'all' | string[]
saveChartBehaviour
Behaviour for saving Charts: auto, manual (via popup) or none
saveChartBehaviour?: SaveChartBehaviour;Default Value
'none'