API REFERENCE

openToolPanel

Opens a column/filter tool panel by ID and returns success.

What does this API do?

Opens a column/filter tool panel by ID and returns success.

API for Pro features: Columns / Filters tool panels

Exact input and result types

typescript
openToolPanel(id: string): Promise<boolean>
ArgumentsRequiredType
idRequiredstring

The return type is Promise<boolean>.

Usage flow

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

Feature explanations and examples