ChartingOptions
Options for managing AG Grid's Charts
TypeScript
export interfaceProperties
| Property | Type | Description | Default |
|---|---|---|---|
| agGridContainerName | string | Name of AG Grid Chart Container | 'AG Grid Window' |
| chartContainers | ChartContainer[] | Locations to display saved Charts | |
| externalChartingOptions | ExternalChartingOptions | Set of properties for managing behaviour of external (i.e non AG Grid) charts | |
| 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 of AG Grid Chart Container
TypeScript
agGridContainerName?: string;Default Value
'AG Grid Window'
Property Value
string
chartContainers
Locations to display saved Charts
TypeScript
chartContainers?: ChartContainer[];Property Value
externalChartingOptions
Set of properties for managing behaviour of external (i.e non AG Grid) charts
TypeScript
externalChartingOptions?: ExternalChartingOptions;Default Value
Property Value
restoreChartsOnReady
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)
TypeScript
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
TypeScript
saveChartBehaviour?: SaveChartBehaviour;Default Value
'none'