This article explains the different ways to provide data to a Gantt Chart component and the properties related to data binding. Reviewing this article will explain the basics of how you can describe the hierarchy of items in your data source to the Gantt component so they can render.
For details on Value Binding and Data Binding, and the differences between them, see the Value Binding vs Data Binding article.
- The available (bindable) features of a Gantt Tree item.
- How to match fields in the model with the Gantt Tree item data bindings.
There are two modes of providing data to a Gantt Tree, and they all use the items' features. Once you are familiar with the current article, choose the data binding you wish to use more:
Flat data - a single collection of items with defined parent-child relationships. See the
Hierarchical data - separate collections of items and their child items. This is the default mode of the component. See the
The Gantt Tree items provide the following features that you can control through the corresponding fields in their data binding:
Items- the collection of child items that will be rendered under the current item. Required only when binding to hierarchical data.
Id- a unique identifier for the item. Required only for binding to flat data.
ParentId- identifies the parent to whom the item belongs. Required only when binding to flat data. All items with the same
ParentIdwill be rendered at the same level. For a root level item,
null. There must be at least one node with a
nullvalue for the
HasChildren- whether the item has children. Determines whether an expand arrow is rendered next to the item in an Expandable column. Required for loading data on-demand - if you don't set it to
true, there will be no expand arrow and so there will be no way for the user 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
HasChildrenwill 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.
The properties of a Gantt Tree item match directly to a field of the model the treelist is bound to. You 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:
- IdField => Id
- ParentIdField => ParentId
- HasChildrenField => HasChildren
- ItemsField => Items
- The Gantt is designed to work with a collection of strongly typed models (e.g.,
IENumerable<SomeDataModel>). If you provide an
IEnumerable<object>instead, you must set the
<GanttColumn>instances to the data type of the fields they use (e.g.,
<GanttColumn Field=@nameof(Employee.Name) FieldType="@(typeof(string))" />).