> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/rt-lab/simulation-control-monitoring-and-logging/interact-using-dashboards/interact-with-data-points-via-panels/widget-library-and-parameters.md).

# Widget Library & Parameters

## Widget library <a href="#commands" id="commands"></a>

### Commands <a href="#commands" id="commands"></a>

<table data-search="false"><thead><tr><th width="115">Name</th><th width="115">Icon</th><th>Description</th></tr></thead><tbody><tr><td>Numeric Control</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-9dbc00e75b43fd5555208d20028b95d3880dd9ff%2Fimage%20(230).png?alt=media" alt="" data-size="original"></td><td>Commands a numerical parameter, either <code>INTEGER</code> or <code>REAL</code>.</td></tr><tr><td>Knob</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-27251f26b3ab010e81ff84428c0f85871dc6797e%2Fimage%20(231).png?alt=media" alt="" data-size="original"></td><td>Commands a numerical parameter in a given range, either <code>INTEGER</code> or <code>REAL</code>.</td></tr><tr><td>Slider</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-c1df7f0257ac1d7c7e540ad0e0d9d34ef0572325%2Fimage%20(232).png?alt=media" alt="" data-size="original"></td><td>Commands a numerical parameter in a given range, either <code>INTEGER</code> or <code>REAL</code>.</td></tr><tr><td>Switch</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-3ca547decd57680f53ad1483331f19f8cc6449ff%2Fimage%20(233).png?alt=media" alt="" data-size="original"></td><td>Controls a numerical parameter that can take one of two predefined values, making it particularly suitable for <code>BOOLEAN</code> signals. Depending on the state of the switch, the widget sends either the <strong>OFF</strong> or <strong>ON</strong> value. The widget’s appearance can be customized using the <strong>Shape</strong> option, which offers four different visual styles.</td></tr><tr><td>Image Loop Control</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-b2407c7f857a49eb874fb79fceb53ce3d0acafa8%2Fimage%20(234).png?alt=media" alt="" data-size="original"></td><td>Commands a numerical parameter from a predefined set of up to ten values, making it ideal for <code>INDEX</code> or <code>ENUM</code> signals. Each click cycles to the next image and sends the corresponding value. If the received value does not match any of the predefined <strong>Value N</strong> entries, the widget displays a fallback image. The <strong>Image 1</strong> parameter defines the widget’s aspect ratio.</td></tr><tr><td>Button</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-9504f67ae16af774cb5ea8aae1bda2b862f46db7%2Fimage%20(235).png?alt=media" alt="" data-size="original"></td><td><p>Commands a numerical parameter with a predefined set of two values, making it ideal for <code>TRIGGER</code> signals. The widget sends either <strong>Value (Idle)</strong> or <strong>Value (Pressed)</strong>.</p><p>The Button can also trigger a script from the <strong>Scripts</strong> list.</p><ul><li><strong>Non-Latching:</strong> The <strong>Value (Pressed)</strong> is sent only while the left mouse button is held over the widget.</li><li><strong>Latching:</strong> The <strong>Value (Pressed)</strong> is sent on a mouse click and remains active until the next click.</li><li><strong>Scripting:</strong> A selected script from the <strong>Scripts</strong> list is executed when the button is clicked.</li></ul></td></tr><tr><td>Dropdown</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-f1983eb4817ecedeaf6ba0bf4664753d46e9e452%2Fimage%20(236).png?alt=media" alt="" data-size="original"></td><td><p>Commands a numerical parameter for a pre-determined set of values. Best suited for <code>INDEX</code> or <code>ENUM</code>.</p><p>Use the <strong>States</strong> table under <strong>Widget Options</strong> to define the available values in the dropdown list.</p></td></tr></tbody></table>

### Displays <a href="#displays" id="displays"></a>

Display widgets can be connected to a parameter, an input or an output. It visualizes the value of said parameter, input or output on the diagram, without interacting with it.

<table data-search="false"><thead><tr><th width="115">Name</th><th width="115">Icon</th><th>Description</th></tr></thead><tbody><tr><td>Numeric Display</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-c7a85362c125c1edccb2ac0b15d5ddf92509c962%2Fimage%20(237).png?alt=media" alt="" data-size="original"></td><td>Displays a numerical value.</td></tr><tr><td>Gauge</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-1f79ed6ece935a7a17f277a8335a96211c3c7946%2Fimage%20(238).png?alt=media" alt="" data-size="original"></td><td>Displays a numerical value in a given range. Visual lower and upper areas can be added.</td></tr><tr><td>Thermometer</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-0eb06141007f748a8706b465ded689b1baf2a748%2Fimage%20(239).png?alt=media" alt="" data-size="original"></td><td>Displays a numerical value in a given range.</td></tr><tr><td>LED</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-31433f9ca75ed17e6c38ab6c84a129d2972ae255%2Fimage%20(240).png?alt=media" alt="" data-size="original"></td><td>Indicates the state of a numerical value by lighting up when the value is non-zero and turning off when the value is zero.</td></tr><tr><td>Image Loop Display</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-2e746a2795ee22f8a370fb257638061e9b68e739%2Fimage%20(241).png?alt=media" alt="" data-size="original"></td><td>Displays a numerical value based on predefined ranges. Multiple ranges can be assigned to different images, and if the value does not match any range, a fallback image is shown. The <strong>Image 1</strong> parameter sets the widget’s aspect ratio.</td></tr><tr><td>Graph</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-2e635a7bde95060c565d8224f83133c390befad7%2Fimage%20(242).png?alt=media" alt="" data-size="original"></td><td>Displays values of multiple signals over an acquisition time period. Acquisition can be configured to be triggered upon a selected signal.</td></tr><tr><td>Text Display</td><td><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-3328f48f39a62bc8a84f1af1d4f068804d765a41%2Fimage%20(243).png?alt=media" alt="" data-size="original"></td><td>Displays text within a specified range. Multiple ranges can be set per text. If no range matches are found, a fallback text is displayed.</td></tr></tbody></table>

