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

# Configure Page Parameters

> This guide shows you how to add dynamic user inputs to your Nextedy GANTT widget using Polarion Page Parameters, enabling users to filter and customize the Gantt view without editing the page.

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>;
};

**Since: Version 4.6.0**

## Prerequisites

* A Gantt widget on a Polarion LiveDoc or Wiki page
* Permission to edit page and widget parameters
* Understanding of Polarion query syntax

## How Page Parameters Work

Page parameters let users provide input values -- such as a version number, team name, or date range -- that dynamically modify the Gantt query. Instead of hard-coding filters into the widget configuration, you define parameters that users can change at runtime.

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/umKaPvHwUHw-ZQFM/gantt/diagrams/guides/layout/page-parameters/diagram-1.svg?fit=max&auto=format&n=umKaPvHwUHw-ZQFM&q=85&s=b44a9a6092afb8b9e33923cbb35b273a" alt="diagram" style={{ maxWidth: "700px", width: "100%" }} width="700" height="80" data-path="gantt/diagrams/guides/layout/page-parameters/diagram-1.svg" />
</Frame>

## Set Up Page Parameters

Follow these four steps to configure page parameters with a maximized Gantt view:

### Step 1: Add the Page Parameters Widget

1. Edit the Polarion page
2. Add a **Page Parameters** widget to the top of the page
3. Add the **Gantt widget** below it
4. **Keep Maximize turned OFF** on the Gantt widget at this stage

### Step 2: Define Your Parameters

1. In the Page Parameters widget, add the parameters you need (for example, a "Version" dropdown or a "Team" text input)
2. In the Gantt widget configuration, reference the page parameters in your query

### Step 3: Test the Configuration

1. Save the page and view it in normal mode
2. Set different parameter values in the Page Parameters widget at the top
3. Verify that the Gantt data updates to reflect the selected filters

### Step 4: Enable Maximize Mode

1. Edit the page again
2. Set the Gantt widget's **Advanced > Maximize** parameter to **Yes**
3. Save the page

The Page Parameters widget is now hidden behind the ⚙️ **Settings** toolbar button. Users click this button to open the parameters panel within the maximized Gantt view.

<Warning title="Use Lucene + Velocity query type">
  Page parameters only work when the Gantt widget's query is configured as **Lucene + Velocity** type. If you use a pure Lucene query, page parameter substitution will not function. Change the query type to Lucene + Velocity in the widget's data set configuration.
</Warning>

## The Page Parameters Toolbar Button

The `tb_parameters` toolbar button (displayed as a ⚙️ Settings icon) appears **only** when the Gantt is in maximized view. Clicking it opens a modal dialog where users can:

* View and modify all defined page parameters
* Apply changes that reload the Gantt with updated filters
* Close the dialog by clicking the X button or pressing **Escape**

| Condition                                 | Parameters Button Visible                     |
| ----------------------------------------- | --------------------------------------------- |
| `maximize = true` and page has parameters | Yes                                           |
| `maximize = false`                        | No (parameters widget shown directly on page) |
| `MaximizeGanttView=false` URL parameter   | No (forces non-maximized mode)                |

<Tip title="Dynamic query switching for non-admin users">
  Use page parameters to let regular users switch between different query configurations. For example, create a dropdown parameter with preset filter options (e.g., "My Tasks", "Team Tasks", "All Tasks") and reference it in the Gantt query using Velocity syntax.
</Tip>

## Access Page Parameters from Scripts

You can read page parameter values in an **Item Script** to customize task appearance based on user-selected parameters:

```javascript theme={null}
config.getPageParameters().get("pageParamId")
```

Replace `pageParamId` with the ID of the parameter defined in the Page Parameters widget.

<Note title="Enum field naming convention">
  When using enum-type page parameters for filtering or sorting, include the field ID in the enum field name. This ensures the Gantt widget correctly maps the selected value to the query filter.
</Note>

## Verify Your Configuration

1. Open the Gantt page in maximized view
2. You should now see the ⚙️ Settings button in the toolbar
3. Click the Settings button to open the Page Parameters panel
4. Select a different parameter value and observe the Gantt data reloading with the updated filter
5. Press **Escape** or click the X button to close the panel

## See Also

* [Use Fullscreen and Maximize Mode](/gantt/guides/layout/fullscreen-mode) for maximize mode configuration
* [Use Dynamic Queries with Page Parameters](/gantt/guides/filtering/dynamic-queries) for advanced query patterns
* [Use Gantt Filters](/gantt/guides/filtering/gantt-filters) for built-in filtering options
* [Write Page Scripts with Velocity](/gantt/guides/scripting/page-script) for Velocity-based customization

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