Progress Bar¶

Widget that displays a numeric value on a bar graph.

Basic Properties

Name (name): Human-readable name of this widget. Shown in the Outline view.

PV Name (pv_name)

The name of the main PV for this widget. If set, the widget’s value follows value updates of the corresponding PV.

It is not a requirement to use a PV. You may also control the widget value directly through scripting.

Widget Type (widget_type): Readonly property describing the type of this widget.

Behavior Properties

Actions (actions): Executable Actions attached to this widget.

Level HI (level_hi): The high mark.

Level HIHI (level_hihi): The high high mark.

Level LO (level_lo): The low mark.

Level LOLO (level_lolo): The low low mark.

Limits from PV (limits_from_pv)

Determine Minimum, LOLO, LO, HI, HIHI, Maximum levels automatically based on the underlying PV.

If the PV is backed by a Yamcs parameter, the mapping is as follows:

Yamcs	Yamcs Studio
WATCH	LO/HI
WARNING	LO/HI
DISTRESS	LO/HI
CRITICAL	LOLO/HIHI
SEVERE	LOLO/HIHI

Maximum (maximum): The upper limit of the widget.

Minimum (minimum): The lower limit of the widget.

Origin (origin)

Customize the start point of the bar fill (value within the range Minimum, Maximum).

Ignored if the property Origin Ignored is set.

Origin Ignored (origin_ignored): If set, consider the property Origin.

Rules (rules): Rules attached to this widget.

Scripts (scripts): Scripts attached to this widget.

Visible (visible): Manage the visibility of this widget.

Border Properties

Alarm Sensitive (border_alarm_sensitive): If the PV is in alarm state, the widget border and style change to alarm mode.

Border Color (border_color)

The color of the widget border.

Has no meaning with certain types of border styles (for example, raised borders have a fixed style).

Border Style (border_style): The type of border. Some border styles also colorize the background of the widget’s bounding box.

Border Width (border_width)

The thickness of the widget border.

Has no meaning with certain types of border styles (for example, raised borders have a fixed style).

Display Properties

3D Effect (effect_3d): Whether the rendering includes gradient and shadow effects.

Alarm Pulsing (alarm_pulsing): If enabled, the PV is in alarm state, and the properties BackColor Alarm Sensitive and/or ForeColor Alarm Sensitive are used, then the corresponding colors will fade in and out to draw operator’s attention.

BackColor Alarm Sensitive (backcolor_alarm_sensitive): If the PV is in alarm state, then Background Color matches the corresponding alarm color.

Background Color (background_color): The color of the background of the widget’s bounding box. Only visible when the widget uses a border style that fills up the widget area.

Color Fillbackground (color_fillbackground): Color of the bar background.

Color HI (color_hi): Color associated with high alarm.

Color HIHI (color_hihi): Color associated with high high alarm.

Color LO (color_lo): Color associated with low alarm.

Color LOLO (color_lolo): Color associated with low low alarm.

Fill Color (fill_color): Color of the bar fill (or indicator).

FillColor Alarm Sensitive (fillcolor_alarm_sensitive): If the PV is in alarm state, then Fill Color matches the corresponding alarm color.

Font (font): The font of the label.

ForeColor Alarm Sensitive (forecolor_alarm_sensitive): If the PV is in alarm state, then Foreground Color matches the corresponding alarm color.

Foreground Color (foreground_color): The color of the label.

Horizontal (horizontal): Direction of the bar.

Indicator Mode (indicator_mode): If true, the current value is indicated on the bar, but the bar is not filled.

Log Scale (log_scale): Use a logarithmic scale.

Major Tick Step Hint (major_tick_step_hint): Minimum amount of pixels between major ticks.

Scale Font (scale_font): The font of the scale.

Scale Format (scale_format)

Pattern describing how to format step values shown on the scale.

The pattern follows Java conventions. See https://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html

Some examples:

Value	Format	Printed
1234	#.00	1234.00
12.3456	#.##	12.35
1234	0.###E0	1.234E3

Show HI (show_hi): Whether to show the high mark.

Show HIHI (show_hihi): Whether to show the high high mark.

Show Label (show_label): Whether to show the current value.

Show LO (show_lo): Whether to show the low mark.

Show LOLO (show_lolo): Whether to show the low low mark.

Show Markers (show_markers): Whether to show LOLO, LO, HI and HIHI markers.

Show Minor Ticks (show_minor_ticks): Whether to show minor ticks on the scale.

Show Scale (show_scale): Whether to show the ticks and scale labels.

Tooltip (tooltip): Tooltip when mouse hovers this widget.

Transparent Background (transparent_background): If true, the unused part of the widget area is left transparent. If false, the unused part uses the Background Color.

Value Label Format (value_label_format)

Pattern describing how to format the current value.

The pattern follows Java conventions. See https://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html

Some examples:

Value	Format	Printed
1234	#.00	1234.00
12.3456	#.##	12.35
1234	0.###E0	1.234E3

Position Properties

Height (height): Height of the widget area in pixels.

Scale Options (scale_options): If autoscaling is enabled on the Display, then this property allows controlling whether and how this widget participates.

Width (width): Width of the widget area in pixels

X (x): X-coordinate in pixels of the top-left corner of the widget area.

Y (y): Y-coordinate in pixels of the top-left corner of the widget area.