API REFERENCE

updateChart

Changes an existing chart's type, source range, or properties and returns the result.

What does this API do?

Changes an existing chart's type, source range, or properties and returns the result.

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

Exact input and result types

typescript
updateChart(chartId: string, patch: SyGridChartUpdatePatch): Promise<SyGridChartUpdateResult>
ArgumentsRequiredType
chartIdRequiredstring
patchRequiredSyGridChartUpdatePatch

The return type is Promise<SyGridChartUpdateResult>.

Usage flow

After registering and initializing the Grid element, call grid.updateChart(…). 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