Plot.HorizontalFill

class HorizontalFill(x, y_lower, y_upper)

A HorizontalFill for filling an area between two lines

Parameters:
  • x (Sequence of PhysicalQuantity) – The x-values of the data.
  • y_lower (Sequence of PhysicalQuantity) – The lower y-values in the fill.
  • y_upper (Sequence of PhysicalQuantity) – The upper y-values in the fill.
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 gouping plot items.

Parameters:*args

The tags to add.

alpha()
Returns:The opacity of the fill.
Return type:float
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.

edgeColor()
Returns:The edge color of the fill in hex format.
Return type:str
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)

The data extent.

Parameters:
  • axis_name (str) – ‘x’ or ‘y’.
  • padding (float) – Padding around the data.
Returns:

The minimum and maximum data values for the requested axis.

Return type:

2-tuple of PhysicalQuantity

faceColor()
Returns:The edge color of the fill in hex format.
Return type:str
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. :rtype: 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
lower()
Returns:The lower values in the fill.
Return type:float
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.

Parameters:alpha (float) – The opacity of the fill.
setColor(color)

Set the same color for both the face and the edge.

Parameters:color (str) – Set the color of the fill in hex format.
setEdgeColor(color)

Set the edge color of the fill.

Parameters:color (str) – The edge color of the fill in hex-format.
setFaceColor(color)

Set the face color of the fill.

Parameters:color (str) – The face color of the fill.in hex format.
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.
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.
tags()
Returns:The set of tags.
Return type:set
upper()
Returns:The upper values in the fill.
Return type:float
values()
Returns:The values in the fill.
Return type:float