/  Yamcs Studio User Guide  /  Widgets

Widgets

A display is a container for widgets.

Most widgets are backed by a PV. Some widgets (e.g. widgets used for layout) are typically not connected to a PV. Other widgets (e.g. charts) can be backed by more than one PV.

Catalogue of Widgets

The default widgets in Yamcs Studio are listed below. Their runtime behaviour should be fairly straightforward.

Graphics

arc Arc

rectangle Rectangle

label Label

polyline Polyline

rounded-rectangle Rounded Rectangle

image Image

polygon Polygon

ellipse Ellipse

Monitors

led LED

progress-bar Progress Bar

xygraph XY Graph *

image-boolean-indicator Image Boolean Indicator

gauge Gauge

intensity-graph Intensity Graph

text-update Text Update

thermometer Thermometer

byte-monitor Byte Monitor

meter Meter

tank Tank

* Clear the view on this widget by right-clicking on it and selecting Clear Graph. If you want advanced controls, like zooming, activate the toolbar by right-clicking on your widget and selecting Show/Hide Graph Toolbar.

Controls

action-button Action Button *

knob Knob

image-boolean-button Image Boolean Button

menu-button Menu Button

scrollbar Scrollbar

check-box Check Box

text-input Text Input

thumb-wheel Thumb Wheel

radio-box Radio Box

spinner Spinner

boolean-switch Boolean Switch

choice-button Choice Button

scaled-slider Scaled Slider

boolean-button Boolean Button

combo Combo

* Action Buttons are often used to open other displays. Whether this opens in a new tab or in the same tab depends on how the display author constructed the display. Override the default by right-clicking the Action Button.

Others

table Table

grouping-container Grouping Container

sash-container Sash Container

web-browser Web Browser

linking-container Linking Container

grid-layout Grid Layout

array Array

tabbed-container Tabbed Container

Color Decorations

When a widget is backed by a PV, it will be decorated according to its runtime state. The specific colors of these decorations can vary since the default colors can be overridden (or disabled) by the display author.

Connected

No decorations

Connected, but no value (yet)

Dashed pink border around the widget

Disconnected

Solid pink border around the widget and the label ‘Disconnected’ in the top left corner (space-permitting)

Expired

Blinking solid pink border around the widget

Minor Alarm

Solid orange border around the widget

Major Alarm

Solid red border around the widget

Note that the color information for alarms is currently not as rich as it could be. Yamcs parameters support five different levels of alarms, as well as a range of special monitoring values. This information is transformed using the following mapping:

  • WATCH, WARNING, DISTRESS → MINOR

  • CRITICAL, SEVERE → MAJOR