- 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
Display¶
Root container widget for an OPI file.
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.
- Auto Scale Widgets (
auto_scale_widgets
) Controls whether autoscaling is enabled.
If so, child widgets are automatically stretched in horizontal and/or vertical direction depending on their individual Scale Options property configuration.
Autoscaling can cause shifts in the interdistance between widgets.
- Auto Zoom to Fit All (
auto_zoom_to_fit_all
) If enabled, always zoom the display to fit the available space while preserving ratios.
- Rules (
rules
) Rules attached to this widget.
- Scripts (
scripts
) Scripts attached to this widget.
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.
- Grid Color (
foreground_color
) Color of grid lines.
- Grid Space (
grid_space
) Space in pixels between grid lines.
- Show Close Button (
show_close_button
) If true, this display’s tab does not show the close icon at runtime.
Note that the tab can still be closed through right-click.
- Show Edit Range (
show_edit_range
) If true, two lines matching the display’s width and height are visible while editing this OPI display.
- Show Grid (
show_grid
) If true, a grid is visible while editing this OPI display.
- Show Ruler (
show_ruler
) If true, vertical and horizontal rulers are visible while editing this OPI Display.
- Snap to Geometry (
snap_to_geometry
) If true, dragging widgets while editing an OPI display makes the positioning sticky with respect to the geometry of other widgets.
Position Properties
- Height (
height
) Height of the widget area in pixels.
- 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.