Plot.VerticalBar¶
- class VerticalBar(bins, data)¶
A bar plot showing data as vertical filled bins.
The shape of the bins is determined in the following way: - If the number of bins equals the number of data values, the bins parameter is interpreted as the bin centers and bin widths are uniformly set to the match minimum distance between the bin centers. - If the number of bins is one larger than the number of data values, the bins parameter is interpreted as the edges of the bins. - If the number of bins is double the number of data values, the bins are instead interpreted as the left and right edge of each of the bins.
- Parameters:
bins (Sequence of PhysicalQuantity) – The bins.
data (Sequence of PhysicalQuantity) – The data values.
- 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 bar plot.
- Return type:
int
- 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.
- binCenters()¶
- Returns:
The center of each bin.
- Return type:
Sequence of PhysicalQuantity
- binEdges()¶
. :returns: The left edges of each bin. :rtype: PhysicalQuantity
- 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 bar plot.
- 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 limits around the bar plot.
- Parameters:
axis_name (str) – ‘x’ or ‘y’.
padding (float) – Optional padding.
- Returns:
The min/max data values for the requested axis.
- Return type:
2-tuple of PhysicalQuantity
- faceColor()¶
- Returns:
The face color of the bar plot.
- 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
- histogram()¶
- Returns:
The bin counts for each bin.
- Return type:
Sequence of PhysicalQuantity
- 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 label.
- Return type:
str
- 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)¶
. :param alpha: The opacity of the bar plot. :type alpha: float
- setColor(color)¶
Set the same color for both the bar face and the bar edge.
- Parameters:
color (str) – The color to set in hex format.
- setData(bins, data, emit=True)¶
Set bins and histogram data.
The shape of the bins is determined in the following way: - If the number of bins equals the number of data values, the bins parameter is interpreted as the bin centers and bin widths are uniformly set to the match minimum distance between the bin centers. - If the number of bins is one larger than the number of data values, the bins parameter is interpreted as the edges of the bins. - If the number of bins is double the number of data values, the bins are instead interpreted as the left and right edge of each of the bins.
- Parameters:
bins (Sequence of PhysicalQuantity) – The bins.
data (Sequence of PhysicalQuantity) – The data values.
emit (bool) – True, if the data should be emitted.
- setEdgeColor(color)¶
Set the bar plot edge color.
- Parameters:
color (str) – The edge color of the bar plot.
- setFaceColor(color)¶
. :param color: The face color of the bar plot. :type color: str
- 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 bar plot.
- 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.
- 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
- xData()¶
- Returns:
The center of each bin.
- Return type:
Sequence of PhysicalQuantity
- yData()¶
- Returns:
The bin counts for each bin.
- Return type:
Sequence of PhysicalQuantity