Plot.WeightedLine

class WeightedLine(x=None, y=None, weights=None)

A WeightedLine plots a line where the line width changes along the line.

Parameters:

  • x (Sequence | PhysicalQuantity | None) – The x-values of the data.

  • y (Sequence | PhysicalQuantity | None) – The y-values of the data.

  • weights (Sequence | None) – The weights of the data. Used for coloring or setting line widths.

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 of the line.

Return type:

float

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 line color in hex format

Return type:

str

colorMap()
Returns:

The current color map.

Return type:

str

colorMode()

The current color mode.

Returns:

The color mode.

Return type:

COLOR_MODES enum

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)

Get the data extent.

Parameters:

  • axis_name (str) – ‘x’ or ‘y’.

  • padding (float) – Padding around the data.
    Default: 0.0.

Returns:

The min/max data values for the requested axis.

Return type:

Sequence | 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

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

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.

scaling()
Returns:

The scaling of the weights.

Return type:

float

selectionDetails()
Returns:

The current selection details.

Return type:

dict | None

setAlpha(alpha)

. :param alpha: The opacity of the line. :type alpha: float

setColor(color)

Set the line color.

Note that the color map is only used when the color mode is COLOR.

Parameters:

color (str) – The color in hex format.

setColorMap(color_map)

Set a color map.

Note that the color map is only used when the color mode is COLOR_MAP.

Parameters:

color_map (str) – A color map.

setColorMode(mode)

Set the color mode (whether to use color map or color for drawing).

Parameters:

mode (COLOR_MODES enum) – The mode.

setData(x=None, y=None)

Set data.

Parameters:
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.

setLabel(label)

Set the label.

Parameters:

label (str) – The label of the line.

setOwner(owner)

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

Parameters:

owner (int | enum) – The owner type.

setScaling(scaling)

Set the scaling.

Parameters:

scaling (float) – The scaling of the weights. Requires weights to be specified to have any effect.

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.

setVisible(visible)

Set visible.

Parameters:

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

setWeights(weights)

Set the weights of the data.

Parameters:

weights (Sequence | None) – The weights of the data. Used for coloring and setting line widths.

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

weights()
Returns:

The weights of the data. Used for coloring and setting line widths.

Return type:

Sequence | None

xData()
Returns:

The x-data.

Return type:

PhysicalQuantity

yData()
Returns:

The y-data.

Return type:

PhysicalQuantity