phoebusgen.v4.widgets package

Submodules

phoebusgen.v4.widgets.controls module

class phoebusgen.v4.widgets.controls.ActionButton(name, text, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasText, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasHorizontalAlignment, HasVerticalAlignment, HasRotationStep, HasEnabled, HasAlarmBorder, HasConfirmation

ActionButton Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property confirm_message

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rotation_step

property rules

property scripts

property show_confirm_dialog

property text

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.BooleanButton(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBit, HasOnOffImages, HasShowLED, HasFont, HasForegroundColor, HasBackgroundColor, HasLabelsFromPV, HasAlarmBorder, HasEnabled, HasButtonMode, HasConfirmation, HasHorizontalAlignment, HasVerticalAlignment

BooleanButton Phoebus Widget

property actions

property background_color

property bit

property border_alarm_sensitive

property confirm_message

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property labels_from_pv

property mode

property name

property off_image

property on_image

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property show_led

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.CheckBox(name, label, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBit, HasLabel, HasFont, HasForegroundColor, HasAutoSize, HasAlarmBorder, HasConfirmation

CheckBox Phoebus Widget

property actions

property auto_size

property bit

property border_alarm_sensitive

property confirm_message

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property label

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.ChoiceButton(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasSelectedColor, HasAlarmBorder, HasItems, HasItemsFromPV, HasConfirmation, HasHorizontalAlignment, HasVerticalAlignment

ChoiceButton Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property confirm_message

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property items

property items_from_pv

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property selected_color

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.ComboBox(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasAlarmBorder, HasItems, HasItemsFromPV, HasEditable, HasEnabled, HasConfirmation

ComboBox Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property confirm_message

property editable

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property items

property items_from_pv

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.FileSelector(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFileComponent, HasAlarmBorder, HasEnabled

FileSelector Phoebus Widget

property actions

property border_alarm_sensitive

property enabled

property file_component

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.RadioButton(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasHorizontalAlignment, HasAlarmBorder, HasItems, HasItemsFromPV, HasEnabled, HasConfirmation

RadioButton Phoebus Widget

property actions

property border_alarm_sensitive

property confirm_message

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property items

property items_from_pv

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.ScaledSlider(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasHorizontalAlignment, HasForegroundColor, HasBackgroundColor, HasTransparent, HasFont, HasShowScale, HasShowMinorTicks, HasMajorTicksPixelDist, HasScaleFormat, HasWarningLevels, HasWarningLevelsVisibility, HasAlarmBorder, HasIncrement, HasMinMax, HasLimitsFromPV, HasEnabled

ScaledSlider Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property increment

property level_high

property level_hihi

property level_lolo

property level_low

property limits_from_pv

property major_ticks_pixel_dist

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scale_format

property scripts

property show_high

property show_hihi

property show_lolo

property show_low

property show_minor_ticks

property show_scale

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.Scrollbar(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasHorizontalAlignment, HasShowValueTip, HasAlarmBorder, HasMinMax, HasLimitsFromPV, HasBarLength, HasIncrement, HasEnabled

Scrollbar Phoebus Widget

property actions

property bar_length

property border_alarm_sensitive

property enabled

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property increment

property limits_from_pv

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property show_value_tip

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.SlideButton(name, label, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBit, HasLabel, HasOnOffColors, HasFont, HasForegroundColor, HasAutoSize, HasAlarmBorder, HasEnabled, HasConfirmation

SlideButton Phoebus Widget

property actions

property auto_size

property bit

property border_alarm_sensitive

property confirm_message

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property label

property name

property off_color

property on_color

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.Spinner(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFormat, HasPrecision, HasShowUnits, HasForegroundColor, HasBackgroundColor, HasButtonsOnLeft, HasAlarmBorder, HasMinMax, HasLimitsFromPV, HasIncrement, HasEnabled

Spinner Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property buttons_on_left

property enabled

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property increment

property limits_from_pv

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rules

property scripts

property show_units

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.controls.TextEntry(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasFormat, HasPrecision, HasShowUnits, HasWrapWords, HasMultiLine, HasAlarmBorder, HasEnabled, HasBorder, HasHorizontalAlignment, HasVerticalAlignment

TextEntry Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property border_color

property border_width

property enabled

property font

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property multi_line

property name

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rules

property scripts

property show_units

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property wrap_words

property x

property y

class phoebusgen.v4.widgets.controls.Thumbwheel(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor

Thumbwheel Phoebus Widget

property actions

property background_color

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

phoebusgen.v4.widgets.graphics module

class phoebusgen.v4.widgets.graphics.Arc(name, x, y, width, height)

Bases: Widget, HasMacros, HasAngle, HasLineWidth, HasLineColor, HasLineStyle, HasBackgroundColor, HasTransparent

Arc Phoebus Widget

property actions

property background_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property start_angle

property tooltip

property total_angle

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.graphics.Ellipse(name, x, y, width, height)

Bases: Widget, HasMacros, HasLineWidth, HasLineColor, HasLineStyle, HasBackgroundColor, HasTransparent

Ellipse Phoebus Widget

property actions

property background_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.graphics.Label(name, text, x, y, width, height)

Bases: Widget, HasText, HasMacros, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasHorizontalAlignment, HasVerticalAlignment, HasRotationStep, HasWrapWords, HasAutoSize, HasBorder

Label Phoebus Widget

property actions

property auto_size

property background_color

property border_color

property border_width

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rotation_step

property rules

property scripts

property text

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property wrap_words

property x

property y

class phoebusgen.v4.widgets.graphics.Picture(name, file, x, y, width, height)

Bases: Widget, HasMacros, HasFile, HasStretchToFit, HasRotation, HasOpacity

Picture Phoebus Widget

property actions

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

property opacity

parent: Optional['HasWidgets'] = None

root: Element

property rotation

property rules

property scripts

property stretch_to_fit

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.graphics.Polygon(name, x, y, width, height)

Bases: Widget, HasMacros, HasLineWidth, HasLineColor, HasLineStyle, HasTransparent, HasPoints, HasBackgroundColor

Polygon Phoebus Widget

property actions

property background_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

property points

root: Element

property rules

property scripts

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.graphics.Polyline(name, x, y, width, height)

Bases: Widget, HasMacros, HasLineWidth, HasLineColor, HasLineStyle, HasArrows, HasPoints

Polyline Phoebus Widget

property actions

property arrow_length

property arrows

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

property points

root: Element

property rules

property scripts

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.graphics.Rectangle(name, x, y, width, height)

Bases: Widget, HasMacros, HasLineWidth, HasLineColor, HasLineStyle, HasBackgroundColor, HasTransparent, HasCorners

Rectangle Phoebus Widget

property actions

property background_color

property corner_height

property corner_width

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

phoebusgen.v4.widgets.misc module

class phoebusgen.v4.widgets.misc.ThreeDViewer(name, file, x, y, width, height)

Bases: Widget, HasFile

ThreeDViewer Phoebus Widget

property actions

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.misc.WebBrowser(name, url, x, y, width, height)

Bases: Widget, HasUrl, HasShowToolbar

WebBrowser Phoebus Widget

property actions

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property show_toolbar

property tooltip

property url

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

phoebusgen.v4.widgets.monitors module

class phoebusgen.v4.widgets.monitors.ByteMonitor(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasStartBit, HasNumBits, HasReverseBits, HasHorizontal, HasSquare, HasOnOffColors, HasForegroundColor, HasFont, HasLabels, HasAlarmBorder

ByteMonitor Phoebus Widget

property actions

property border_alarm_sensitive

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

property labels

property name

property num_bits

property off_color

property on_color

parent: Optional['HasWidgets'] = None

property pv_name

property reverse_bits

root: Element

property rules

property scripts

property square

property start_bit

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.monitors.LED(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBit, HasOnOffColors, HasOnOffLabels, HasFont, HasForegroundColor, HasLineColor, HasSquare, HasLabelsFromPV, HasAlarmBorder

LED Phoebus Widget

property actions

property bit

property border_alarm_sensitive

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property labels_from_pv

property line_color

property name

property off_color

property off_label

property on_color

property on_label

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property square

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.monitors.LEDMultiState(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasLineColor, HasSquare, HasAlarmBorder, HasStates, HasFallback

LEDMultiState Phoebus Widget

property actions

property border_alarm_sensitive

property fallback_color

property fallback_label

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property square

property states

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.monitors.LinearMeter(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasForegroundColor, HasBackgroundColor, HasFont, HasFormat, HasPrecision, HasShowValue, HasShowUnits, HasShowLimits, HasAlarmBorder, HasScaleVisible, HasHorizontal, HasLimitsFromPV, HasMinMax, HasKnobAndNeedleColor, HasKnobAndNeedleSize, HasLinearMeterColors, HasWarningLevels

LinearMeter Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property colors

property font

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

property knob_color

property knob_size

property level_high

property level_hihi

property level_lolo

property level_low

property limits_from_pv

property maximum

property minimum

property name

property needle_color

property needle_width

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rules

property scale_visible

property scripts

property show_limits

property show_units

property show_value

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.monitors.Meter(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasForegroundColor, HasBackgroundColor, HasFont, HasFormat, HasPrecision, HasShowValue, HasShowUnits, HasShowLimits, HasAlarmBorder, HasLimitsFromPV, HasMinMax, HasKnobAndNeedleColor

Meter Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property font

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property knob_color

property limits_from_pv

property maximum

property minimum

property name

property needle_color

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rules

property scripts

property show_limits

property show_units

property show_value

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.monitors.ProgressBar(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFillColor, HasBackgroundColor, HasHorizontal, HasAlarmBorder, HasLimitsFromPV, HasMinMax

ProgressBar Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property fill_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

property limits_from_pv

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.monitors.Symbol(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasSymbols, HasBackgroundColor, HasInitialIndex, HasRotation, HasShowIndex, HasTransparent, HasAlarmBorder, HasArrayIndex, HasAutoSize, HasEnabled, HasPreserveRatio

Symbol Phoebus Widget

property actions

property array_index

property auto_size

property background_color

property border_alarm_sensitive

property enabled

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property initial_index

property name

parent: Optional['HasWidgets'] = None

property preserve_ratio

property pv_name

root: Element

property rotation

property rules

property scripts

property show_index

property symbols

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.monitors.Table(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasShowToolbar, HasAlarmBorder, HasEditable, HasSelectRows, HasSelectionPV, HasColumns

Table Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property columns

property editable

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property select_rows

property selection_pv

property show_toolbar

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.monitors.Tank(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasFillColor, HasEmptyColor, HasScaleVisible, HasAlarmBorder, HasLimitsFromPV, HasMinMax, HasLogScale, HasHorizontal

Tank Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property empty_color

property fill_color

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

property limits_from_pv

property log_scale

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scale_visible

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.monitors.TextSymbol(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasHorizontalAlignment, HasVerticalAlignment, HasRotation, HasWrapWords, HasAlarmBorder, HasEnabled, HasArrayIndex, HasSymbols

TextSymbol Phoebus Widget

property actions

property array_index

property background_color

property border_alarm_sensitive

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rotation

property rules

property scripts

property symbols

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property wrap_words

property x

property y

class phoebusgen.v4.widgets.monitors.TextUpdate(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasFormat, HasPrecision, HasShowUnits, HasHorizontalAlignment, HasVerticalAlignment, HasWrapWords, HasRotationStep, HasBorder, HasAlarmBorder, HasInteractive

TextUpdate Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property border_color

property border_width

property font

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property interactive

property name

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rotation_step

property rules

property scripts

property show_units

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property wrap_words

property x

property y

class phoebusgen.v4.widgets.monitors.Thermometer(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFillColor, HasAlarmBorder, HasLimitsFromPV, HasMinMax

Thermometer Phoebus Widget

property actions

property border_alarm_sensitive

property fill_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property limits_from_pv

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

phoebusgen.v4.widgets.plots module

class phoebusgen.v4.widgets.plots.DataBrowser(name, file, x, y, width, height)

Bases: Widget, HasMacros, HasFile, HasShowToolbar, HasSelectionValuePV

DataBrowser Phoebus Widget

property actions

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property selection_value_pv

property show_toolbar

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.plots.Image(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBackgroundColor, HasForegroundColor, HasShowToolbar, HasColorMap, HasColorBar, HasXAxis, HasYAxis, HasAlarmBorder, HasLimitsFromPV, HasDataWidthAndHeight, HasInterpolation, HasColorMode, HasUnisignedData, HasAutoScale, HasLogScale, HasMinMax, HasCursor, HasROIs

Image Phoebus Widget

property actions

property auto_scale

property background_color

property border_alarm_sensitive

property color_bar

property color_map

property color_mode

property cursor_crosshair

property cursor_info_pv

property data_height

property data_width

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property interpolation

property limits_from_pv

property log_scale

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

property rois

root: Element

property rules

property scripts

property show_toolbar

property tool_tip

property tooltip

property unsigned_data

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property x_axis

property x_pv

property y

property y_axis

property y_pv

class phoebusgen.v4.widgets.plots.StripChart(name, x, y, width, height)

Bases: Widget, HasForegroundColor, HasBackgroundColor, HasShowGrid, HasTitle, HasTitleFont, HasLabelFont, HasScaleFont, HasShowToolbar, HasShowLegend, HasTimeRange, HasYAxes, HasTraces

StripChart Phoebus Widget

property actions

property background_color

property end

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property label_font

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scale_font

property scripts

property show_grid

property show_legend

property show_toolbar

property start

property title

property title_font

property tooltip

property traces

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

property y_axes

class phoebusgen.v4.widgets.plots.XYPlot(name, x, y, width, height)

Bases: Widget, HasForegroundColor, HasBackgroundColor, HasTitle, HasTitleFont, HasShowToolbar, HasShowLegend, HasXAxis, HasYAxes, HasTraces, HasMarkers

XYPlot Phoebus Widget

property actions

property background_color

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property markers

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property show_legend

property show_toolbar

property title

property title_font

property tooltip

property traces

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property x_axis

property y

property y_axes

phoebusgen.v4.widgets.structure module

class phoebusgen.v4.widgets.structure.Array(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasMacros, HasForegroundColor, HasBackgroundColor, HasAlarmBorder

Array Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.structure.EmbeddedDisplay(name, file, x, y, width, height)

Bases: Widget, HasMacros, HasFile, HasResizeBehavior, HasGroupName, HasTransparent, HasBorder

EmbeddedDisplay Phoebus Widget

property actions

property border_color

property border_width

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property group_name

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

parent: Optional['HasWidgets'] = None

property resize_behavior

root: Element

property rules

property scripts

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.structure.Group(name, x, y, width, height)

Bases: Widget, HasWidgets, HasMacros, HasGroupStyle, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasLineColor

Group Phoebus Widget

property actions

add_widget(elem)

Add widget or list of widgets to screen.

Parameters:

elem (Union[Widget, Sequence[Widget]]) – <list/Phoebusgen.widget> List of Phoebusgen.widget’s or a single widget to add

Return type:

None

property background_color

bring_forward(widget)

Bring a widget one step forward in the container.

Parameters:

widget (Widget) – The widget instance to bring forward

Return type:

None

bring_to_front(widget)

Bring a widget to the front of the container.

Parameters:

widget (Widget) – The widget instance to bring to the front

Return type:

None

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

get_all_widgets()

Get a list of all widgets contained within the container, including nested widgets.

Returns:

List of all Widget instances contained within the container

Return type:

List[Widget]

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

get_widget_names()

Get a set of widget names contained within the container.

Returns:

Set of widget names contained within the container

Return type:

Set[str]

get_widgets()

Get a list of all widgets contained within the container.

Widgets are returned in the order they appear in the XML, which is the order they are rendered in Phoebus (i.e. widgets later in the XML will be rendered on top of widgets earlier in the XML).

Returns:

List of Widget instances for each widget element contained within the container

Return type:

List[Widget]

get_widgets_by_property(property_name)

Get a list of widgets contained within the container that have a property named property_name.

Parameters:

property_name (str) – Name of property to filter by

Returns:

List of Widget instances that have a property named property_name

Return type:

List[Widget]

get_widgets_by_property_class(prop_type)

Get a list of widgets contained within the container that have a property of type prop_type.

Parameters:

prop_type (Type[TypeVar(PropertyT, bound= PropertyBase)]) – Property type to filter by

Returns:

List of Widget instances that have a property of type prop_type

Return type:

List[PropertyT]

get_widgets_by_type(widget_type)

Get a list of widgets contained within the container that are of type widget_type.

Parameters:

widget_type (Type[TypeVar(WidgetT, bound= Widget)]) – Widget type to filter by

Returns:

List of Widget instances of type widget_type contained within the container

Return type:

List[WidgetT]

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

index_of(widget)

Return type:

int

property line_color

property macros

property name

parent: Optional['HasWidgets'] = None

remove_widget(widget)

Remove a widget from the container by reference.

Parameters:

widget (Widget) – The widget instance to remove

Return type:

None

root: Element

property rules

property scripts

send_backward(widget)

Send a widget one step backward in the container.

Parameters:

widget (Widget) – The widget instance to send backward

Return type:

None

send_to_back(widget)

Send a widget to the back of the container.

Parameters:

widget (Widget) – The widget instance to send to the back

Return type:

None

property style

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property widgets: List[Widget]

Get the list of widgets and set their parent to the container.

property width

property x

property y

class phoebusgen.v4.widgets.structure.HasTabs

Bases: PropertyBase

Interface for widgets that contain tabs that contain other widgets

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property tabs

class phoebusgen.v4.widgets.structure.NavigationTabs(name, x, y, width, height)

Bases: Widget, HasNavTabs, HasSelectedColor, HasDeselectedColor, HasFont

NavigationTabs Phoebus Widget

property actions

property active_tab

property deselected_color

property direction

property font

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property selected_color

property tab_height

property tab_spacing

property tab_width

property tabs

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.structure.Tab(name, root=None)

Bases: HasWidgets, HasName

Tab object for tabs widget

add_widget(elem)

Add widget or list of widgets to screen.

Parameters:

elem (Union[Widget, Sequence[Widget]]) – <list/Phoebusgen.widget> List of Phoebusgen.widget’s or a single widget to add

Return type:

None

bring_forward(widget)

Bring a widget one step forward in the container.

Parameters:

widget (Widget) – The widget instance to bring forward

Return type:

None

bring_to_front(widget)

Bring a widget to the front of the container.

Parameters:

widget (Widget) – The widget instance to bring to the front

Return type:

None

classmethod from_element(element)

Convert an XML element into a Tab instance.

Parameters:

• cls – The Tab class

• element (Element) – The XML element to convert

Returns:

A Tab instance

Return type:

Tab

get_all_widgets()

Get a list of all widgets contained within the container, including nested widgets.

Returns:

List of all Widget instances contained within the container

Return type:

List[Widget]

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

get_widget_names()

Get a set of widget names contained within the container.

Returns:

Set of widget names contained within the container

Return type:

Set[str]

get_widgets()

Get a list of all widgets contained within the container.

Widgets are returned in the order they appear in the XML, which is the order they are rendered in Phoebus (i.e. widgets later in the XML will be rendered on top of widgets earlier in the XML).

Returns:

List of Widget instances for each widget element contained within the container

Return type:

List[Widget]

get_widgets_by_property(property_name)

Get a list of widgets contained within the container that have a property named property_name.

Parameters:

property_name (str) – Name of property to filter by

Returns:

List of Widget instances that have a property named property_name

Return type:

List[Widget]

get_widgets_by_property_class(prop_type)

Get a list of widgets contained within the container that have a property of type prop_type.

Parameters:

prop_type (Type[TypeVar(PropertyT, bound= PropertyBase)]) – Property type to filter by

Returns:

List of Widget instances that have a property of type prop_type

Return type:

List[PropertyT]

get_widgets_by_type(widget_type)

Get a list of widgets contained within the container that are of type widget_type.

Parameters:

widget_type (Type[TypeVar(WidgetT, bound= Widget)]) – Widget type to filter by

Returns:

List of Widget instances of type widget_type contained within the container

Return type:

List[WidgetT]

index_of(widget)

Return type:

int

property name

remove_widget(widget)

Remove a widget from the container by reference.

Parameters:

widget (Widget) – The widget instance to remove

Return type:

None

root: Element

send_backward(widget)

Send a widget one step backward in the container.

Parameters:

widget (Widget) – The widget instance to send backward

Return type:

None

send_to_back(widget)

Send a widget to the back of the container.

Parameters:

widget (Widget) – The widget instance to send to the back

Return type:

None

property widgets: List[Widget]

Get the list of widgets and set their parent to the container.

class phoebusgen.v4.widgets.structure.Tabs(name, x, y, width, height)

Bases: Widget, HasTabs, HasMacros, HasTabActiveHeightDirection, HasFont, HasBackgroundColor

Tabs Phoebus Widget

property actions

property active_tab

property background_color

property direction

property font

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tab_height

property tabs

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.structure.TemplateInstance(name, file, x, y, width, height)

Bases: Widget, HasWidgets, HasFile, HasInstances, HasTransparent, HasHorizontal, HasWrapCount, HasGap

TemplateInstance Phoebus Widget

property actions

add_widget(elem)

Add widget or list of widgets to screen.

Parameters:

elem (Union[Widget, Sequence[Widget]]) – <list/Phoebusgen.widget> List of Phoebusgen.widget’s or a single widget to add

Return type:

None

bring_forward(widget)

Bring a widget one step forward in the container.

Parameters:

widget (Widget) – The widget instance to bring forward

Return type:

None

bring_to_front(widget)

Bring a widget to the front of the container.

Parameters:

widget (Widget) – The widget instance to bring to the front

Return type:

None

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

property gap

get_all_widgets()

Get a list of all widgets contained within the container, including nested widgets.

Returns:

List of all Widget instances contained within the container

Return type:

List[Widget]

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

get_widget_names()

Get a set of widget names contained within the container.

Returns:

Set of widget names contained within the container

Return type:

Set[str]

get_widgets()

Get a list of all widgets contained within the container.

Widgets are returned in the order they appear in the XML, which is the order they are rendered in Phoebus (i.e. widgets later in the XML will be rendered on top of widgets earlier in the XML).

Returns:

List of Widget instances for each widget element contained within the container

Return type:

List[Widget]

get_widgets_by_property(property_name)

Get a list of widgets contained within the container that have a property named property_name.

Parameters:

property_name (str) – Name of property to filter by

Returns:

List of Widget instances that have a property named property_name

Return type:

List[Widget]

get_widgets_by_property_class(prop_type)

Get a list of widgets contained within the container that have a property of type prop_type.

Parameters:

prop_type (Type[TypeVar(PropertyT, bound= PropertyBase)]) – Property type to filter by

Returns:

List of Widget instances that have a property of type prop_type

Return type:

List[PropertyT]

get_widgets_by_type(widget_type)

Get a list of widgets contained within the container that are of type widget_type.

Parameters:

widget_type (Type[TypeVar(WidgetT, bound= Widget)]) – Widget type to filter by

Returns:

List of Widget instances of type widget_type contained within the container

Return type:

List[WidgetT]

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

index_of(widget)

Return type:

int

property instances

property name

parent: Optional['HasWidgets'] = None

remove_widget(widget)

Remove a widget from the container by reference.

Parameters:

widget (Widget) – The widget instance to remove

Return type:

None

root: Element

property rules

property scripts

send_backward(widget)

Send a widget one step backward in the container.

Parameters:

widget (Widget) – The widget instance to send backward

Return type:

None

send_to_back(widget)

Send a widget to the back of the container.

Parameters:

widget (Widget) – The widget instance to send to the back

Return type:

None

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property widgets: List[Widget]

Get the list of widgets and set their parent to the container.

property width

property wrap_count

property x

property y

phoebusgen.v4.widgets.widget module

class phoebusgen.v4.widgets.widget.HasParent

Bases: object

parent: Optional[HasWidgets] = None

class phoebusgen.v4.widgets.widget.HasWidgets(widgets_tag_name=None)

Bases: PhoebusElement, PropertyBase

add_widget(elem)

Add widget or list of widgets to screen.

Parameters:

elem (Union[Widget, Sequence[Widget]]) – <list/Phoebusgen.widget> List of Phoebusgen.widget’s or a single widget to add

Return type:

None

bring_forward(widget)

Bring a widget one step forward in the container.

Parameters:

widget (Widget) – The widget instance to bring forward

Return type:

None

bring_to_front(widget)

Bring a widget to the front of the container.

Parameters:

widget (Widget) – The widget instance to bring to the front

Return type:

None

classmethod from_element(element)

Create a PhoebusElement from an XML Element.

Parameters:

element (Element) – XML Element to create from

Return type:

TypeVar(PhoebusElementT, bound= PhoebusElement)

Returns:

PhoebusElement instance

get_all_widgets()

Get a list of all widgets contained within the container, including nested widgets.

Returns:

List of all Widget instances contained within the container

Return type:

List[Widget]

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

get_widget_names()

Get a set of widget names contained within the container.

Returns:

Set of widget names contained within the container

Return type:

Set[str]

get_widgets()

Get a list of all widgets contained within the container.

Widgets are returned in the order they appear in the XML, which is the order they are rendered in Phoebus (i.e. widgets later in the XML will be rendered on top of widgets earlier in the XML).

Returns:

List of Widget instances for each widget element contained within the container

Return type:

List[Widget]

get_widgets_by_property(property_name)

Get a list of widgets contained within the container that have a property named property_name.

Parameters:

property_name (str) – Name of property to filter by

Returns:

List of Widget instances that have a property named property_name

Return type:

List[Widget]

get_widgets_by_property_class(prop_type)

Get a list of widgets contained within the container that have a property of type prop_type.

Parameters:

prop_type (Type[TypeVar(PropertyT, bound= PropertyBase)]) – Property type to filter by

Returns:

List of Widget instances that have a property of type prop_type

Return type:

List[PropertyT]

get_widgets_by_type(widget_type)

Get a list of widgets contained within the container that are of type widget_type.

Parameters:

widget_type (Type[TypeVar(WidgetT, bound= Widget)]) – Widget type to filter by

Returns:

List of Widget instances of type widget_type contained within the container

Return type:

List[WidgetT]

index_of(widget)

Return type:

int

remove_widget(widget)

Remove a widget from the container by reference.

Parameters:

widget (Widget) – The widget instance to remove

Return type:

None

root: Element

send_backward(widget)

Send a widget one step backward in the container.

Parameters:

widget (Widget) – The widget instance to send backward

Return type:

None

send_to_back(widget)

Send a widget to the back of the container.

Parameters:

widget (Widget) – The widget instance to send to the back

Return type:

None

property widgets: List[Widget]

Get the list of widgets and set their parent to the container.

class phoebusgen.v4.widgets.widget.Widget(name, x_pos, y_pos, width, height)

Bases: PhoebusElement, HasParent, HasVisible, HasName, HasPosition, HasActionsRulesAndScripts, HasToolTip

Base Class for all Phoebus widgets.

property actions

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.widget.WidgetType(value)

Bases: str, Enum

Enum of Phoebus Widget types.

ACTION_BUTTON = 'action_button'

ARC = 'arc'

ARRAY = 'array'

BOOLEAN_BUTTON = 'bool_button'

BYTE_MONITOR = 'byte_monitor'

CHECK_BOX = 'checkbox'

CHOICE_BUTTON = 'choice'

COMBO_BOX = 'combo'

DATA_BROWSER = 'databrowser'

ELLIPSE = 'ellipse'

EMBEDDED_DISPLAY = 'embedded'

FILE_SELECTOR = 'fileselector'

GROUP = 'group'

IMAGE = 'image'

LABEL = 'label'

LED = 'led'

LEDMULTI_STATE = 'multi_state_led'

LINEAR_METER = 'linearmeter'

METER = 'meter'

NAVIGATION_TABS = 'navtabs'

PICTURE = 'picture'

POLYGON = 'polygon'

POLYLINE = 'polyline'

PROGRESS_BAR = 'progressbar'

RADIO_BUTTON = 'radio'

RECTANGLE = 'rectangle'

SCALED_SLIDER = 'scaledslider'

SCROLLBAR = 'scrollbar'

SLIDE_BUTTON = 'slide_button'

SPINNER = 'spinner'

STRIP_CHART = 'stripchart'

SYMBOL = 'symbol'

TABLE = 'table'

TABS = 'tabs'

TANK = 'tank'

TEMPLATE_INSTANCE = 'template'

TEXT_ENTRY = 'textentry'

TEXT_SYMBOL = 'text-symbol'

TEXT_UPDATE = 'textupdate'

THERMOMETER = 'thermometer'

THREE_DVIEWER = '3dviewer'

THUMBWHEEL = 'thumbwheel'

WEB_BROWSER = 'webbrowser'

XYPLOT = 'xyplot'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

Module contents

phoebusgen.widgets Module

This module contains Python class representations of each widget. Widgets can be created by calling the widget class constructor, i.e. phoebusgen.widget.TextUpdate(…) or phoebusgen.widget.ScaledSlider(…). Once the class is created and assigned to a Python variable, additional methods to change widget properties are available.

Example:

>>> import phoebusgen
>>> text_update_widget = phoebusgen.widgets.TextUpdate('test widget', 'TEST:PV', 10, 20, 20, 50)
>>> text_update_widget.predefined_foreground_color(phoebusgen.colors.OK)
>>> text_update_widget.font_style_bold()
>>> print(text_update_widget)
<?xml version="1.0" ?>
<widget type="textupdate" version="2.0.0">
  <name>test widget</name>
  <x>10</x>
  <y>20</y>
  <width>20</width>
  <height>50</height>
  <pv_name>TEST:PV</pv_name>
  <foreground_color>
    <color name="OK" red="0" green="255" blue="0" alpha="255"/>
  </foreground_color>
  <font>
    <font family="Liberation Sans" size="14" style="BOLD"/>
  </font>
</widget>

class phoebusgen.v4.widgets.ActionButton(name, text, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasText, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasHorizontalAlignment, HasVerticalAlignment, HasRotationStep, HasEnabled, HasAlarmBorder, HasConfirmation

ActionButton Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property confirm_message

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rotation_step

property rules

property scripts

property show_confirm_dialog

property text

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Arc(name, x, y, width, height)

Bases: Widget, HasMacros, HasAngle, HasLineWidth, HasLineColor, HasLineStyle, HasBackgroundColor, HasTransparent

Arc Phoebus Widget

property actions

property background_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property start_angle

property tooltip

property total_angle

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Array(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasMacros, HasForegroundColor, HasBackgroundColor, HasAlarmBorder

Array Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.BooleanButton(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBit, HasOnOffImages, HasShowLED, HasFont, HasForegroundColor, HasBackgroundColor, HasLabelsFromPV, HasAlarmBorder, HasEnabled, HasButtonMode, HasConfirmation, HasHorizontalAlignment, HasVerticalAlignment

BooleanButton Phoebus Widget

property actions

property background_color

property bit

property border_alarm_sensitive

property confirm_message

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property labels_from_pv

property mode

property name

property off_image

property on_image

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property show_led

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property x

property y

class phoebusgen.v4.widgets.ByteMonitor(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasStartBit, HasNumBits, HasReverseBits, HasHorizontal, HasSquare, HasOnOffColors, HasForegroundColor, HasFont, HasLabels, HasAlarmBorder

ByteMonitor Phoebus Widget

property actions

property border_alarm_sensitive

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

property labels

property name

property num_bits

property off_color

property on_color

parent: Optional['HasWidgets'] = None

property pv_name

property reverse_bits

root: Element

property rules

property scripts

property square

property start_bit

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.CheckBox(name, label, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBit, HasLabel, HasFont, HasForegroundColor, HasAutoSize, HasAlarmBorder, HasConfirmation

CheckBox Phoebus Widget

property actions

property auto_size

property bit

property border_alarm_sensitive

property confirm_message

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property label

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.ChoiceButton(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasSelectedColor, HasAlarmBorder, HasItems, HasItemsFromPV, HasConfirmation, HasHorizontalAlignment, HasVerticalAlignment

ChoiceButton Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property confirm_message

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property items

property items_from_pv

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property selected_color

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property x

property y

class phoebusgen.v4.widgets.ComboBox(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasAlarmBorder, HasItems, HasItemsFromPV, HasEditable, HasEnabled, HasConfirmation

ComboBox Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property confirm_message

property editable

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property items

property items_from_pv

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.DataBrowser(name, file, x, y, width, height)

Bases: Widget, HasMacros, HasFile, HasShowToolbar, HasSelectionValuePV

DataBrowser Phoebus Widget

property actions

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property selection_value_pv

property show_toolbar

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Ellipse(name, x, y, width, height)

Bases: Widget, HasMacros, HasLineWidth, HasLineColor, HasLineStyle, HasBackgroundColor, HasTransparent

Ellipse Phoebus Widget

property actions

property background_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.EmbeddedDisplay(name, file, x, y, width, height)

Bases: Widget, HasMacros, HasFile, HasResizeBehavior, HasGroupName, HasTransparent, HasBorder

EmbeddedDisplay Phoebus Widget

property actions

property border_color

property border_width

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property group_name

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

parent: Optional['HasWidgets'] = None

property resize_behavior

root: Element

property rules

property scripts

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.FileSelector(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFileComponent, HasAlarmBorder, HasEnabled

FileSelector Phoebus Widget

property actions

property border_alarm_sensitive

property enabled

property file_component

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Group(name, x, y, width, height)

Bases: Widget, HasWidgets, HasMacros, HasGroupStyle, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasLineColor

Group Phoebus Widget

property actions

add_widget(elem)

Add widget or list of widgets to screen.

Parameters:

elem (Union[Widget, Sequence[Widget]]) – <list/Phoebusgen.widget> List of Phoebusgen.widget’s or a single widget to add

Return type:

None

property background_color

bring_forward(widget)

Bring a widget one step forward in the container.

Parameters:

widget (Widget) – The widget instance to bring forward

Return type:

None

bring_to_front(widget)

Bring a widget to the front of the container.

Parameters:

widget (Widget) – The widget instance to bring to the front

Return type:

None

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

get_all_widgets()

Get a list of all widgets contained within the container, including nested widgets.

Returns:

List of all Widget instances contained within the container

Return type:

List[Widget]

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

get_widget_names()

Get a set of widget names contained within the container.

Returns:

Set of widget names contained within the container

Return type:

Set[str]

get_widgets()

Get a list of all widgets contained within the container.

Widgets are returned in the order they appear in the XML, which is the order they are rendered in Phoebus (i.e. widgets later in the XML will be rendered on top of widgets earlier in the XML).

Returns:

List of Widget instances for each widget element contained within the container

Return type:

List[Widget]

get_widgets_by_property(property_name)

Get a list of widgets contained within the container that have a property named property_name.

Parameters:

property_name (str) – Name of property to filter by

Returns:

List of Widget instances that have a property named property_name

Return type:

List[Widget]

get_widgets_by_property_class(prop_type)

Get a list of widgets contained within the container that have a property of type prop_type.

Parameters:

prop_type (Type[TypeVar(PropertyT, bound= PropertyBase)]) – Property type to filter by

Returns:

List of Widget instances that have a property of type prop_type

Return type:

List[PropertyT]

get_widgets_by_type(widget_type)

Get a list of widgets contained within the container that are of type widget_type.

Parameters:

widget_type (Type[TypeVar(WidgetT, bound= Widget)]) – Widget type to filter by

Returns:

List of Widget instances of type widget_type contained within the container

Return type:

List[WidgetT]

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

index_of(widget)

Return type:

int

property line_color

property macros

property name

parent: Optional['HasWidgets'] = None

remove_widget(widget)

Remove a widget from the container by reference.

Parameters:

widget (Widget) – The widget instance to remove

Return type:

None

root: Element

property rules

property scripts

send_backward(widget)

Send a widget one step backward in the container.

Parameters:

widget (Widget) – The widget instance to send backward

Return type:

None

send_to_back(widget)

Send a widget to the back of the container.

Parameters:

widget (Widget) – The widget instance to send to the back

Return type:

None

property style

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property widgets: List[Widget]

Get the list of widgets and set their parent to the container.

property width

property x

property y

class phoebusgen.v4.widgets.HasWidgets(widgets_tag_name=None)

Bases: PhoebusElement, PropertyBase

add_widget(elem)

Add widget or list of widgets to screen.

Parameters:

elem (Union[Widget, Sequence[Widget]]) – <list/Phoebusgen.widget> List of Phoebusgen.widget’s or a single widget to add

Return type:

None

bring_forward(widget)

Bring a widget one step forward in the container.

Parameters:

widget (Widget) – The widget instance to bring forward

Return type:

None

bring_to_front(widget)

Bring a widget to the front of the container.

Parameters:

widget (Widget) – The widget instance to bring to the front

Return type:

None

classmethod from_element(element)

Create a PhoebusElement from an XML Element.

Parameters:

element (Element) – XML Element to create from

Return type:

TypeVar(PhoebusElementT, bound= PhoebusElement)

Returns:

PhoebusElement instance

get_all_widgets()

Get a list of all widgets contained within the container, including nested widgets.

Returns:

List of all Widget instances contained within the container

Return type:

List[Widget]

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

get_widget_names()

Get a set of widget names contained within the container.

Returns:

Set of widget names contained within the container

Return type:

Set[str]

get_widgets()

Get a list of all widgets contained within the container.

Widgets are returned in the order they appear in the XML, which is the order they are rendered in Phoebus (i.e. widgets later in the XML will be rendered on top of widgets earlier in the XML).

Returns:

List of Widget instances for each widget element contained within the container

Return type:

List[Widget]

get_widgets_by_property(property_name)

Get a list of widgets contained within the container that have a property named property_name.

Parameters:

property_name (str) – Name of property to filter by

Returns:

List of Widget instances that have a property named property_name

Return type:

List[Widget]

get_widgets_by_property_class(prop_type)

Get a list of widgets contained within the container that have a property of type prop_type.

Parameters:

prop_type (Type[TypeVar(PropertyT, bound= PropertyBase)]) – Property type to filter by

Returns:

List of Widget instances that have a property of type prop_type

Return type:

List[PropertyT]

get_widgets_by_type(widget_type)

Get a list of widgets contained within the container that are of type widget_type.

Parameters:

widget_type (Type[TypeVar(WidgetT, bound= Widget)]) – Widget type to filter by

Returns:

List of Widget instances of type widget_type contained within the container

Return type:

List[WidgetT]

index_of(widget)

Return type:

int

remove_widget(widget)

Remove a widget from the container by reference.

Parameters:

widget (Widget) – The widget instance to remove

Return type:

None

root: Element

send_backward(widget)

Send a widget one step backward in the container.

Parameters:

widget (Widget) – The widget instance to send backward

Return type:

None

send_to_back(widget)

Send a widget to the back of the container.

Parameters:

widget (Widget) – The widget instance to send to the back

Return type:

None

property widgets: List[Widget]

Get the list of widgets and set their parent to the container.

class phoebusgen.v4.widgets.Image(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBackgroundColor, HasForegroundColor, HasShowToolbar, HasColorMap, HasColorBar, HasXAxis, HasYAxis, HasAlarmBorder, HasLimitsFromPV, HasDataWidthAndHeight, HasInterpolation, HasColorMode, HasUnisignedData, HasAutoScale, HasLogScale, HasMinMax, HasCursor, HasROIs

Image Phoebus Widget

property actions

property auto_scale

property background_color

property border_alarm_sensitive

property color_bar

property color_map

property color_mode

property cursor_crosshair

property cursor_info_pv

property data_height

property data_width

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property interpolation

property limits_from_pv

property log_scale

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

property rois

root: Element

property rules

property scripts

property show_toolbar

property tool_tip

property tooltip

property unsigned_data

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property x_axis

property x_pv

property y

property y_axis

property y_pv

class phoebusgen.v4.widgets.LED(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBit, HasOnOffColors, HasOnOffLabels, HasFont, HasForegroundColor, HasLineColor, HasSquare, HasLabelsFromPV, HasAlarmBorder

LED Phoebus Widget

property actions

property bit

property border_alarm_sensitive

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property labels_from_pv

property line_color

property name

property off_color

property off_label

property on_color

property on_label

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property square

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.LEDMultiState(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasLineColor, HasSquare, HasAlarmBorder, HasStates, HasFallback

LEDMultiState Phoebus Widget

property actions

property border_alarm_sensitive

property fallback_color

property fallback_label

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property square

property states

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Label(name, text, x, y, width, height)

Bases: Widget, HasText, HasMacros, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasHorizontalAlignment, HasVerticalAlignment, HasRotationStep, HasWrapWords, HasAutoSize, HasBorder

Label Phoebus Widget

property actions

property auto_size

property background_color

property border_color

property border_width

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rotation_step

property rules

property scripts

property text

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property wrap_words

property x

property y

class phoebusgen.v4.widgets.LinearMeter(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasForegroundColor, HasBackgroundColor, HasFont, HasFormat, HasPrecision, HasShowValue, HasShowUnits, HasShowLimits, HasAlarmBorder, HasScaleVisible, HasHorizontal, HasLimitsFromPV, HasMinMax, HasKnobAndNeedleColor, HasKnobAndNeedleSize, HasLinearMeterColors, HasWarningLevels

LinearMeter Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property colors

property font

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

property knob_color

property knob_size

property level_high

property level_hihi

property level_lolo

property level_low

property limits_from_pv

property maximum

property minimum

property name

property needle_color

property needle_width

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rules

property scale_visible

property scripts

property show_limits

property show_units

property show_value

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Meter(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasForegroundColor, HasBackgroundColor, HasFont, HasFormat, HasPrecision, HasShowValue, HasShowUnits, HasShowLimits, HasAlarmBorder, HasLimitsFromPV, HasMinMax, HasKnobAndNeedleColor

Meter Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property font

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property knob_color

property limits_from_pv

property maximum

property minimum

property name

property needle_color

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rules

property scripts

property show_limits

property show_units

property show_value

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.NavigationTabs(name, x, y, width, height)

Bases: Widget, HasNavTabs, HasSelectedColor, HasDeselectedColor, HasFont

NavigationTabs Phoebus Widget

property actions

property active_tab

property deselected_color

property direction

property font

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property selected_color

property tab_height

property tab_spacing

property tab_width

property tabs

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Picture(name, file, x, y, width, height)

Bases: Widget, HasMacros, HasFile, HasStretchToFit, HasRotation, HasOpacity

Picture Phoebus Widget

property actions

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

property opacity

parent: Optional['HasWidgets'] = None

root: Element

property rotation

property rules

property scripts

property stretch_to_fit

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Polygon(name, x, y, width, height)

Bases: Widget, HasMacros, HasLineWidth, HasLineColor, HasLineStyle, HasTransparent, HasPoints, HasBackgroundColor

Polygon Phoebus Widget

property actions

property background_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

property points

root: Element

property rules

property scripts

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Polyline(name, x, y, width, height)

Bases: Widget, HasMacros, HasLineWidth, HasLineColor, HasLineStyle, HasArrows, HasPoints

Polyline Phoebus Widget

property actions

property arrow_length

property arrows

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

property points

root: Element

property rules

property scripts

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.ProgressBar(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFillColor, HasBackgroundColor, HasHorizontal, HasAlarmBorder, HasLimitsFromPV, HasMinMax

ProgressBar Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property fill_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

property limits_from_pv

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.RadioButton(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasHorizontalAlignment, HasAlarmBorder, HasItems, HasItemsFromPV, HasEnabled, HasConfirmation

RadioButton Phoebus Widget

property actions

property border_alarm_sensitive

property confirm_message

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property items

property items_from_pv

property name

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Rectangle(name, x, y, width, height)

Bases: Widget, HasMacros, HasLineWidth, HasLineColor, HasLineStyle, HasBackgroundColor, HasTransparent, HasCorners

Rectangle Phoebus Widget

property actions

property background_color

property corner_height

property corner_width

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property line_color

property line_style

property line_width

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.ScaledSlider(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasHorizontalAlignment, HasForegroundColor, HasBackgroundColor, HasTransparent, HasFont, HasShowScale, HasShowMinorTicks, HasMajorTicksPixelDist, HasScaleFormat, HasWarningLevels, HasWarningLevelsVisibility, HasAlarmBorder, HasIncrement, HasMinMax, HasLimitsFromPV, HasEnabled

ScaledSlider Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property increment

property level_high

property level_hihi

property level_lolo

property level_low

property limits_from_pv

property major_ticks_pixel_dist

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scale_format

property scripts

property show_high

property show_hihi

property show_lolo

property show_low

property show_minor_ticks

property show_scale

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Scrollbar(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasHorizontalAlignment, HasShowValueTip, HasAlarmBorder, HasMinMax, HasLimitsFromPV, HasBarLength, HasIncrement, HasEnabled

Scrollbar Phoebus Widget

property actions

property bar_length

property border_alarm_sensitive

property enabled

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property increment

property limits_from_pv

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property show_value_tip

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.SlideButton(name, label, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasBit, HasLabel, HasOnOffColors, HasFont, HasForegroundColor, HasAutoSize, HasAlarmBorder, HasEnabled, HasConfirmation

SlideButton Phoebus Widget

property actions

property auto_size

property bit

property border_alarm_sensitive

property confirm_message

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property label

property name

property off_color

property on_color

parent: Optional['HasWidgets'] = None

property password

property pv_name

root: Element

property rules

property scripts

property show_confirm_dialog

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Spinner(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFormat, HasPrecision, HasShowUnits, HasForegroundColor, HasBackgroundColor, HasButtonsOnLeft, HasAlarmBorder, HasMinMax, HasLimitsFromPV, HasIncrement, HasEnabled

Spinner Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property buttons_on_left

property enabled

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property increment

property limits_from_pv

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rules

property scripts

property show_units

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.StripChart(name, x, y, width, height)

Bases: Widget, HasForegroundColor, HasBackgroundColor, HasShowGrid, HasTitle, HasTitleFont, HasLabelFont, HasScaleFont, HasShowToolbar, HasShowLegend, HasTimeRange, HasYAxes, HasTraces

StripChart Phoebus Widget

property actions

property background_color

property end

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property label_font

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scale_font

property scripts

property show_grid

property show_legend

property show_toolbar

property start

property title

property title_font

property tooltip

property traces

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

property y_axes

class phoebusgen.v4.widgets.Symbol(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasSymbols, HasBackgroundColor, HasInitialIndex, HasRotation, HasShowIndex, HasTransparent, HasAlarmBorder, HasArrayIndex, HasAutoSize, HasEnabled, HasPreserveRatio

Symbol Phoebus Widget

property actions

property array_index

property auto_size

property background_color

property border_alarm_sensitive

property enabled

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property initial_index

property name

parent: Optional['HasWidgets'] = None

property preserve_ratio

property pv_name

root: Element

property rotation

property rules

property scripts

property show_index

property symbols

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Tab(name, root=None)

Bases: HasWidgets, HasName

Tab object for tabs widget

add_widget(elem)

Add widget or list of widgets to screen.

Parameters:

elem (Union[Widget, Sequence[Widget]]) – <list/Phoebusgen.widget> List of Phoebusgen.widget’s or a single widget to add

Return type:

None

bring_forward(widget)

Bring a widget one step forward in the container.

Parameters:

widget (Widget) – The widget instance to bring forward

Return type:

None

bring_to_front(widget)

Bring a widget to the front of the container.

Parameters:

widget (Widget) – The widget instance to bring to the front

Return type:

None

classmethod from_element(element)

Convert an XML element into a Tab instance.

Parameters:

• cls – The Tab class

• element (Element) – The XML element to convert

Returns:

A Tab instance

Return type:

Tab

get_all_widgets()

Get a list of all widgets contained within the container, including nested widgets.

Returns:

List of all Widget instances contained within the container

Return type:

List[Widget]

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

get_widget_names()

Get a set of widget names contained within the container.

Returns:

Set of widget names contained within the container

Return type:

Set[str]

get_widgets()

Get a list of all widgets contained within the container.

Widgets are returned in the order they appear in the XML, which is the order they are rendered in Phoebus (i.e. widgets later in the XML will be rendered on top of widgets earlier in the XML).

Returns:

List of Widget instances for each widget element contained within the container

Return type:

List[Widget]

get_widgets_by_property(property_name)

Get a list of widgets contained within the container that have a property named property_name.

Parameters:

property_name (str) – Name of property to filter by

Returns:

List of Widget instances that have a property named property_name

Return type:

List[Widget]

get_widgets_by_property_class(prop_type)

Get a list of widgets contained within the container that have a property of type prop_type.

Parameters:

prop_type (Type[TypeVar(PropertyT, bound= PropertyBase)]) – Property type to filter by

Returns:

List of Widget instances that have a property of type prop_type

Return type:

List[PropertyT]

get_widgets_by_type(widget_type)

Get a list of widgets contained within the container that are of type widget_type.

Parameters:

widget_type (Type[TypeVar(WidgetT, bound= Widget)]) – Widget type to filter by

Returns:

List of Widget instances of type widget_type contained within the container

Return type:

List[WidgetT]

index_of(widget)

Return type:

int

property name

remove_widget(widget)

Remove a widget from the container by reference.

Parameters:

widget (Widget) – The widget instance to remove

Return type:

None

root: Element

send_backward(widget)

Send a widget one step backward in the container.

Parameters:

widget (Widget) – The widget instance to send backward

Return type:

None

send_to_back(widget)

Send a widget to the back of the container.

Parameters:

widget (Widget) – The widget instance to send to the back

Return type:

None

property widgets: List[Widget]

Get the list of widgets and set their parent to the container.

class phoebusgen.v4.widgets.Table(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasShowToolbar, HasAlarmBorder, HasEditable, HasSelectRows, HasSelectionPV, HasColumns

Table Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property columns

property editable

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property select_rows

property selection_pv

property show_toolbar

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Tabs(name, x, y, width, height)

Bases: Widget, HasTabs, HasMacros, HasTabActiveHeightDirection, HasFont, HasBackgroundColor

Tabs Phoebus Widget

property actions

property active_tab

property background_color

property direction

property font

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property macros

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tab_height

property tabs

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Tank(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasFillColor, HasEmptyColor, HasScaleVisible, HasAlarmBorder, HasLimitsFromPV, HasMinMax, HasLogScale, HasHorizontal

Tank Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property empty_color

property fill_color

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

property limits_from_pv

property log_scale

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scale_visible

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.TemplateInstance(name, file, x, y, width, height)

Bases: Widget, HasWidgets, HasFile, HasInstances, HasTransparent, HasHorizontal, HasWrapCount, HasGap

TemplateInstance Phoebus Widget

property actions

add_widget(elem)

Add widget or list of widgets to screen.

Parameters:

elem (Union[Widget, Sequence[Widget]]) – <list/Phoebusgen.widget> List of Phoebusgen.widget’s or a single widget to add

Return type:

None

bring_forward(widget)

Bring a widget one step forward in the container.

Parameters:

widget (Widget) – The widget instance to bring forward

Return type:

None

bring_to_front(widget)

Bring a widget to the front of the container.

Parameters:

widget (Widget) – The widget instance to bring to the front

Return type:

None

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

property gap

get_all_widgets()

Get a list of all widgets contained within the container, including nested widgets.

Returns:

List of all Widget instances contained within the container

Return type:

List[Widget]

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

get_widget_names()

Get a set of widget names contained within the container.

Returns:

Set of widget names contained within the container

Return type:

Set[str]

get_widgets()

Get a list of all widgets contained within the container.

Widgets are returned in the order they appear in the XML, which is the order they are rendered in Phoebus (i.e. widgets later in the XML will be rendered on top of widgets earlier in the XML).

Returns:

List of Widget instances for each widget element contained within the container

Return type:

List[Widget]

get_widgets_by_property(property_name)

Get a list of widgets contained within the container that have a property named property_name.

Parameters:

property_name (str) – Name of property to filter by

Returns:

List of Widget instances that have a property named property_name

Return type:

List[Widget]

get_widgets_by_property_class(prop_type)

Get a list of widgets contained within the container that have a property of type prop_type.

Parameters:

prop_type (Type[TypeVar(PropertyT, bound= PropertyBase)]) – Property type to filter by

Returns:

List of Widget instances that have a property of type prop_type

Return type:

List[PropertyT]

get_widgets_by_type(widget_type)

Get a list of widgets contained within the container that are of type widget_type.

Parameters:

widget_type (Type[TypeVar(WidgetT, bound= Widget)]) – Widget type to filter by

Returns:

List of Widget instances of type widget_type contained within the container

Return type:

List[WidgetT]

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal

index_of(widget)

Return type:

int

property instances

property name

parent: Optional['HasWidgets'] = None

remove_widget(widget)

Remove a widget from the container by reference.

Parameters:

widget (Widget) – The widget instance to remove

Return type:

None

root: Element

property rules

property scripts

send_backward(widget)

Send a widget one step backward in the container.

Parameters:

widget (Widget) – The widget instance to send backward

Return type:

None

send_to_back(widget)

Send a widget to the back of the container.

Parameters:

widget (Widget) – The widget instance to send to the back

Return type:

None

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property widgets: List[Widget]

Get the list of widgets and set their parent to the container.

property width

property wrap_count

property x

property y

class phoebusgen.v4.widgets.TextEntry(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasFormat, HasPrecision, HasShowUnits, HasWrapWords, HasMultiLine, HasAlarmBorder, HasEnabled, HasBorder, HasHorizontalAlignment, HasVerticalAlignment

TextEntry Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property border_color

property border_width

property enabled

property font

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property multi_line

property name

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rules

property scripts

property show_units

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property wrap_words

property x

property y

class phoebusgen.v4.widgets.TextSymbol(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasHorizontalAlignment, HasVerticalAlignment, HasRotation, HasWrapWords, HasAlarmBorder, HasEnabled, HasArrayIndex, HasSymbols

TextSymbol Phoebus Widget

property actions

property array_index

property background_color

property border_alarm_sensitive

property enabled

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rotation

property rules

property scripts

property symbols

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property wrap_words

property x

property y

class phoebusgen.v4.widgets.TextUpdate(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor, HasTransparent, HasFormat, HasPrecision, HasShowUnits, HasHorizontalAlignment, HasVerticalAlignment, HasWrapWords, HasRotationStep, HasBorder, HasAlarmBorder, HasInteractive

TextUpdate Phoebus Widget

property actions

property background_color

property border_alarm_sensitive

property border_color

property border_width

property font

property foreground_color

property format

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property horizontal_alignment

property interactive

property name

parent: Optional['HasWidgets'] = None

property precision

property pv_name

root: Element

property rotation_step

property rules

property scripts

property show_units

property tool_tip

property tooltip

property transparent

property version: str

Get widget version from root widget.

Returns:

Version string

property vertical_alignment

property visible

property width

property wrap_words

property x

property y

class phoebusgen.v4.widgets.Thermometer(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFillColor, HasAlarmBorder, HasLimitsFromPV, HasMinMax

Thermometer Phoebus Widget

property actions

property border_alarm_sensitive

property fill_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property limits_from_pv

property maximum

property minimum

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.ThreeDViewer(name, file, x, y, width, height)

Bases: Widget, HasFile

ThreeDViewer Phoebus Widget

property actions

property file

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Thumbwheel(name, pv_name, x, y, width, height)

Bases: Widget, HasPVName, HasFont, HasForegroundColor, HasBackgroundColor

Thumbwheel Phoebus Widget

property actions

property background_color

property font

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

property pv_name

root: Element

property rules

property scripts

property tool_tip

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.WebBrowser(name, url, x, y, width, height)

Bases: Widget, HasUrl, HasShowToolbar

WebBrowser Phoebus Widget

property actions

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property show_toolbar

property tooltip

property url

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.Widget(name, x_pos, y_pos, width, height)

Bases: PhoebusElement, HasParent, HasVisible, HasName, HasPosition, HasActionsRulesAndScripts, HasToolTip

Base Class for all Phoebus widgets.

property actions

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property tooltip

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property y

class phoebusgen.v4.widgets.WidgetType(value)

Bases: str, Enum

Enum of Phoebus Widget types.

ACTION_BUTTON = 'action_button'

ARC = 'arc'

ARRAY = 'array'

BOOLEAN_BUTTON = 'bool_button'

BYTE_MONITOR = 'byte_monitor'

CHECK_BOX = 'checkbox'

CHOICE_BUTTON = 'choice'

COMBO_BOX = 'combo'

DATA_BROWSER = 'databrowser'

ELLIPSE = 'ellipse'

EMBEDDED_DISPLAY = 'embedded'

FILE_SELECTOR = 'fileselector'

GROUP = 'group'

IMAGE = 'image'

LABEL = 'label'

LED = 'led'

LEDMULTI_STATE = 'multi_state_led'

LINEAR_METER = 'linearmeter'

METER = 'meter'

NAVIGATION_TABS = 'navtabs'

PICTURE = 'picture'

POLYGON = 'polygon'

POLYLINE = 'polyline'

PROGRESS_BAR = 'progressbar'

RADIO_BUTTON = 'radio'

RECTANGLE = 'rectangle'

SCALED_SLIDER = 'scaledslider'

SCROLLBAR = 'scrollbar'

SLIDE_BUTTON = 'slide_button'

SPINNER = 'spinner'

STRIP_CHART = 'stripchart'

SYMBOL = 'symbol'

TABLE = 'table'

TABS = 'tabs'

TANK = 'tank'

TEMPLATE_INSTANCE = 'template'

TEXT_ENTRY = 'textentry'

TEXT_SYMBOL = 'text-symbol'

TEXT_UPDATE = 'textupdate'

THERMOMETER = 'thermometer'

THREE_DVIEWER = '3dviewer'

THUMBWHEEL = 'thumbwheel'

WEB_BROWSER = 'webbrowser'

XYPLOT = 'xyplot'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.widgets.XYPlot(name, x, y, width, height)

Bases: Widget, HasForegroundColor, HasBackgroundColor, HasTitle, HasTitleFont, HasShowToolbar, HasShowLegend, HasXAxis, HasYAxes, HasTraces, HasMarkers

XYPlot Phoebus Widget

property actions

property background_color

property foreground_color

classmethod from_element(element)

Convert an XML element into a Widget instance.

Chooses the appropriate subclass based on the ‘type’ attribute of the element.

Parameters:

• cls – Description

• element (Element) – Description

Returns:

Description

Return type:

Widget

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

has_property(prop_name)

Check if widget has a prop_name.

Parameters:

prop_name (str) – Property name to check for

Return type:

bool

Returns:

True if property exists, False if not

has_property_class(prop_class)

Check if widget has a property of type prop_class.

Parameters:

prop_class (type) – Property class to check for

Return type:

bool

Returns:

True if property class exists, False if not

property height

property markers

property name

parent: Optional['HasWidgets'] = None

root: Element

property rules

property scripts

property show_legend

property show_toolbar

property title

property title_font

property tooltip

property traces

property version: str

Get widget version from root widget.

Returns:

Version string

property visible

property width

property x

property x_axis

property y

property y_axes