Plot.AttributesLabel

class AttributesLabel(x, y)

A Label that displays the attributes of a parent object in the plot.

Parameters:
addItem(item, emit=True)

Add item as child of this item.

Parameters:

  • item (PlotItem based) – The item.

  • emit (bool) – True, if change should be emitted.

addSubscriber(subscriber)

Add a subscriber. Each subscriber is called once every time the plot item updates.

Parameters:

subscriber (bound method) – The subscriber. Must be callable.

addTag(*args)

Add tag. Used for grouping plot items.

Parameters:

*args (tuple of str) – The tags to add.

alignment()
Returns:

The vertical and horizontal alignment.

Return type:

2-tuple of str

applyStyle(style_scheme=None, style_properties=None)

Apply style properties from a style scheme.

Parameters:

  • style_scheme (dict) – The style scheme.

  • style_properties (dict | None) – A specific set of style properties to apply. If None, the style properties are retrieved from the plot model using the given style scheme.

color()
Returns:

The label color in hex format.

Return type:

str

copy()

Make a copy of the plot storable by using the serialize/deserialize functionality.

This creates a new instance with a new id, but all other properties copied.

detailLevel()
Returns:

The detail level of the attributes.

Return type:

enum

emit(key, value=None)

Emit a single key and value change to all subscribers.

Parameters:

  • key (str) – The key to emit.

  • value (object) – The value to emit.

fontSize()
Returns:

The font size in points.

Return type:

float

classmethod fromProperties(properties)

Create a plot storable from a dict of properties.

Used when deserializing a PlotStorable.

Parameters:

properties (dict) – The properties which are used to populate the properties dict of the newly created plot storable.

Returns:

The newly created PlotStorable.

Return type:

PlotStorable

hoverDetails()
Returns:

The current hover details.

Return type:

dict | None

isBoxOn()
Returns:

True, if the label has a box.

Return type:

bool

isHoverable()
Returns:

True, if hoverable.

Return type:

bool

isHovered()
Returns:

True, if the item is hovered.

Return type:

bool

isMovable()
Returns:

True, if the label is movable.

Return type:

bool

isSelectable()
Returns:

True, if the item is selectable.

Return type:

bool

isSelected()
Returns:

True, if the item is selected.

Return type:

bool

classmethod isValidParent(item)

Check if an item is a valid parent.

Parameters:

item (PlotItem based) – The item to check.

Returns:

True, if the item can be derived.

Return type:

bool

isVisible()
Returns:

True, if the item is visible.

Return type:

bool

items(selected=None, tag=None)

Return the requested items.

The optional selected key word filter selected and deselected lines, with the options:

  • True : Only selected items

  • False : Only unselected items

  • None : All items.

Parameters:

  • selected (None | bool) – True, if only selected items should be returned.

  • tag (str) – The tag to filter on.

Returns:

The child items with the selected filtering.

Return type:

items

model()
Returns:

The model that this item belongs to.

Return type:

PlotModel | None

order()
Returns:

A number describing the current order of the item within the PlotModel. Can be used for sorting.

Return type:

int | None

owner()
Returns:

The owner type.

Return type:

int | enum

parent()
Returns:

The parent.

Return type:

PlotItem based | None

position()
Returns:

The label postion.

Return type:

None | 2-tuple of PhysicalQuantity

removeItem(item, emit=True)

Remove item from the child items.

Parameters:

  • item (PlotItem based) – The item to remove.

  • emit (bool) – True, if removal should be emitted.

removeSubscriber(subscriber)

Remove a subscriber method from the plot item updates.

Parameters:

subscriber (bound method) – The subscriber. Must be callable.

selectionDetails()
Returns:

The current selection details.

Return type:

dict | None

setAlignment(vertical, horizontal)

Set the label alignment with respect to the position.

Parameters:

  • vertical (str) – The vertical alignment (‘top’, ‘center’, ‘bottom’).

  • horizontal (str) – The horizontal alignment (‘left’, ‘center’, ‘right’).

setBoxOn(box_on)

Set whether a box should be drawn around the label text.

Parameters:

box_on (bool) – True, if the label should have a box.

setColor(color)

Set the color.

Parameters:

color (str) – The label color in hex format.

setDetailLevel(level)

Set the detail level.

Parameters:

level (enum) – A level from the DETAIL_LEVELS enum.

setFontSize(fontsize)

Set the font size.

Parameters:

fontsize (float) – The font size in points.

setHoverable(hoverable)

Enable or disable hover evetn. When enabled the line will be set to hovered, once the mouse hovers over the item.

Parameters:

hoverable (bool) – True, if the item should be sensitive to hover events.

setHovered(hovered, details=None)

Set hovered with some details. This is called once the mouse hovers over the item. Should only be called once hoverable has been enabled.

Parameters:

  • hovered (bool) – True, if the item was hovered.

  • details (dict | NoneType) – The hover details.

setMovable(movable)

Set whether the label should be movable.

Parameters:

movable (bool) – True, if the label should be movable.

setOwner(owner)

Set the owner of the item (either OWNERS.MODEL or OWNERS.VIEW).

Parameters:

owner (int | enum) – The owner type.

setPosition(x, y)

Set the label position.

Parameters:
setSelectable(selectable)

Set whether this item is selectable.

Parameters:

selectable (bool) – True, if the item should be selectable.

setSelected(selected, details=None)

Set the item as selected or unselected.

Parameters:

  • selected (bool) – True, if item should be selected.

  • details (dict | NoneType) – The selection details.

setText(text)

Set the text.

Parameters:

text (str) – The label text.

setVisible(visible)

Set visible.

Parameters:

visible (bool) – True, if the item should be visible.

style()
Returns:

All the current style properties.

Return type:

dict

styleProperties(style_scheme)

Check if the given style scheme has a style for this item.

Parameters:

style_scheme (dict) – The style scheme.

Returns:

The style, if any.

Return type:

dict | None

tags()
Returns:

The set of tags.

Return type:

set

text()
Returns:

The label text.

Return type:

str

update(data=None)

Internal method.