API REFERENCE

getChartModels

Captures active charts in a versioned envelope with capture issues. Pass the result's envelope to restoration.

What does this API do?

Captures active charts in a versioned envelope with capture issues. Pass the result's envelope to restoration.

API for Pro features: Integrated range charts and pivot chart tools

Exact input and result types

typescript
getChartModels(): Promise<SyGridChartCaptureResult>
ArgumentsRequiredType

The return type is Promise<SyGridChartCaptureResult>.

Usage flow

After registering and initializing the Grid element, call grid.getChartModels(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Read related types

Feature explanations and examples