AdapTable Version:

Framework:

ChartingApi

Provides run-time access to Charting Module and related State

TypeScript

export interface

Methods

Method	Description
addChartDefinition(chartDefinition)	Add new Chart
addExternalChartDefinition(chartDef, options)	Add new external chart definition
closeChartDefinition(chartDefinition)	Close Chart definition
deleteExternalChartDefinition(chartDefinition)	Delete external chart definition
editChartDefinition(chartDefinition)	Edit existing Chart
editExternalChartDefinition(chartDef)	Edit existing external chart definition
getChartDefinitionByName(name)	Retrieves Chart definition by name
getChartDefinitionByUuid(uuid)	Retrieves Chart definition by uuid
getChartDefinitions()	Retrieves all adaptable Chart definitions
getChartingOpenState()	Get info about all saved charts, incl. their open state
getChartRef(chartId)	Retrieves AG Grid ChartRef for given ChartId
getCurrentChartModels()	Retrieves current user-generated Charts
getExternalChartDefinitionByName(name)	Retrieves Chart definition by name
getExternalChartDefinitions()	Retrieves all adaptable external Chart definitions
getOpenChartContainer(chartDefinition)	Retrieve name of container in which Chart is open; returns null if Chart is not open
getPersistedCharts()	Retrieves persisted Charts from Adaptable State
isChartingEnabled()	Whether AdapTable's Charting functionality is available
saveCurrentCharts()	Saves all current Charts into Adaptable State
setChartEditable(chartDefinition)	Make a Chart Editable (i.e. not Read-Only)
setChartReadOnly(chartDefinition)	Make a Chart Read-Only
showChartDefinition(chartDefinition, container)	Opens a Chart Definition
showChartDefinitionOnce(chartDefinition, container)	Displays a Chart; if Chart is already open, 2nd Chart is not opened
showPersistedCharts()	Displays all persisted Charts

Method Details

addChartDefinition

Add new Chart

TypeScript

addChartDefinition(chartDefinition: ChartDefinition): void;

Parameters

Parameter	Type	Description
chartDefinition	`ChartDefinition`	Chart to add

Returns

void

addExternalChartDefinition

Add new external chart definition

TypeScript

addExternalChartDefinition(chartDef: ExternalChartDefinition, options?: {
        saveChartBehaviour: 'auto' | 'manual';
    }): void;

Parameters

Parameter	Type	Description
chartDef	`ExternalChartDefinition`	external chart definition
options	`\{ saveChartBehaviour: 'auto' \| 'manual'; \}`

Returns

void

closeChartDefinition

Close Chart definition

TypeScript

closeChartDefinition(chartDefinition: ChartDefinition): void;

Parameters

Parameter	Type	Description
chartDefinition	`ChartDefinition`	Chart Definition

Returns

void

deleteExternalChartDefinition

Delete external chart definition

TypeScript

deleteExternalChartDefinition(chartDefinition: ExternalChartDefinition): void;

Parameters

Parameter	Type	Description
chartDefinition	`ExternalChartDefinition`	chart definition

Returns

void

editChartDefinition

Edit existing Chart

TypeScript

editChartDefinition(chartDefinition: ChartDefinition): void;

Parameters

Parameter	Type	Description
chartDefinition	`ChartDefinition`	Chart to edit

Returns

void

editExternalChartDefinition

Edit existing external chart definition

TypeScript

editExternalChartDefinition(chartDef: ExternalChartDefinition): void;

Parameters

Parameter	Type	Description
chartDef	`ExternalChartDefinition`	external chart definition

Returns

void

getChartDefinitionByName

Retrieves Chart definition by name

TypeScript

getChartDefinitionByName(name: string): ChartDefinition | undefined;

Parameters

Parameter	Type	Description
name	`string`	Chart name

Returns

ChartDefinition | undefined

getChartDefinitionByUuid

Retrieves Chart definition by uuid

TypeScript

getChartDefinitionByUuid(uuid: string): ChartDefinition | undefined;

Parameters

Parameter	Type	Description
uuid	`string`	Chart uuid

Returns

ChartDefinition | undefined

getChartDefinitions

Retrieves all adaptable Chart definitions

TypeScript

getChartDefinitions(): ChartDefinition[];

Returns

ChartDefinition[]

getChartingOpenState

Get info about all saved charts, incl. their open state

TypeScript

getChartingOpenState(): ChartingOpenState;

Returns

ChartingOpenState

getChartRef

Retrieves AG Grid ChartRef for given ChartId

TypeScript

getChartRef(chartId: string): ChartRef | undefined;

Parameters

Parameter	Type
chartId	`string`

Returns

ChartRef | undefined

getCurrentChartModels

Retrieves current user-generated Charts

TypeScript

getCurrentChartModels(): ChartModel[];

Returns

ChartModel[]

getExternalChartDefinitionByName

Retrieves Chart definition by name

TypeScript

getExternalChartDefinitionByName(name: string): ExternalChartDefinition | undefined;

Parameters

Parameter	Type	Description
name	`string`	Chart name

Returns

ExternalChartDefinition | undefined

getExternalChartDefinitions

Retrieves all adaptable external Chart definitions

TypeScript

getExternalChartDefinitions(): ExternalChartDefinition[];

Returns

ExternalChartDefinition[]

getOpenChartContainer

Retrieve name of container in which Chart is open; returns null if Chart is not open

TypeScript

getOpenChartContainer(chartDefinition: ChartDefinition): ChartContainer | null;

Parameters

Parameter	Type	Description
chartDefinition	`ChartDefinition`	Chart to add

Returns

ChartContainer | null

getPersistedCharts

Retrieves persisted Charts from Adaptable State

TypeScript

getPersistedCharts(): ChartModel[];

Returns

ChartModel[]

isChartingEnabled

Whether AdapTable's Charting functionality is available

TypeScript

isChartingEnabled(): boolean;

Returns

boolean

saveCurrentCharts

Saves all current Charts into Adaptable State

TypeScript

saveCurrentCharts(): void;

Returns

void

setChartEditable

Make a Chart Editable (i.e. not Read-Only)

TypeScript

setChartEditable(chartDefinition: ChartDefinition): void;

Parameters

Parameter	Type	Description
chartDefinition	`ChartDefinition`	Chart to make Editable

Returns

void

setChartReadOnly

Make a Chart Read-Only

TypeScript

setChartReadOnly(chartDefinition: ChartDefinition): void;

Parameters

Parameter	Type	Description
chartDefinition	`ChartDefinition`	Chart to make Read-Only

Returns

void

showChartDefinition

Opens a Chart Definition

TypeScript

showChartDefinition(chartDefinition: ChartDefinition, container?: HTMLElement | string): ChartRef;

Parameters

Parameter	Type	Description
chartDefinition	`ChartDefinition`	Chart Definition
container	`HTMLElement \| string`	container element or container name

Returns

ChartRef

showChartDefinitionOnce

Displays a Chart; if Chart is already open, 2nd Chart is not opened

TypeScript

showChartDefinitionOnce(chartDefinition: ChartDefinition, container?: HTMLElement): ChartRef;

Parameters

Parameter	Type	Description
chartDefinition	`ChartDefinition`	Chart to show
container	`HTMLElement`	Container in which to display the Chart

Returns

ChartRef

showPersistedCharts

Displays all persisted Charts

TypeScript

showPersistedCharts(): ChartRef[];

Returns

ChartRef[]

PreviousChartingAggFunc NextChartingOpenState