IDataTableGroup

interface
Data Display

Internal representation of a group node in a grouped <OrigamDataTable>. Carries the group key, value, nesting depth, and the flattened list of child items or nested sub-groups.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

type
required
'group'
Discriminant literal — always "group". Used to distinguish group nodes from item nodes at runtime.
depth
required
number
Nesting depth of this group (0 = top-level, 1 = nested, …).
id
required
string
Stable unique id for this group node, used as the key in the opened set.
key
required
string
Column key this group was built from (matches the groupBy sortItem key).
value
required
any
The shared value of this group (e.g. the department name when grouping by department).
items
required
Array<(T | IDataTableGroup<T>)>
Children of this group — either data items or nested IDataTableGroup nodes when groupBy has multiple levels.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Grouping rows by department

vue