API REFERENCE

refreshExternalFilter

Runs the external filter refresh lifecycle and returns success.

What does this API do?

Runs the external filter refresh lifecycle and returns success.

Exact input and result types

typescript
refreshExternalFilter(): Promise<boolean>
ArgumentsRequiredType

The return type is Promise<boolean>.

Usage flow

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

Feature explanations and examples