{% hint style="danger" %}
**RT-LAB limitation:** A graph widget can only display signals from the same sub-system (SM, SS) or its children. ScopeView automatically filters available data points accordingly.
{% endhint %}

### Graphics <a href="#graphics" id="graphics"></a>

Graphic widgets are visual tools to add on a diagram. They include an **On Click** parameter, which you can configure to navigate to other panels or tables within the project, or to external URLs or files:

<figure><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-9ca616a658b110e7e87ac3018201d19777060e20%2FDH-onclick.gif?alt=media" alt=""><figcaption></figcaption></figure>

## Widgets parameters <a href="#data-points-and-properties-of-widgets" id="data-points-and-properties-of-widgets"></a>

### Widgets common parameters

* **Title:** The name displayed on the diagram. Visibility can be toggled using the **View** icon at the top-right corner.
* **Data:** The data point associated with the widget. Depending on the widget type, you can connect the widget’s **Data** parameter to another parameter, input, or output.
* **Data Type:** The type of value used by a Command widget. If the connected data point is an **Integer**, the value is rounded to remain an integer. You can change it to **Real** if needed.
* **Minimum / Maximum:** Define the range of ticks for the widget. Incoming values are not clipped to this range.
* **Display:** Controls whether the numerical indicator is shown.

{% hint style="info" %}
Each data point includes a tooltip with a brief description.
{% endhint %}

### Graph widget parameters and particularities

The Graph widget displays signal values over time during an acquisition period, allowing visualization and analysis of connected signals.

{% hint style="danger" %}
**Simulation and Acquisition**

* Using more than 16 graph widgets may cause UI latency depending on CPU allocation.
* At the start of a simulation, the widget initializes selected signals (\~5 seconds). Other widgets display values immediately.
* A loading icon appears while initialization occurs or if the trigger condition has not yet been met.
  {% endhint %}

### Graph visualization type

* **Time Plot (default):** Plots Data (Y) values against acquisition time (X).
* **X/Y Mode:** Plots Data (Y) values against another connected data point in Data (X).

<figure><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-59dc3f926c86f416157d494c2ca255fb614a3510%2FDH-dashboards-xy.gif?alt=media" alt="" width="563"><figcaption></figcaption></figure>

### Time scale

* **Period:** Sets the acquisition duration and memory allocation. This can be modified during simulation, but cannot exceed 5 seconds beyond the initial period.
* **Scale mode:** Can display absolute time (from simulation start) or relative time (acquisition period).

### Vertical scale

* **Autoscale:** When enabled, the graph automatically adjusts to the min/max values of the current acquisition. When disabled, min/max values are fixed.

### Trigger configuration

* **Trig Signal:** Connects the graph widget to a trigger. If no trigger is selected, acquisition runs continuously, restarting at the end of each period. The trigger operates independently of the Data selection, though it can also be visualized. When a trigger is selected, acquisition starts only when the condition is met, with a loading icon displayed until activation. Each graph widget uses its own datalogger, allowing multiple widgets to trigger on different events.

{% hint style="danger" %}
**RT-LAB limitation:** Trigger signals must belong to the same sub-system as the acquired signals.
{% endhint %}

{% hint style="info" %}
Both Data and Trig Signal must be connected before running the simulation. Once started, neither can be modified.
{% endhint %}

* **Condition:** Defines the comparison between the Trig signal and a reference Level. Acquisition starts when the condition is met.
  * **Rising Edge:** Trigger crosses reference from low to high.
  * **Falling Edge:** Trigger crosses reference from high to low.
  * **Above Level:** Trigger is greater than reference.
  * **Below Level:** Trigger is lower than reference.
* **X Position:** Sets where the acquisition start is displayed; pre-trigger data are included.

{% hint style="danger" %}
**Graph widget limitations**

* Supported only on Windows and OPAL-RTLinux 3 simulators.
* Each graph has its own datalogger; timestamps are not synchronized between widgets.
* Minimum vertical size: 200 px. Below this, no traces are displayed.
* RT-LAB limitation: All signals must belong to the same sub-system or its children.
  {% endhint %}

{% hint style="info" %}
**Tips for Using the Graph Widget**

* Add a Numeric Display for the data point of interest to check if simulation has started.
* Run the graph without a trigger for continuous acquisition.
* Enable **Show on Graph** for the trigger signal to troubleshoot acquisition start.
* Use Autoscale (Y) if the graph appears empty.
  {% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/rt-lab/simulation-control-monitoring-and-logging/interact-using-dashboards/interact-with-data-points-via-panels/widget-library-and-parameters.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
