GroupDefinition

Pre-defined group definition for server-side grouping.

When groups are provided externally (e.g. from a server), this interface describes each group’s structure. The plugin renders these groups as collapsible headers and emits events when users expand/collapse them, allowing the consumer to lazily load row data.

Example

const groups: GroupDefinition[] = [
  { key: 'Engineering', value: 'Engineering', rowCount: 150 },
  { key: 'Sales', value: 'Sales', rowCount: 89 },
  { key: 'Marketing', value: 'Marketing', rowCount: 42,
    children: [
      { key: 'Digital', value: 'Digital', rowCount: 20 },
      { key: 'Brand', value: 'Brand', rowCount: 22 },
    ],
  },
];

Properties

Property	Type	Description
key	string	Unique group identifier.
value	unknown	Display value for the group header.
rowCount?	number	Expected row count from server (for display in group header).
children?	GroupDefinition[]	Nested child groups for multi-level grouping.
aggregates?	Record<string, unknown>	Server-computed aggregate values keyed by field name.