Gantt
Overview
The Gantt ViewTemplate renders an editable Gantt chart based on specific EntityFields of a defined Entity. The chart visually represents a project structure composed of multiple steps, each of which includes a start date, an end date, and optionally a predecessor step. Steps without a defined predecessor are displayed at the top level of the chart hierarchy. Depending on the value of the stepColorField property, these steps can be visually distinguished by color from their successors.
The Gantt chart is divided into two main areas:
- On the left, a tree structure lists project steps in a hierarchical manner.
- On the right, a calendar displays horizontal bars representing the duration of each step.
Each step's position and hierarchical relationship within the chart is determined by two configuration properties:
predecessorIdField: Specifies the EntityField that contains the ID of the predecessor step.isSubstep: A boolean EntityField (value"TRUE"or"FALSE") indicating whether a step is a substep of its predecessor. If"TRUE", the step's duration bar is visually integrated within the bar of the parent step. If"FALSE", it appears below the parent's bar in the timeline.
When the ViewTemplate is set to edit mode, users can interactively adjust step durations by moving the bars to change start and end dates directly in the client interface.
Although the Gantt ViewTemplate can technically retrieve data from various RecordContainers, it is most commonly backed by a JDitoRecordContainer.
Client Integration
The Gantt chart is, e.g., implemented in the ViewTemplate AllCampaignsOverviewGantt, which belongs to the CampaignPlanning_view. It can be accessed in the ADITO client under the menu path:
Marketing > Campaign Planning
Configuration
This example represents a non-editable Gantt ViewTemplate with a minimal configuration set. The following properties are explicitly defined:
| Property | Description |
|---|---|
columns | Specifies arbitrary EntityFields to be displayed in the left column of the chart. |
uidField | The unique identifier for each step. This value is also used to map parent/child relationships. |
titleField | Defines the text label shown inside the duration bar of each step. |
descriptionField | Sets the tooltip text that appears on hover over a step bar. |
beginDateField | Maps the EntityField containing the start date of the step. |
endDateField | Maps the EntityField containing the end date of the step. |
predecessorIdField | Determines the EntityField used to define predecessor relationships between steps. |
This configuration does not include a setting for isSubstep. As a result, steps are displayed one level beneath their respective predecessors in a strictly nested tree structure.
Since this Gantt ViewTemplate is not editable, users cannot modify step durations through drag-and-drop interactions in the client.
Data Source and Behavior
The ViewTemplate relies on the EntityFields of CampaignPlanning_entity, which are managed by a JDitoRecordContainer.
To understand how the Gantt chart's data is constructed and how its fields interact, it is recommended to review the implementation details of the associated JDitoRecordContainer.