API REFERENCE
applyChartCrossFilter
Applies chart selection actions to the Grid filter model.
What does this API do?
Applies chart selection actions to the Grid filter model.
API for Pro features: Integrated range charts and pivot chart tools
Exact input and result types
applyChartCrossFilter(chartId: string, colId: string, action: SyGridChartCrossFilterAction, categories: unknown[]): Promise<SyGridChartCrossFilterResult>| Arguments | Required | Type |
|---|---|---|
| chartId | Required | string |
| colId | Required | string |
| action | Required | SyGridChartCrossFilterAction |
| categories | Required | unknown[] |
The return type is Promise<SyGridChartCrossFilterResult>.
Usage flow
After registering and initializing the Grid element, call grid.applyChartCrossFilter(…). 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
- Chart selected data
Connect a Grid range to a chart to view the same data as both a table and a graph. Select category and value columns appropriate to the chart type, rather than simply selecting numeric values.