@serenity-is/corelib / TreeGridMixin
Class: TreeGridMixin<TItem>
A mixin that can be applied to a DataGrid for tree functionality
Type parameters
| Name |
|---|
TItem |
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new TreeGridMixin<TItem>(options)
Type parameters
| Name |
|---|
TItem |
Parameters
| Name | Type |
|---|---|
options |
TreeGridMixinOptions<TItem> |
Defined in
src/ui/datagrid/treegridmixin.ts:14
Properties
dataGrid
• Private dataGrid: DataGrid<TItem, any>
Defined in
src/ui/datagrid/treegridmixin.ts:11
getId
• Private getId: (item: TItem) => any
Type declaration
▸ (item): any
Parameters
| Name | Type |
|---|---|
item |
TItem |
Returns
any
Defined in
src/ui/datagrid/treegridmixin.ts:12
options
• Private options: TreeGridMixinOptions<TItem>
Defined in
src/ui/datagrid/treegridmixin.ts:14
Methods
collapseAll
▸ collapseAll(): void
Returns
void
Defined in
src/ui/datagrid/treegridmixin.ts:66
expandAll
▸ expandAll(): void
Returns
void
Defined in
src/ui/datagrid/treegridmixin.ts:71
toggleAll
▸ toggleAll(): void
Expands / collapses all rows in a grid automatically
Returns
void
Defined in
src/ui/datagrid/treegridmixin.ts:59
applyTreeOrdering
▸ Static applyTreeOrdering<TItem>(items, getId, getParentId): TItem[]
Reorders a set of items so that parents comes before their children. This method is required for proper tree ordering, as it is not so easy to perform with SQL.
Type parameters
| Name |
|---|
TItem |
Parameters
| Name | Type | Description |
|---|---|---|
items |
TItem[] |
list of items to be ordered |
getId |
(item: TItem) => any |
a delegate to get ID of a record (must return same ID with grid identity field) |
getParentId |
(item: TItem) => any |
a delegate to get parent ID of a record |
Returns
TItem[]