Skip to content

Commit 1bbf116

Browse files
NansiYanchevadimodiikoevska
authored
docs(Gantt): document model types (#2308)
* docs(Gantt): document model types * Update components/gantt/gantt-tree/data-binding/overview.md Co-authored-by: Iva Stefanova Koevska-Atanasova <[email protected]> --------- Co-authored-by: Dimo Dimov <[email protected]> Co-authored-by: Iva Stefanova Koevska-Atanasova <[email protected]>
1 parent 7560dec commit 1bbf116

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

components/gantt/gantt-tree/data-binding/overview.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ The Blazor Gantt Tree provides various parameters to configure its items. Also,
3434
| Parameter | Description |
3535
| --- | --- |
3636
| `EndField` | Defines the end date of a task. |
37-
| `HasChildren` | Whether the item has children. Determines whether an expand arrow is rendered next to the item in an Expandable column. Required when loading data on-demand—if you don't set it to `true`, an expand arrow will not appear and the user will not be able to expand the item and load its children. With hierarchical data, the Gantt Tree will render the icon based on the existence of child items, but `HasChildren` will take precedence. You do not have to set or use its field unless you want to load data on demand or override the arrow for some items. |
38-
| `Id` | A unique identifier for the item. Required only for binding to flat data. |
39-
| `Items` | The collection of child items that will be rendered under the current item. Required only when binding to hierarchical data. |
40-
| `ParentId` | Identifies the parent to whom the item belongs. Required only when binding to flat data. All items with the same `ParentId` will be rendered at the same level. For a root level item, `ParentId` needs to be `null`. There needs to be at least one node with a `null` value for the `ParentId`. |
37+
| `HasChildrenField` | Whether the item has children. Determines whether an expand arrow is rendered next to the item in an Expandable column. Required when loading data on demand—if you don't set it to `true`, an expand arrow will not appear and the user will not be able to expand the item and load its children. With hierarchical data, the Gantt Tree will render the icon based on the existence of child items, but `HasChildren` will take precedence. You do not have to set or use its field unless you want to load data on demand or override the arrow for some items. |
38+
| `IdField` | A unique identifier for the item. Required only for binding to flat data. |
39+
| `ItemsField` | The collection of child items that will be rendered under the current item. Required only when binding to hierarchical data. |
40+
| `ParentIdField` | Identifies the parent to whom the item belongs. Required only when binding to flat data. All items with the same `ParentId` will be rendered at the same level. For a root level item, `ParentId` needs to be `null`. There needs to be at least one node with a `null` value for the `ParentId`. |
4141
| `PercentCompleteField` | Defines the level of completion of a task in percentages. |
4242
| `StartField` | Defines the start date of a task. |
4343
| `TitleField` | Defines what's the title of a task in percentages. |
@@ -46,14 +46,16 @@ The Blazor Gantt Tree provides various parameters to configure its items. Also,
4646

4747
The properties of a Gantt Tree item match directly to a field of the model the treelist is bound to. Provide that relationship by providing the name of the field from which the corresponding information is to be taken. To do this, in the main `TelerikGantt` tag, use the parameters described below:
4848

49-
* EndField => End
50-
* HasChildrenField => HasChildren
51-
* IdField => Id
52-
* ItemsField => Items
53-
* ParentIdField => ParentId
54-
* PercentCompleteField => PercentComplete
55-
* StartField => Start
56-
* TitleField => Title
49+
| Model Field Name | Model Field Type | Gantt Parameter |
50+
| --- | --- | --- |
51+
| End | `DateTime` | `EndField` |
52+
| HasChildren | `bool` | `HasChildrenField` |
53+
| Id | `object` | `IdField`|
54+
| Items | `IEnumerable<TItem>` | `ItemsField` |
55+
| ParentId | `object` | `ParentIdField` |
56+
| PercentComplete | `double` | `PercentCompleteField` |
57+
| Start | `DateTime` | `StartField` |
58+
| Title | `string` | `TitleField` |
5759

5860
## Notes
5961

0 commit comments

Comments
 (0)