QAbstractBarSeries#

The QAbstractBarSeries class is an abstract parent class for all bar series classes. More…

Inherited by: QStackedBarSeries, QPercentBarSeries, QHorizontalStackedBarSeries, QHorizontalPercentBarSeries, QHorizontalBarSeries, QBarSeries

Synopsis#

Functions#

def append (set)
def append (sets)
def barSets ()
def barWidth ()
def clear ()
def count ()
def insert (index, set)
def isLabelsVisible ()
def labelsAngle ()
def labelsFormat ()
def labelsPosition ()
def labelsPrecision ()
def remove (set)
def setBarWidth (width)
def setLabelsAngle (angle)
def setLabelsFormat (format)
def setLabelsPosition (position)
def setLabelsPrecision (precision)
def setLabelsVisible ([visible=true])
def take (set)

Signals#

def barsetsAdded (sets)
def barsetsRemoved (sets)
def clicked (index, barset)
def countChanged ()
def doubleClicked (index, barset)
def hovered (status, index, barset)
def labelsAngleChanged (angle)
def labelsFormatChanged (format)
def labelsPositionChanged (position)
def labelsPrecisionChanged (precision)
def labelsVisibleChanged ()
def pressed (index, barset)
def released (index, barset)

Detailed Description#

In bar charts, bars are defined as bar sets that contain one data value for each category. The position of a bar is specified by the category and its height by the data value. Bar series that contain multiple bar sets group together bars that belong to the same category. The way the bars are displayed is determined by the subclass of this class chosen to create the bar chart.

If a QValueAxis is used instead of QBarCategoryAxis for the main bar axis, the bars are grouped around the index value of the category.

See the bar chart example to learn how to use the QBarSeries class to create a simple bar chart.

See also

QBarSet QBarSeries QStackedBarSeries QPercentBarSeries QHorizontalBarSeries QHorizontalStackedBarSeries QHorizontalPercentBarSeries

class PySide6.QtCharts.QAbstractBarSeries#

PySide6.QtCharts.QAbstractBarSeries.LabelsPosition#

This enum value describes the position of the data value labels:

Constant

Description

QAbstractBarSeries.LabelsCenter

Label is located in the center of the bar.

QAbstractBarSeries.LabelsInsideEnd

Label is located inside the bar at the top.

QAbstractBarSeries.LabelsInsideBase

Label is located inside the bar at the bottom.

QAbstractBarSeries.LabelsOutsideEnd

Label is located outside the bar at the top.

Constant	Description
QAbstractBarSeries.LabelsCenter	Label is located in the center of the bar.
QAbstractBarSeries.LabelsInsideEnd	Label is located inside the bar at the top.
QAbstractBarSeries.LabelsInsideBase	Label is located inside the bar at the bottom.
QAbstractBarSeries.LabelsOutsideEnd	Label is located outside the bar at the top.

PySide6.QtCharts.QAbstractBarSeries.append(sets)#

Parameters: sets –
Return type: bool

Adds a list of bar sets specified by sets to a bar series and takes ownership of the sets. Returns true if all sets were appended successfully. If any of the sets is null or was previously appended to the series, nothing is appended and this function returns false. If any of the sets appears in the list more than once, nothing is appended and this function returns false.

PySide6.QtCharts.QAbstractBarSeries.append(set)

Parameters: set – PySide6.QtCharts.QBarSet
Return type: bool

Adds a set of bars specified by set to the bar series and takes ownership of it. If the set is null or it already belongs to the series, it will not be appended. Returns true if appending succeeded.

PySide6.QtCharts.QAbstractBarSeries.barSets()#

Return type

Returns a list of bar sets in a bar series. Keeps the ownership of the bar sets.

PySide6.QtCharts.QAbstractBarSeries.barWidth()#

Return type: float

This property holds The width of the bars of the series..

The unit of width is the unit of the x-axis. The minimum width for bars is zero, and negative values are treated as zero. Setting the width to zero means that the width of the bar on the screen is one pixel regardless of the scale of the x-axis. Bars wider than zero are scaled using the x-axis scale.

Note

When used with QBarSeries , this value specifies the width of a group of bars instead of that of a single bar.

See also

QBarSeries

PySide6.QtCharts.QAbstractBarSeries.barsetsAdded(sets)#

Parameters: sets –

This signal is emitted when the bar sets specified by sets are added to the series.

See also

append() insert()

PySide6.QtCharts.QAbstractBarSeries.barsetsRemoved(sets)#

Parameters: sets –

This signal is emitted when the bar sets specified by sets are removed from the series.

See also

remove()

