API REFERENCE

getRegisteredGridComponentNames

Reads registered custom Grid component names.

What does this API do?

Reads registered custom Grid component names.

Exact input and result types

typescript
getRegisteredGridComponentNames(scope: GridComponentRegistrationScope, kind: GridComponentKind): Promise<ReadonlyArray<string>>
ArgumentsRequiredType
scopeRequiredGridComponentRegistrationScope
kindRequiredGridComponentKind

The return type is Promise<ReadonlyArray<string>>.

Usage flow

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