ExternalChartingOptions

Options for managing External (i.e. non AG Grid) Charts

TypeScript
export interface

Properties

PropertyDescription
isChartOpenedNeeds to be implemented to specify if Chart is opened; used to set Show Button's highlighting
onDeleteChartCalled when User deletes a persisted Chart
onHideChartCalled when User clicks on Hide button next to Chart
onPreviewChartShows Chart in Settings Panel preview (not saved into State); returned definition will be passed to 'onHideChart' when Preview closes
onShowChartCalled when User clicks on Show button next to Chart

Property Details

isChartOpened

Needs to be implemented to specify if Chart is opened; used to set Show Button's highlighting

TypeScript
isChartOpened?: (context: ExternalChartingContext) => boolean;
Property Value

(context:ExternalChartingContext) => boolean

onDeleteChart

Called when User deletes a persisted Chart

TypeScript
onDeleteChart?: (context: ExternalChartingContext) => void;
Property Value

(context:ExternalChartingContext) => void

onHideChart

Called when User clicks on Hide button next to Chart

TypeScript
onHideChart?: (context: ExternalChartingContext) => void;
Property Value

(context:ExternalChartingContext) => void

onPreviewChart

Shows Chart in Settings Panel preview (not saved into State); returned definition will be passed to 'onHideChart' when Preview closes

TypeScript
onPreviewChart?: (context: ExternalChartingContext) => ExternalChartDefinition;
Property Value

(context:ExternalChartingContext) => ExternalChartDefinition

onShowChart

Called when User clicks on Show button next to Chart

TypeScript
onShowChart?: (context: ExternalChartingContext) => void;
Property Value

(context:ExternalChartingContext) => void