PySide6.QtCharts.QAbstractBarSeries.clear()#

Removes all bar sets from the series and permanently deletes them.

PySide6.QtCharts.QAbstractBarSeries.clicked(index, barset)#

Parameters

index – int
barset – PySide6.QtCharts.QBarSet

This signal is emitted when the user clicks the bar specified by index in the bar set specified by barset.

PySide6.QtCharts.QAbstractBarSeries.count()#

Return type: int

This property holds The number of bar sets in a bar series..

PySide6.QtCharts.QAbstractBarSeries.countChanged()#

This signal is emitted when the number of bar sets is changed, for example by append() or remove() .

PySide6.QtCharts.QAbstractBarSeries.doubleClicked(index, barset)#

Parameters

index – int
barset – PySide6.QtCharts.QBarSet

This signal is emitted when the user double-clicks the bar specified by index in the bar set specified by barset.

PySide6.QtCharts.QAbstractBarSeries.hovered(status, index, barset)#

Parameters

status – bool
index – int
barset – PySide6.QtCharts.QBarSet

This signal is emitted when a mouse is hovered over the bar specified by index in the bar set specified by barset. When the mouse moves over the bar, status turns true, and when the mouse moves away again, it turns false.

PySide6.QtCharts.QAbstractBarSeries.insert(index, set)#

Parameters

index – int
set – PySide6.QtCharts.QBarSet

Return type

bool

Inserts a bar set specified by set to a series at the position specified by index and takes ownership of the set. If the set is null or already belongs to the series, it will not be appended. Returns true if inserting succeeds.

PySide6.QtCharts.QAbstractBarSeries.isLabelsVisible()#

Return type: bool

This property holds The visibility of the labels in a bar series..

PySide6.QtCharts.QAbstractBarSeries.labelsAngle()#

Return type: float

This property holds The angle of the value labels in degrees..

PySide6.QtCharts.QAbstractBarSeries.labelsAngleChanged(angle)#

Parameters: angle – float

This signal is emitted when the angle of the value labels changes.

PySide6.QtCharts.QAbstractBarSeries.labelsFormat()#

Return type: str

This property holds The format used for showing labels in a bar series..

QAbstractBarSeries supports the following format tag:

@value

The value of the bar

For example, the following usage of the format tags would produce labels that show the value followed by the unit (u):

series->setLabelsFormat("@value u");

By default, the labels show the value of the bar. For the percent bar series, % is added after the value. The labels are shown on the plot area, if the bars are close to each other, the labels may overlap.

See also

labelsVisible labelsPosition labelsPrecision

PySide6.QtCharts.QAbstractBarSeries.labelsFormatChanged(format)#

Parameters: format – str

This signal is emitted when the format of data value labels changes.

PySide6.QtCharts.QAbstractBarSeries.labelsPosition()#

Return type: LabelsPosition

This property holds The position of value labels..

See also

labelsVisible labelsFormat

PySide6.QtCharts.QAbstractBarSeries.labelsPositionChanged(position)#

Parameters: position – LabelsPosition

This signal is emitted when the position of value labels changes.

PySide6.QtCharts.QAbstractBarSeries.labelsPrecision()#

Return type: int

This property holds The maximum amount of significant digits shown in value labels..

Default value is 6.

PySide6.QtCharts.QAbstractBarSeries.labelsPrecisionChanged(precision)#

Parameters: precision – int

This signal is emitted when the precision of the value labels changes.

PySide6.QtCharts.QAbstractBarSeries.labelsVisibleChanged()#

This signal is emitted when the labels’ visibility changes.

See also

isLabelsVisible() setLabelsVisible()

PySide6.QtCharts.QAbstractBarSeries.pressed(index, barset)#

Parameters

index – int
barset – PySide6.QtCharts.QBarSet

This signal is emitted when the user clicks the bar specified by index in the bar set specified by barset and holds down the mouse button.

PySide6.QtCharts.QAbstractBarSeries.released(index, barset)#

Parameters

index – int
barset – PySide6.QtCharts.QBarSet

This signal is emitted when the user releases the mouse press on the bar specified by index in the bar set specified by barset.

PySide6.QtCharts.QAbstractBarSeries.remove(set)#

Parameters: set – PySide6.QtCharts.QBarSet
Return type: bool

Removes the bar set specified by set from the series and permanently deletes it if the removal succeeds. Returns true if the set was removed.

PySide6.QtCharts.QAbstractBarSeries.setBarWidth(width)#

Parameters: width – float

This property holds The width of the bars of the series..

Note

When used with QBarSeries , this value specifies the width of a group of bars instead of that of a single bar.