Interface CellGroupIf

One node of a grouped header (AreaModelCellGroups): a group with children, or a leaf with a property (a leaf becomes a column).

Example

const groups: CellGroupIf[] = [
{ data: "Order", children: [{ data: "ID", property: "id" }, { data: "Date", property: "date" }] },
{ data: "Customer", toggle: true, children: [
{ data: "Customer", property: "customer", visibility: "always" }, // stays visible when collapsed
{ data: "City", property: "city" }] }
];
const columnDefs = CellgroupFactory.buildColumnDefs(CellgroupFactory.buildGroupExts(groups));
const header = new AreaModelCellGroups("header", groups, columnDefs, 34);

See

Training: Header models: multi-row and grouped

Hierarchy

  • CellGroupIf

Implemented by

Properties

children?: CellGroupIf[]

Sub-groups or columns.

closed?: boolean

Current state: collapsed.

data: any

The label of the group or column.

impl?: string

Internal: the implementation type of the node.

property?: string

Set on leaves only: the property shown in this column.

toggle?: boolean

Show a ❯ toggle so that the user can collapse / expand the group.

visibility?: "normal" | "always" | "inverted"

When is this child visible? "always" – also when the group is collapsed; "inverted" – only when collapsed (e.g. a summary column); "normal" / undefined – only when expanded.