Interface GridDataSourceGroupNode

interface GridDataSourceGroupNode {
    children: GridRowId[];
    childrenExpanded?: boolean;
    childrenFromPath: GridChildrenFromPathLookup;
    depth: number;
    footerId?: null | GridRowId;
    groupingField: null | string;
    groupingKey: null | GridKeyValue;
    id: GridRowId;
    isAutoGenerated: false;
    isPinned?: boolean;
    parent: null | GridRowId;
    path: string[];
    serverChildrenCount: number;
    type: "group";
}

Hierarchy (view full)

Properties

children childrenExpanded? childrenFromPath depth footerId? groupingField groupingKey id isAutoGenerated isPinned? parent path serverChildrenCount type

Properties

children

children: GridRowId[]

The id of the body children nodes. Only contains the children of type "group" and "leaf".

OptionalchildrenExpanded

childrenExpanded?: boolean

If true, the children of this group are not visible.

Default

false

childrenFromPath

childrenFromPath: GridChildrenFromPathLookup

The id of the children nodes, grouped by grouping field and grouping key. Only contains the children of type "group" and "leaf". Empty for flat tree.

depth

depth: number

Depth of this node in the tree.

OptionalfooterId

footerId?: null | GridRowId

The id of the footer child node.

groupingField

groupingField: null | string

The field used to group the children of this row. Is null if no field has been used to group the children of this row.

groupingKey

groupingKey: null | GridKeyValue

The key used to group the children of this row.

id

id: GridRowId

The uniq id of this node.

isAutoGenerated

isAutoGenerated

If true, this node has been automatically generated by the grid. In the row grouping, all groups are auto-generated In the tree data, some groups can be passed in the rows

OptionalisPinned

isPinned?: boolean

If true, this row is pinned.

Default

false

parent

parent: null | GridRowId

The id of the group containing this node (null for the root group).

path

path: string[]

The cached path to be passed on as groupKey to the server.

serverChildrenCount

serverChildrenCount: number

Number of children this node has on the server. Equals to -1 if there are some children but the count is unknown.

type

type

Settings

Member Visibility

On This Page

Properties