API REFERENCE

unregisterAggFunc

Removes a registered custom aggregate function. Also update aggFunc settings in columns using it.

What does this API do?

Removes a registered custom aggregate function. Also update aggFunc settings in columns using it.

API for Pro features: Row grouping, built-in aggregation and group totals

Exact input and result types

typescript
unregisterAggFunc(name: string): Promise<void>
ArgumentsRequiredType
nameRequiredstring

The return type is Promise<void>.

Usage flow

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

Feature explanations and examples