GroupsDataTableBuilder

A GroupsDataTableBuilder is used to setup and build two-dimensional arrays containing groups.

Constructors

Constructor

new GroupsDataTableBuilder(groups): GroupsDataTableBuilder;

Parameters

Parameter	Type
groups	Group[]

Returns

GroupsDataTableBuilder

Methods

build()

build(): any[][];

Builds a two-dimensional array containing all Groups.

Returns

any[][]

A two-dimensional array containing all Groups

---

hiddenProperties()

hiddenProperties(include): GroupsDataTableBuilder;

Defines whether to include hidden properties (keys ending with underscore ”_”). Only relevant when properties is enabled. Default is false — hidden properties are excluded.

Parameters

Parameter	Type	Description
include	boolean	Whether to include hidden properties

Returns

GroupsDataTableBuilder

This builder with respective option, for chaining.

---

ids()

ids(include): GroupsDataTableBuilder;

Defines whether include group ids.

Parameters

Parameter	Type	Description
include	boolean	Whether to include ids

Returns

GroupsDataTableBuilder

This builder with respective include ids option, for chaining.

---

properties()

properties(include): GroupsDataTableBuilder;

Defines whether include custom group properties.

Parameters

Parameter	Type	Description
include	boolean	Whether to include properties

Returns

GroupsDataTableBuilder

This builder with respective include properties option, for chaining.

---

tree()

tree(enable): GroupsDataTableBuilder;

Defines whether to render groups as an indented tree instead of flat rows with a Parent column. When enabled, child group names are indented by depth level and the Parent column is removed. Default is false.

Parameters

Parameter	Type	Description
enable	boolean	Whether to enable tree rendering

Returns

GroupsDataTableBuilder

This builder with respective option, for chaining.