class QAbstractBarSeries#

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

Inheritance diagram of PySide6.QtCharts.QAbstractBarSeries

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

Synopsis#

Properties#

Methods#

Signals#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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 Charts with Widgets Gallery to learn how to use the QBarSeries class to create a simple bar chart.

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

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property barWidthᅟ: 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

Access functions:
property countᅟ: int#

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

Access functions:
property labelsAngleᅟ: float#

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

Access functions:
property labelsFormatᅟ: 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

Access functions:
property labelsPositionᅟ: QAbstractBarSeries.LabelsPosition#

This property holds The position of value labels..

See also

labelsVisible labelsFormat

Access functions:
property labelsPrecisionᅟ: int#

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

Default value is 6.

Access functions:
property labelsVisibleᅟ: bool#

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

Access functions:
append(sets)#
Parameters:

sets – .list of QBarSet

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.

append(set)
Parameters:

setQBarSet

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.

barSets()#
Return type:

.list of QBarSet

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

barWidth()#
Return type:

float

Returns the width of the bars of the series.

See also

setBarWidth()

Getter of property barWidthᅟ .

barsetsAdded(sets)#
Parameters:

sets – .list of QBarSet

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

See also

append() insert()

barsetsRemoved(sets)#
Parameters:

sets – .list of QBarSet

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

See also

remove()

clear()#

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

clicked(index, barset)#
Parameters:

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

count()#
Return type:

int

Returns the number of bar sets in a bar series.

Getter of property countᅟ .

countChanged()#

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

Notification signal of property countᅟ .

doubleClicked(index, barset)#
Parameters:

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

hovered(status, index, barset)#
Parameters:
  • status – bool

  • index – int

  • barsetQBarSet

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.

insert(index, set)#
Parameters:
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.

isLabelsVisible()#
Return type:

bool

Returns the visibility of labels.

Getter of property labelsVisibleᅟ .

labelsAngle()#
Return type:

float

See also

setLabelsAngle()

Getter of property labelsAngleᅟ .

labelsAngleChanged(angle)#
Parameters:

angle – float

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

Notification signal of property labelsAngleᅟ .

labelsFormat()#
Return type:

str

Getter of property labelsFormatᅟ .

labelsFormatChanged(format)#
Parameters:

format – str

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

Notification signal of property labelsFormatᅟ .

labelsPosition()#
Return type:

LabelsPosition

Getter of property labelsPositionᅟ .

labelsPositionChanged(position)#
Parameters:

positionLabelsPosition

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

Notification signal of property labelsPositionᅟ .

labelsPrecision()#
Return type:

int

Getter of property labelsPrecisionᅟ .

labelsPrecisionChanged(precision)#
Parameters:

precision – int

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

Notification signal of property labelsPrecisionᅟ .

labelsVisibleChanged()#

This signal is emitted when the labels’ visibility changes.

Notification signal of property labelsVisibleᅟ .

pressed(index, barset)#
Parameters:

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.

released(index, barset)#
Parameters:

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

remove(set)#
Parameters:

setQBarSet

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.

setBarWidth(width)#
Parameters:

width – float

Sets the width of the bars of the series to width.

See also

barWidth()

Setter of property barWidthᅟ .

setLabelsAngle(angle)#
Parameters:

angle – float

See also

labelsAngle()

Setter of property labelsAngleᅟ .

setLabelsFormat(format)#
Parameters:

format – str

See also

labelsFormat()

Setter of property labelsFormatᅟ .

setLabelsPosition(position)#
Parameters:

positionLabelsPosition

See also

labelsPosition()

Setter of property labelsPositionᅟ .

setLabelsPrecision(precision)#
Parameters:

precision – int

Setter of property labelsPrecisionᅟ .

setLabelsVisible([visible=true])#
Parameters:

visible – bool

Sets the visibility of labels in a bar series to visible.

Setter of property labelsVisibleᅟ .

take(set)#
Parameters:

setQBarSet

Return type:

bool

Takes a single set from the series. Does not delete the bar set object.

Note

The series remains the barset’s parent object. You must set the parent object to take full ownership.

Returns true if the take operation succeeds.