selectServerGroupChildren

What does this API do?

Selects or deselects server descendants beneath a group-key path.

API for Pro features: Server-Side Row Model

Exact input and result types

selectServerGroupChildren(groupKeys: ReadonlyArray<string>, action?: 'select' | 'deselect'): Promise<SyGridServerGroupChildrenResult>

The return type is Promise<SyGridServerGroupChildrenResult>.

Usage flow

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

Read related types

• SyGridServerGroupChildrenResult

Feature explanations and examples

• Server-side row model

  In this model, the server calculates grouping and pivots and supplies rows for each expanded group path. Its data responsibilities differ from grouping already loaded local rows with groupBy.