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

Core Parameters

ParameterTypeDefaultDescription
PlansDatasetSee applicationStandard Polarion dataset parameter. Select which plans to display using query, collection, or scope.
Sort byStringidSort criteria for top-level plan items.
Load ChildrenInteger0Number of child plan levels to traverse and add. 0 means only top-level plans are shown.
Show UnplannedBooleantrueWhen yes, plans without start dates 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).
Plans typically span longer time ranges than individual work items. Use W (week), M (month), or Y (year) scale for better readability of plan-level scheduling.

Show Plan Work Item Section

When enabled, work items belonging to each plan are displayed beneath the plan bar in the Gantt hierarchy.
ParameterTypeDefaultDescription
Enable Show ItemsBooleanfalseEnables displaying work items within plans on the Gantt chart.
Start FieldStringSee applicationWork item field storing the task start date (when showing plan work items).
End FieldStringSee applicationWork item field storing the task end date.
Duration FieldStringSee applicationWork item field storing the task duration.
Progress FieldStringSee applicationWork item field storing the task progress (0.0 to 1.0).
Parent RoleMulti-select (link roles)EmptyLink roles for parent-child hierarchy among work items within a plan.
Dependency RoleMulti-select (link roles)EmptyLink roles for dependency arrows among work items within a plan.

Advanced Parameters

ParameterTypeDefaultDescription
Maximize ViewBooleanfalseExpands the Gantt widget to fill the full working area.
Hide ToolbarBooleanfalseHides the toolbar. Implicitly enables always-edit mode.
Drag ChildrenBooleantrueRescheduling a parent plan also moves child plans by the same offset.
Max ItemsInteger100Maximum number of plans loaded into the Gantt view.
Progress ColoringBooleantrueColor-codes plan bars based on progress percentage.
Working TimeBooleanSee applicationEnables legacy working time mode (weekends as non-working). For advanced calendar features, use the Working Calendars section instead.

Scripting Parameters

ParameterTypeDefaultDescription
Gantt Config ScriptScriptEmptyClient-side JavaScript for advanced configuration. See Gantt Config Script API.
Item ScriptScriptEmptyServer-side JavaScript per plan item for custom decoration. See Item Script API.
Markers ScriptScriptEmptyServer-side JavaScript for creating timeline markers. See Marker Factory API.
The Sort by parameter controls the order of top-level plan items, but custom sorting options for plans are more limited than for work items. Plans cannot be sorted via the same parameter-based mechanisms available in the Work Items Gantt.

Configuration Example

A typical Plans Gantt configuration for release and iteration planning:
  • Plans: Query selecting all plans with template Release
  • Load Children: 2 (to show iterations under releases and work items under iterations)
  • Enable Show Items: true
  • Start Field: gantt_start
  • Duration Field: gantt_duration
  • Parent Role: parent
  • Dependency Role: depends_on
  • Scale: M
  • Maximize View: true
diagram

Administration Defaults

Plans Gantt widget parameter defaults can be set in Administration > Configuration Properties:
PropertyDefaultDescription
nextedy.gantt.plans.default.sort_byidDefault sort field
nextedy.gantt.plans.default.expand_level0Default child levels
nextedy.gantt.plans.default.show_unplannedtrueDefault show unplanned
nextedy.gantt.default.plans.scaleWDefault scale
nextedy.gantt.plans.default.maximize_viewfalseDefault maximize
nextedy.gantt.plans.default.hide_toolbarfalseDefault hide toolbar
nextedy.gantt.plans.default.progress_coloringtrueDefault progress coloring
nextedy.gantt.plans.default.drag_childrentrueDefault drag children

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/GanttWidgetConfig.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/PlansGanttWidget.java
  • prod-gantt-src/com.nextedy.polarion.gantt/webapp/pageparams/pageparams.html