> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nextedy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Plans Gantt Widget Parameters

> Complete reference for all Nextedy GANTT Plans Gantt widget parameters.

export const LastReviewed = ({date}) => {
  if (!date) return null;
  const formatted = new Date(`${date}T00:00:00Z`).toLocaleDateString("en-US", {
    year: "numeric",
    month: "long",
    day: "numeric",
    timeZone: "UTC"
  });
  return <p className="mt-10 text-sm text-gray-400 dark:text-zinc-500 not-prose">
      Last reviewed on {formatted}
    </p>;
};

<Note title="One widget per page">
  Only one Gantt widget (Work Items or Plans) is supported per Polarion wiki page.
</Note>

## Core Parameters

| Parameter        | Type    | Default         | Description                                                                                                                                 |
| ---------------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `Plans`          | Dataset | See application | Standard Polarion dataset parameter. Select which plans to display using query, collection, or scope.                                       |
| `Sort by`        | String  | `id`            | Sort criteria for top-level plan items.                                                                                                     |
| `Load Children`  | Integer | `0`             | Number of child plan levels to traverse and add. `0` means only top-level plans are shown.                                                  |
| `Show Unplanned` | Boolean | `true`          | When `yes`, plans without start dates are shown at today's date in gray. When `no`, they are hidden.                                        |
| `Scale`          | Enum    | `W`             | Timeline scale unit. Values: `H` (hour), `DD` (bi-daily), `D` (day), `W` (week), `M` (month), `Q` (quarter), `Y` (year), `YY` (multi-year). |

<Tip>
  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.
</Tip>

## Show Plan Work Item Section

When enabled, work items belonging to each plan are displayed beneath the plan bar in the Gantt hierarchy.

| Parameter           | Type                      | Default         | Description                                                                 |
| ------------------- | ------------------------- | --------------- | --------------------------------------------------------------------------- |
| `Enable Show Items` | Boolean                   | `false`         | Enables displaying work items within plans on the Gantt chart.              |
| `Start Field`       | String                    | See application | Work item field storing the task start date (when showing plan work items). |
| `End Field`         | String                    | See application | Work item field storing the task end date.                                  |
| `Duration Field`    | String                    | See application | Work item field storing the task duration.                                  |
| `Progress Field`    | String                    | See application | Work item field storing the task progress (0.0 to 1.0).                     |
| `Parent Role`       | Multi-select (link roles) | Empty           | Link roles for parent-child hierarchy among work items within a plan.       |
| `Dependency Role`   | Multi-select (link roles) | Empty           | Link roles for dependency arrows among work items within a plan.            |

## Advanced Parameters

| Parameter               | Type                  | Default         | Description                                                                                                                            |
| ----------------------- | --------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `Maximize View`         | Boolean               | `false`         | Expands the Gantt widget to fill the full working area.                                                                                |
| `Height`                | Integer               | See application | Fixed pixel height of the Plans Gantt panel.                                                                                           |
| `Hide Toolbar`          | Boolean               | `false`         | Hides the toolbar. Implicitly enables always-edit mode.                                                                                |
| `Drag Children`         | Boolean               | `true`          | Rescheduling a parent plan also moves child plans by the same offset.                                                                  |
| `Max Items`             | Integer               | `100`           | Maximum number of plans loaded into the Gantt view.                                                                                    |
| `Progress Coloring`     | Boolean               | `true`          | Color-codes plan bars based on progress percentage.                                                                                    |
| `Read-only`             | Boolean               | `false`         | Prevents edits to the Plans Gantt.                                                                                                     |
| `Show Today Marker`     | Boolean               | `true`          | Displays a vertical line on today's date.                                                                                              |
| `Override Today's Date` | String (`YYYY-MM-DD`) | Empty           | Overrides the date treated as "today" on the chart.                                                                                    |
| `Working Time`          | Boolean               | See application | Enables legacy working time mode (weekends as non-working). For advanced calendar features, use the Working Calendars section instead. |

## Scripting Parameters

| Parameter             | Type   | Default | Description                                                                                                               |
| --------------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------- |
| `Gantt Config Script` | Script | Empty   | Client-side JavaScript for advanced configuration. See [Gantt Config Script API](/gantt/reference/api/config-script-api). |
| `Item Script`         | Script | Empty   | Server-side JavaScript per plan item for custom decoration. See [Item Script API](/gantt/reference/api/item-script-api).  |
| `Markers Script`      | Script | Empty   | Server-side JavaScript for creating timeline markers. See [Marker Factory API](/gantt/reference/api/markers-api).         |

<Warning>
  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.
</Warning>

## 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`

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/umKaPvHwUHw-ZQFM/gantt/diagrams/reference/widget-parameters/plans-gantt/diagram-1.svg?fit=max&auto=format&n=umKaPvHwUHw-ZQFM&q=85&s=578d4a8354c57746be9d2c4eaa0b34f8" alt="diagram" style={{ maxWidth: "520px", width: "100%" }} width="520" height="280" data-path="gantt/diagrams/reference/widget-parameters/plans-gantt/diagram-1.svg" />
</Frame>

## Administration Defaults

Plans Gantt widget parameter defaults can be set in **Administration > Configuration Properties**:

| Property                                        | Default | Description               |
| ----------------------------------------------- | ------- | ------------------------- |
| `nextedy.gantt.plans.default.sort_by`           | `id`    | Default sort field        |
| `nextedy.gantt.plans.default.expand_level`      | `0`     | Default child levels      |
| `nextedy.gantt.plans.default.show_unplanned`    | `true`  | Default show unplanned    |
| `nextedy.gantt.default.plans.scale`             | `W`     | Default scale             |
| `nextedy.gantt.plans.default.maximize_view`     | `false` | Default maximize          |
| `nextedy.gantt.plans.default.hide_toolbar`      | `false` | Default hide toolbar      |
| `nextedy.gantt.plans.default.progress_coloring` | `true`  | Default progress coloring |
| `nextedy.gantt.plans.default.drag_children`     | `true`  | Default drag children     |

## See Also

* [Work Items Gantt Widget Parameters](/gantt/reference/widget-parameters/work-items-gantt)
* [Data Mapping Parameters](/gantt/reference/widget-parameters/data-mapping)
* [Set Up a Plans Gantt Chart](/gantt/getting-started/setup-plans-gantt)
* [Show Plans and Work Items Together](/gantt/guides/plans/plans-and-work-items)
* [Configure Multiple Plan Levels](/gantt/guides/plans/plan-level-configuration)

<LastReviewed date="2026-07-07" />