Skip to main content
Version: 2025.2

GanttViewTemplate

This page provides generated reference documentation for the GanttViewTemplate data model.

Displays a Gantt chart, with the data source being certain fields of a special entity. In property "columns", you can specify arbitrary fields to be shown left of each bar.

Overview

PropertySummary
autoNewRowDetermines if a new row should be added automatically, if the record state is NEW
beginDateFieldDefines the beginDate of a Step. This is required to correct the length of the step and when the step starts.
childrenList of children in this container
colspanThe colspan of the element.
columnsContains all defined columns for this component.
descriptionFieldDefines the description, which is displayed in the tooltip of a step.
devicesDetermines on wich devices the component should be available.
endDateFieldDefines the endDate of a Step. This is required to correct the length of the step and when the step is over.
entityFieldThis property is mandatory. Its value must be set to 1. #ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View…
favoriteActionGroup1First action group to place additional actions in
favoriteActionGroup2Second action group to place additional actions in
favoriteActionGroup3Third action group to place additional actions in
groupByRootElementsIf this box is checked, the arrows from the first level (root element) to the second level is not displayed.
hideArrowsIf this box is checked, all the arrows in the gantt chart will not displayed.
initialEndDateFieldDefines the entityfield in which the initialEndDateField is located.
initialStartDateFieldDefines the entityfield in which the initialStartDate is located.
isCreatableCreatable yes/no.
isDeletableDeletable yes/no.
isEditableEditable yes/no.
isSubstepThis Bool defines, if the row is a standalone Step or a Sub Step of the parent Step. If the transferred value is true, this line is integrated as a sub-step in…
predecessorIdFieldDefines the entityfield in which the PredecessorId is located.
rowspanThe rowspan of the element.
stepColorFieldDepending on this property, the steps can be shown in another color than their successors
stepProgressDefines the entityfield in which the stepProgress is located.
titleTitle of the component
titleFieldDefines the Title, which is displayed in the Step.
uidFieldDefines the entityfield in which the UID is located.

autoNewRow

Type: Boolean

Determines if a new row should be added automatically, if the record state is NEW


beginDateField

Type: String

Defines the beginDate of a Step. This is required to correct the length of the step and when the step starts.


children

Type: Children

List of children in this container


colspan

Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE

The colspan of the element.


columns

Type: Column

Contains all defined columns for this component.


descriptionField

Type: String

Defines the description, which is displayed in the tooltip of a step.


devices

Type: EDeviceType[]

Determines on wich devices the component should be available.

The default value states that the component is available on all devices. If one or more devices are selected then the component is only available for those selected devices.


endDateField

Type: String

Defines the endDate of a Step. This is required to correct the length of the step and when the step is over.


entityField

Type: String

This property is mandatory. Its value must be set to

  1. #ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View (default).
  2. a single EntityField, if the ViewTemplate uses only this one single EntityField (example: WebContentViewTemplate).

The second option will result in a performance optimization.


favoriteActionGroup1

Type: String

First action group to place additional actions in


favoriteActionGroup2

Type: String

Second action group to place additional actions in


favoriteActionGroup3

Type: String

Third action group to place additional actions in


groupByRootElements

Type: Boolean
Default: false

If this box is checked, the arrows from the first level (root element) to the second level is not displayed.


hideArrows

Type: Boolean
Default: false

If this box is checked, all the arrows in the gantt chart will not displayed.


initialEndDateField

Type: String

Defines the entityfield in which the initialEndDateField is located.

This is used to set the time limit for the timeline in the Gantt. If there are steps that come after the initialStartDate, they are shown in the TreeTable, but not in the Gantt.


initialStartDateField

Type: String

Defines the entityfield in which the initialStartDate is located.

This is used to set the time limit for the timeline in the Gantt. If there are steps that come before the initialStartDate, they are shown in the TreeTable, but not in the Gantt.


isCreatable

Type: Boolean
Default: false

Creatable yes/no.


isDeletable

Type: Boolean
Default: true

Deletable yes/no.


isEditable

Type: Boolean
Default: true

Editable yes/no.


isSubstep

Type: String

This Bool defines, if the row is a standalone Step or a Sub Step of the parent Step. If the transferred value is true, this line is integrated as a sub-step in the higher-level step.


predecessorIdField

Type: String

Defines the entityfield in which the PredecessorId is located.

This serves as the parent/child mapping for the rows of a TreeTable.


rowspan

Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE

The rowspan of the element.


stepColorField

Type: String

Depending on this property, the steps can be shown in another color than their successors


stepProgress

Type: String

Defines the entityfield in which the stepProgress is located.

This is displayed in a level and transferred as a percentage. The range of values is from 0 to 100


title

Type: String
Constraints: Verification: TITLE_LENGTH

Title of the component


titleField

Type: String

Defines the Title, which is displayed in the Step.


uidField

Type: String

Defines the entityfield in which the UID is located.

This serves as the parent/child mapping for the rows of a TreeTable.