Documentation

@kanunilabs/datagrid-react-enterprise


@kanunilabs/datagrid-react-enterprise / GridChartPanelApi

Interface: GridChartPanelApi

The open panel from outside — what apiRef receives.

Methods

download()

download(options?): Promise<boolean>

Download the drawn chart; false while nothing is drawn.

Parameters

options?

ChartImageRequest

Returns

Promise<boolean>


getImageDataUrl()

getImageDataUrl(options?): Promise<string | null>

The drawn chart as a data: URL; null while nothing is drawn.

Parameters

options?

ChartImageRequest

Returns

Promise<string | null>


getState()

getState(): GridChartState

The panel as data (always open: true — a mounted panel is an open one).

Returns

GridChartState


update()

update(seed): void

Apply any part of the state; the parts left out stay as they are.

Parameters

seed

GridChartSeed

Returns

void