ITreeDataSettings
Settings for configuring tree data behavior Supports two modes:
- Mode 1 (Nested): Set treeDataChildrenField to specify field with children array
- Mode 2 (Parent ID): Set both treeDataIdMapping and treeDataParentIdField
Both modes are mutually exclusive; using both will throw an error.
Props
The following table outlines the props for the ITreeDataSettings:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Enable or disable tree data mode |
| excludeChildrenWithFiltering | boolean | false | Excludes child rows from a filtered tree result when the parent row matches the active filter. |
| treeColumnIndex | number | 0 | Column index where tree expand/collapse UI should render Specifies which column (by index position) displays the expand/collapse buttons and indentation for tree nodes. Index is 0-based. |
| treeDataChildrenField | string | - | Field name containing children array (Mode 1: Nested data) Example: 'children', 'teams', 'employees' When set, data is expected as nested objects where children are stored in the specified field as an array. |
| treeDataIdMapping | string | - | Field name for unique ID (Mode 2: Parent ID references) Example: 'id', 'employeeId', 'nodeId' Used to identify nodes when using parent ID mapping mode. Required when treeDataParentIdField is set. |
| treeDataParentIdField | string | - | Field name containing parent ID reference (Mode 2: Parent ID references) Example: 'parentId', 'managerId', 'parentNodeId' Nodes with null or undefined parent ID are treated as root nodes. Required when treeDataIdMapping is set. |