API REFERENCE

getChartMenuModel

Reads the chart menu model available for the current selection and permissions.

What does this API do?

Reads the chart menu model available for the current selection and permissions.

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

Exact input and result types

typescript
getChartMenuModel(permissions?: SyGridChartPermissions): Promise<SyGridChartMenuReport>
ArgumentsRequiredType
permissionsOptionalSyGridChartPermissions

The return type is Promise<SyGridChartMenuReport>.

Usage flow

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