Skip to main content
Only one Work Items Gantt widget is supported per Polarion wiki page.

Core Parameters

ParameterTypeDefaultDescription
Work ItemsDatasetSee applicationStandard Polarion dataset parameter. Select which work items to display using query, collection, or scope.
Sort byStringidSort criteria for top-level work items in the Gantt grid.
Load ChildrenInteger0Number of child levels to traverse and add to the list. 0 means no additional items beyond the dataset.
Show UnplannedBooleantrueWhen yes, work items without a Start Field value are shown at today’s date in gray. When no, they are hidden.
ScaleEnumWTimeline scale unit. Values: H (hour), DD (bi-daily), D (day), W (week), M (month), Y (year), YY (multi-year).

Hierarchy and Dependencies

ParameterTypeDefaultDescription
Parent RoleMulti-select (link roles)EmptyWork item link roles used to detect parent-child relationships. If empty, no hierarchy is shown.
Dependency RoleMulti-select (link roles)EmptyWork item link roles used to detect dependency relationships. If empty, no dependency arrows are shown. The first selected role is used when creating new dependency links by dragging.
Project TypesMulti-select (work item types)EmptyWork item types displayed as “project” (summary) items. Their schedule is derived from child items. Does not extend the visible dataset.
Milestone TypesMulti-select (work item types)EmptyWork item types displayed as “milestone” items (zero duration, diamond shape). Does not extend the visible dataset.

Data Mapping

These parameters map Polarion work item fields to Gantt scheduling data. See Data Mapping Parameters for details.
ParameterTypeDefaultDescription
Start FieldStringgantt_startWork item field storing the task start date. Supports Date, DateTime, or String field types.
End FieldStringNoneWork item field storing the task end date. Supports Date, DateTime, or String field types.
Duration FieldStringgantt_durationWork item field storing the task duration in days. Supports Integer or String field types.
Progress FieldStringgantt_progressWork item field storing the task progress as a float (0.0 to 1.0). Supports Float or String field types.
Duration PrecisionEnumStandard (Days)Precision mode. Standard (Days) uses day-based durations. High (Hours) stores durations in hours and displays times.
Configure at least two of the three date fields: Start Field + Duration Field, End Field + Duration Field, or Start Field + End Field. For production use, define proper custom fields with the recommended types (Date, Integer, Float) rather than relying on ad-hoc string fields.

Advanced Parameters

ParameterTypeDefaultDescription
Maximize ViewBooleanfalseExpands the Gantt widget to fill the full working area of the Polarion page.
Hide ToolbarBooleanfalseHides the Gantt toolbar. Implicitly sets Always Edit to true. A floating save button appears instead.
Always EditBooleanfalseOpens the Gantt directly in edit mode without the sidebar detail panel.
Drag ChildrenBooleantrueWhen dragging a parent task, child tasks are rescheduled by the same offset.
Max ItemsInteger100Maximum number of work items loaded into the Gantt view.
Show Today MarkerBooleantrueDisplays a vertical line on today’s date in the Gantt chart.
Progress ColoringBooleantrueColor-codes task bars based on their progress percentage.
Read OnlyBooleanfalsePrevents all edits. Also automatically set when the user has no license or a Polarion baseline is active.
Sidebar FieldsField listSee applicationWork item fields displayed in the detail sidebar panel when a task is clicked.

Scripting Parameters

ParameterTypeDefaultDescription
Gantt Config ScriptScriptEmptyClient-side JavaScript snippet for advanced configuration. Executed after the Gantt initializes. See Gantt Config Script API.
Item ScriptScriptEmptyServer-side JavaScript snippet executed per task to customize appearance. See Item Script API.
Markers ScriptScriptEmptyServer-side JavaScript snippet for creating timeline markers. See Marker Factory API.

Configuration Example

A typical Work Items Gantt configuration for a project using parent-child hierarchy and finish-to-start dependencies:
  • Work Items: Query selecting all task and workPackage items in the current project
  • Parent Role: parent
  • Dependency Role: depends_on
  • Project Types: workPackage
  • Milestone Types: release
  • Start Field: gantt_start
  • Duration Field: gantt_duration
  • Progress Field: gantt_progress
  • Scale: W
  • Load Children: 2

See Also

KB ArticlesSupport TicketsSource Code
  • prod-gantt-src/com.nextedy.polarion.gantt/src/com/nextedy/polarion/gantt/model/impl/types/TypeConfigWidgetParameters.java
  • prod-gantt-src/com.nextedy.polarion.gantt/src/com/nextedy/polarion/gantt/widget/GanttWidget.java
  • prod-gantt-src/com.nextedy.polarion.gantt/src/com/nextedy/polarion/gantt/widget/GanttWidgetConfig.java
  • prod-gantt-src/com.nextedy.polarion.gantt/src/com/nextedy/polarion/gantt/widget/WorkItemsGanttWidget.java
  • prod-gantt-src/com.nextedy.polarion.gantt/src/com/nextedy/polarion/gantt/model/impl/ProjectWorkItemEnumProvider.java