Plot.LineGroup¶
- class LineGroup(items=None)¶
Group containing multiple lines.
The group makes it easy to handle many lines.
It also has better performance when drawing lines, but unfortunately only supports a subset of the normal line properties. This means that e.g. markers cannot be drawn, and that visibility is only controlled for all line in the line group.
The line group also shows up in the legend as a single item.
- Parameters:
items (list) – List of Line instances.
- 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.
- alpha()¶
- Returns:
The opacity for the group.
- Return type:
float | None
- applyStyle(style_scheme=None, style_properties=None)¶
Override PlotItem.applyStyle.
Apply the style of the LineGroup to the lines.
- 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.
- colors()¶
- Returns:
The colors.
- Return type:
list
- 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.
- 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.
- extent(axis_name, padding=0.0)¶
Set extent.
- Parameters:
axis_name (str) – The axss name (‘x’ or ‘y’).
padding (float) – The extra padding.
- Returns:
The extent.
- Return type:
Sequence of PhysicalQuantity
- 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
- isHoverable()¶
- Returns:
True, if hoverable.
- Return type:
bool
- isHovered()¶
- Returns:
True, if the item is hovered.
- 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
- 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
- label()¶
- Returns:
The current label.
- Return type:
str
- lineStyles()¶
- Returns:
A list of line style for each item.
- Return type:
list
- lineWidths()¶
- Returns:
A list of line widths for each item.
- Return type:
list
- 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
- 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
- setAlpha(alpha)¶
Set the alpha/opacity, for all items.
- Parameters:
alpha (float) – The opacity.
- setColor(color)¶
Set the line color for all items.
- Parameters:
color (Any matplotlib supported color definition) – The color.
- setColors(colors)¶
Set the line color for all items.
- Parameters:
color (Any matplotlib supported color definition) – The color.
- 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.
- setItems(items)¶
Set items.
- Parameters:
items (items.) – The items to set.
- setLabel(label)¶
Set the label.
- Parameters:
label (str) – The label of the linegroup.
- setLineStyle(line_style)¶
Set the line style, for all items.
- Parameters:
line_style (str | None) – The line style.
- setLineStyles(line_styles)¶
Set the line style, for all items.
- Parameters:
line_style (list) – The line style list.
- setLineWidth(line_width)¶
Set the line width, for all items.
- Parameters:
line_width (float) – The line width.
- setLineWidths(line_widths)¶
Set the line width, for all items. return list(self._properties[‘items’])
- Parameters:
line_width (list) – The line width list.
- setOwner(owner)¶
Set the owner of the item (either OWNERS.MODEL or OWNERS.VIEW).
- Parameters:
owner (int | enum) – The owner type.
- setSelectable(selectable)¶
Set whether this item is selectable.
- Parameters:
selectable (bool) – True, if the item should be selectable.
- setSelected(selected, information=None)¶
Set the selected property. Overloads the base class method.
- Parameters:
selected (bool) – True, if item given by index should be selected.
information (dict) – information of the pick event.
- 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