Plot.Average

class Average

An Average can be added to a Line or a Scatter, and will then calculate the average value of its parent data.

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

attributes(latex=False, detail_level='full')

The current line attributes.

Parameters:
  • latex (bool) – If True, return the attributes in Latex format.

  • detail_level (DETAIL_LEVELS enum) – The level of detail of the attributes (unused).

Returns:

The current line attributes.

Return type:

dict

bounds()
Returns:

The bounds.

Return type:

tuple of physicalQuantity

color()
Returns:

The line color.

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.

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.

evaluate(x_data)

Evaluate the average for the given x_data.

Parameters:

x_data (PhysicalQuantity) – The x-data.

Returns:

The evaluated x data and y data.

Return type:

2-tuple of PhysicalQuantity

extent(axis_name, padding=0.0)

Get the data limits.

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

isAxisSpanned()
Returns:

True if the fit line should span the x-axis range of the plot.

Return type:

bool

isBoundsVisible()
Returns:

True, if fit bounds are shown in the plot.

Return type:

bool

isHoverable()
Returns:

True, if hoverable.

Return type:

bool

isHovered()
Returns:

True, if the item is hovered.

Return type:

bool

isInteractive()
Returns:

Whether the user can interact with this line.

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 derivable.

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

label()
Returns:

The line label.

Return type:

str

lineStyle()
Returns:

The line style.

Return type:

str | None

lineWidth()
Returns:

The line width.

Return type:

float

markerEdgeColor()
Returns:

The edge color of the marker in hex format.

Return type:

str

markerEvery()
Returns:

The number of points between every marker.

Return type:

int

markerFaceColor()
Returns:

The face color of the marker in hex format.

Return type:

str

markerSize()
Returns:

The marker size.

Return type:

float

markerStyle()

. :returns: The marker style. :rtype: str | None

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.

selectionDetails()
Returns:

The current selection details.

Return type:

dict | None

setAlpha(alpha)

Set the opacity for the line.

Parameters:

alpha (float) – The opacity.

setBounds(lower, upper, update=True)

Set the derived line bounds.

Parameters:
  • lower (float | PhysicalQuantity) – The lower bound.

  • upper (float | PhysicalQuantity) – The upper bound.

  • update (bool) – True, if we should call update.

setBoundsVisible(visible)

Set whether to indicate the fit bounds in the plot.

Parameters:

visible (bool) – If True, fit bounds will be shown in the plot.

setColor(color)

Set the line color.

Parameters:

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

setData(x=None, y=None)

Overload since derived lines should not expose data setting.

Parameters:
  • x (iterable) – The x values.

  • y (iterable) – They values.

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.

setInteractive(interactive)

Set whether the user can interact with this line.

Parameters:

interactive (bool) – The desired state.

setLabel(label)

Set the label.

Parameters:

label (str) – The line label.

setLineStyle(line_style)

Set the line style.

Parameters:

line_style (str | None) – The line style.

setLineWidth(line_width)

Set the line width.

Parameters:

line_width (float) – The line width.

setMarkerColor(color)

Set color of the marker. Remember to also set a valid marker style.

Parameters:

color (valid color) – The color to set.

setMarkerEdgeColor(color)

Set the marker edge color. Remember to also set a valid marker style.

Parameters:

color (str) – The edge color of the marker.

setMarkerEvery(every)

Set the number of points between each marker. Remember to also set a valid marker style.

Parameters:

every (int) – The number of points between every marker.

setMarkerFaceColor(color)

Set the marker face-color. Remember to also set a valid marker style.

Parameters:

color (str) – The face color of the marker.

setMarkerSize(size)

Set the marker size. Remember to also set a valid marker style.

Parameters:

size (float) – The marker size.

setMarkerStyle(marker)

Set the marker style.

Parameters:

marker (str | None) – The marker style.

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, details=None)

Set the item as selected or unselected.

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

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

setSpanAxis(span_axis)

Set whether the fit line should span the x-axis range of the plot.

Parameters:

span_axis (bool) – If True, the fit line should span the x-axis range of the plot.

setVisible(visible)

Set visible.

Parameters:

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

sourceData()

Checks if the source data is valid, and if yes, return the valid source data on the form: (xs, ys, x_min, x_max, x_unit, y_unit) Else returns None

Returns:

The validated and clipped source data.

Return type:

tuple | None

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

update(data=None)

Perform the update.

Parameters:

data (tuple | NoneType) – The source data to use.

validSourceCoordinates(xs, ys)

True if the provided data coordinates are valid.

Parameters:
  • xs (ndarray) – The source x coordinates.

  • ys (ndarray) – The source y coordinates.

Returns:

True, if the coordinates are valid.

Return type:

bool

xData()
Returns:

The x-data.

Return type:

PhysicalQuantity

yData()
Returns:

The y-data.

Return type:

PhysicalQuantity