- Overview
- Display Builder
- Display Runner
- Processed Variables
- Widgets
- Action Button
- Arc
- Array
- Boolean Button
- Boolean Switch
- Byte Monitor
- Check Box
- Choice Button
- Combo
- Display
- Ellipse
- Gauge
- Grid Layout
- Grouping Container
- Image
- Image Boolean Button
- Image Boolean Indicator
- Intensity Graph
- Knob
- Label
- LED
- Linking Container
- Menu Button
- Meter
- Polygon
- Polyline
- Progress Bar
- Radio Box
- Rectangle
- Rounded Rectangle
- Sash Container
- Scaled Slider
- Scrollbar
- Spinner
- Tabbed Container
- Table
- Tank
- Text Input
- Text Update
- Thermometer
- Thumb Wheel
- XY Graph
- Web Browser
- Actions
- Borders
- Rules
- Scripts
- Macros
- Tuning
Yamcs Studio Release Notes
Source Code Documentation
Linking Container¶
Container widget that allows to include another OPI file, or a specific group of widgets within another OPI file.
A typical use case would be a common header or footer shown on a series of displays. Or to reuse the same OPI with different variables, that is: using macros.
The bounds of a Linking Container can be automatically calculated by right-clicking it and choosing Perform Auto Size. The new size will account for all content to be visible.
Basic Properties
- Macros (
macros
) Macros available within this container.
- Name (
name
) Human-readable name of this widget. Shown in the Outline view.
- Widget Type (
widget_type
) Readonly property describing the type of this widget.
Behavior Properties
- Actions (
actions
) Executable Actions attached to this widget.
- Enabled (
enabled
) Unset to make contained control widgets unusable.
- Group Name (
group_name
) The name of a specific Grouping Container inside the linked display.
If set, only this particular group will be visible. Otherwise the entire linked display is visible.
- OPI File (
opi_file
) The linked OPI display file.
- Rules (
rules
) Rules attached to this widget.
- Scripts (
scripts
) Scripts attached to this widget.
- Visible (
visible
) Manage the visibility of this widget.
Border Properties
- 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
- 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.
- Font (
font
) The font of the label.
- Foreground Color (
foreground_color
) The color of the label.
- Resize Behaviour (
resize_behaviour
) How to match the size of the Linking Container with that of the linked display or group.
Code
Value
0
Size *.opi to fit the container
1
Size the container to fit the linked *.opi
2
Don’t resize anything, crop if *.opi too large for container
3
Don’t resize anything, add scrollbars if *.opi too large for container
- Tooltip (
tooltip
) Tooltip when mouse hovers this widget.
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.