Documentation Home Page OPAL-RT Dashboard Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

4. Widgets Library

Widgets are used to control and visualize data points in a project.

Page Content

Adding a Widget

To add a widget to a diagram, open the Libraries menu with the “+” button located in the bottom-left corner of the diagram.

Once added, the sidebar shows the data points for the selected widget.

Widgets

Commands

Command widgets can be connected to a parameter in order to control that parameter from the diagram. 

Name

Icon

Description

Name

Icon

Description

Numeric Control

image-20240308-191836.png

Command a numerical parameter, either INTEGER or REAL.

Knob

Command a numerical parameter in a given range, either INTEGER or REAL.

Slider

Command a numerical parameter in a given range, either INTEGER or REAL.

Switch

Command a numerical parameter for a pre-determined set of two values. Best suited for BOOLEAN. The value sent is either “Value (Off)” or “Value (On)”.

Image Loop Control

Command a numerical parameter for a pre-determined set of up to ten values. Best suited for INDEX or ENUM.  Each time the widget is clicked, the next image is shown and the next value is sent.

If the value received is not equal to any “Value N”, the fallback image is displayed.

The “Image 1” parameter is responsible for setting the aspect ratio.

Button

 

Command a numerical parameter for a pre-determined set of two values. Best suited for TRIGGER. The value sent is either “Value (idle)” or “Value (pressed)”.

Button can also trigger the run of a script.

When the “Behavior” is set to “Non-Latching”, the value for “Value (pressed)” is sent only while the left mouse button is pressed over the widget.

When the “Behavior” is set to “Latching”,  the value for “Value (pressed)” is sent as soon as a mouse click occurs on the widget, and until a subsequent mouse click.

When the “Behavior” is set to “scripting, a script from the Scripts list must be chosen.

Dropdown

Command a numerical parameter for a pre-determined set of values. Best suited for INDEX or ENUM

The pairs of text and value can be edited in the widget States table as shown below.

Displays

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.

Name

Icon

Description

Name

Icon

Description

Numeric Display

Display a numerical value.

Gauge

Display a numerical value in a given range. Visual lower and upper areas can be added.

Thermometer

Display a numerical value in a given range. 

LED

Display whether a numerical value is or isn’t equal to zero.

Image Loop Display

Display a numerical value within given range. Many ranges can be set per image. If no range match is found, the fallback image is displayed.

The “Image 1” parameter is responsible for setting the aspect ratio.

Graph

Display values of multiple signals over an acquisition time period. Acquisition can be configured to be triggered upon a selected signal. As Graph operates slightly differently than other widgets, refer to the Graph widget section.

Text Display

Displays text within a specified range. Multiple ranges can be set per text. If no range matches are found, a fallback text is displayed.

Graphics

Graphic widgets are visual tools to add on a diagram.

Name

Icon

Description

Name

Icon

Description

Text

Add customizable text on the diagram.

Tab Group

 

 

Add a widget containing multiple Tabs to alternate between sets of widgets.

Tab can be added with the image-20240311-032645.png button, moved with the context menu and renamed by double-clicking on the tab name.

Tab can also be deleted, and all widgets contained in the tab will be deleted with the deleted tab.

To add a widget in a Tab, simply drag and drop the widget on the active tab.

Note that Tab Group does not support copy-paste and the Python API.

 

Shape

Add a customizable shape on the diagram.

Image

Add an image on the diagram. The image can be rescaled and rotated. The aspect ratio is controlled by the “Fit” parameter.

The image can be “Sent to Back” or “Sent to Front” from the context menu (just like any other widget).

Data Points and Properties of Widgets

Below are the most common data points and properties of widgets. Each data point has a tooltip with a small description.

Title is the name displayed on the diagram. The visibility can be toggled with the button.

Data is the data point for this widget. Based on the widget’s category, a connection can be created between the widget’s “Data” parameter and another parameter, input or output.

For detailed documentation about connections, see Connecting Data Points.

Data type is the type used for the value of a command widget. If the connected data point is “Integer”, a rounding operation is made for the value to remain an integer. It can be modified to be “Real” instead.

Minimum and Maximum define the range of the ticks. Incoming values are not clipped to the widget range.

Display controls the display of the numerical indicator.

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter