class QBarSet#

The QBarSet class represents one set of bars in a bar chart. More

Inheritance diagram of PySide6.QtCharts.QBarSet

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#

A bar set contains one data value for each category. The first value of a set is assumed to belong to the first category, the second one to the second category, and so on. If the set has fewer values than there are categories, the missing values are assumed to be located at the end of the set. For missing values in the middle of a set, the numerical value of zero is used. Labels for zero value sets are not shown.

Note

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

property borderColorᅟ: QColor#

This property holds The line (pen) color of the bar set..

Access functions:
property brushᅟ: QBrush#

This property holds The brush used to fill the bars in the bar set..

Access functions:
property colorᅟ: QColor#

This property holds The fill (brush) color of the bar set..

Access functions:
property labelᅟ: str#

This property holds The label of the bar set..

Access functions:
property labelBrushᅟ: QBrush#

This property holds The brush used to draw the bar set’s label..

Access functions:
property labelColorᅟ: QColor#

This property holds The text (label) color of the bar set..

Access functions:
property labelFontᅟ: QFont#

This property holds The font used to draw the bar set’s label..

Access functions:
property penᅟ: QPen#

This property holds The pen used to draw the lines of bars in the bar set..

Access functions:
__init__(label[, parent=None])#
Parameters:

Constructs a bar set with the label label and the parent parent.

append(values)#
Parameters:

values – .list of qreal

Appends the list of real values specified by values to the end of the bar set.

See also

append()

append(value)
Parameters:

value – float

Appends the new value specified by value to the end of the bar set.

at(index)#
Parameters:

index – int

Return type:

float

Returns the value specified by index from the bar set. If the index is out of bounds, 0.0 is returned.

borderColor()#
Return type:

QColor

Returns the line color for the bar set.

See also

setBorderColor()

Getter of property borderColorᅟ .

borderColorChanged(color)#
Parameters:

colorQColor

This signal is emitted when the line (pen) color of the bar set changes to color.

Notification signal of property borderColorᅟ .

brush()#
Return type:

QBrush

Returns the brush used to fill the bars in the bar set.

See also

setBrush()

Getter of property brushᅟ .

brushChanged()#

This signal is emitted when the brush used to draw the bar set changes.

See also

brush

Notification signal of property brushᅟ .

clicked(index)#
Parameters:

index – int

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

color()#
Return type:

QColor

Returns the fill color for the bar set.

See also

setColor()

Getter of property colorᅟ .

colorChanged(color)#
Parameters:

colorQColor

This signal is emitted when the fill (brush) color of the bar set changes to color.

Notification signal of property colorᅟ .

count()#
Return type:

int

Returns the number of values in a bar set.

deselectAllBars()#

Deselects all bars in the series.

Note

Emits QBarSet::selectedBarsChanged.

See also

setBarSelected()

deselectBar(index)#
Parameters:

index – int

Deselects the bar at index.

Note

Emits QBarSet::selectedBarsChanged.

See also

setBarSelected()

deselectBars(indexes)#
Parameters:

indexes – .list of int

Marks multiple bars passed in an indexes list as deselected.

Note

Emits QBarSet::selectedBarsChanged.

See also

setBarSelected()

doubleClicked(index)#
Parameters:

index – int

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

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

  • index – int

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

insert(index, value)#
Parameters:
  • index – int

  • value – float

Inserts value in the position specified by index. The values following the inserted value are moved up one position.

See also

remove()

isBarSelected(index)#
Parameters:

index – int

Return type:

bool

Returns true if the bar at the given index is among selected bars and false otherwise.

Note

Selected bars are drawn using the selected color if it was specified using setSelectedColor .

label()#
Return type:

str

Returns the label of the bar set.

See also

setLabel()

Getter of property labelᅟ .

labelBrush()#
Return type:

QBrush

Returns the brush used to draw values on top of this bar set.

See also

setLabelBrush()

Getter of property labelBrushᅟ .

labelBrushChanged()#

This signal is emitted when the brush used to draw the bar set’s label changes.

See also

labelBrush

Notification signal of property labelBrushᅟ .

labelChanged()#

This signal is emitted when the label of the bar set changes.

See also

label

Notification signal of property labelᅟ .

labelColor()#
Return type:

QColor

Returns the text color for the bar set.

See also

setLabelColor()

Getter of property labelColorᅟ .

labelColorChanged(color)#
Parameters:

colorQColor

This signal is emitted when the text (label) color of the bar set changes to color.

Notification signal of property labelColorᅟ .

labelFont()#
Return type:

QFont

Returns the pen used to draw values on top of this bar set.

See also

setLabelFont()

Getter of property labelFontᅟ .

labelFontChanged()#

This signal is emitted when the font of the bar set’s label changes.

See also

labelBrush

Notification signal of property labelFontᅟ .

__lshift__(value)#
Parameters:

value – float

Return type:

QBarSet

A convenience operator for appending the real value specified by value to the end of the bar set.

See also

append()

operator(index)#
Parameters:

index – int

Return type:

float

Returns the value of the bar set specified by index. If the index is out of bounds, 0.0 is returned.

pen()#
Return type:

QPen

Returns the pen used to draw the lines in the bar set.

See also

setPen()

Getter of property penᅟ .

penChanged()#

This signal is emitted when the pen used to draw the bar set changes.

See also

pen

Notification signal of property penᅟ .

pressed(index)#
Parameters:

index – int

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

released(index)#
Parameters:

index – int

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

remove(index[, count=1])#
Parameters:
  • index – int

  • count – int

Removes the number of values specified by count from the bar set starting with the value specified by index.

See also

insert()

replace(index, value)#
Parameters:
  • index – int

  • value – float

Adds the value specified by value to the bar set at the position specified by index.

selectAllBars()#

Marks all bars in the series as selected.

Note

Emits QBarSet::selectedBarsChanged.

See also

setBarSelected()

selectBar(index)#
Parameters:

index – int

Marks the bar at index as selected.

Note

Emits QBarSet::selectedBarsChanged.

See also

setBarSelected()

selectBars(indexes)#
Parameters:

indexes – .list of int

Marks multiple bars passed in an indexes list as selected.

Note

Emits QBarSet::selectedBarsChanged.

See also

setBarSelected()

selectedBars()#
Return type:

.list of int

Returns a list of bars marked as selected.

See also

setBarSelected()

selectedBarsChanged(indexes)#
Parameters:

indexes – .list of int

selectedColor()#
Return type:

QColor

Returns the color of the selected bars.

This is the fill (brush) color of bars marked as selected. If not specified, value of color is used as default.

selectedColorChanged(color)#
Parameters:

colorQColor

setBarSelected(index, selected)#
Parameters:
  • index – int

  • selected – bool

Marks the bar at index as either selected or deselected as specified by selected.

Note

Selected bars are drawn using the selected color if it was specified. Emits QBarSet::selectedBarsChanged.

setBorderColor(color)#
Parameters:

colorQColor

Sets the line color for the bar set to color.

See also

borderColor()

Setter of property borderColorᅟ .

setBrush(brush)#
Parameters:

brushQBrush

Sets the brush used to fill the bars in the bar set to brush.

See also

brush()

Setter of property brushᅟ .

setColor(color)#
Parameters:

colorQColor

Sets the fill color for the bar set to color.

See also

color()

Setter of property colorᅟ .

setLabel(label)#
Parameters:

label – str

Sets label as the new label for the bar set.

See also

label()

Setter of property labelᅟ .

setLabelBrush(brush)#
Parameters:

brushQBrush

Sets the brush used to draw values on top of this bar set to brush.

See also

labelBrush()

Setter of property labelBrushᅟ .

setLabelColor(color)#
Parameters:

colorQColor

Sets the text color for the bar set to color.

See also

labelColor()

Setter of property labelColorᅟ .

setLabelFont(font)#
Parameters:

fontQFont

Sets the font used to draw values on top of this bar set to font.

See also

labelFont()

Setter of property labelFontᅟ .

setPen(pen)#
Parameters:

penQPen

Sets the pen used to draw the lines in the bar set to pen.

See also

pen()

Setter of property penᅟ .

setSelectedColor(color)#
Parameters:

colorQColor

Sets the color of the selected bars.

See also

selectedColor

sum()#
Return type:

float

Returns the sum of all values in the bar set.

toggleSelection(indexes)#
Parameters:

indexes – .list of int

Changes the selection state of bars at the given indexes to the opposite one.

Note

Emits QBarSet::selectedBarsChanged.

See also

setBarSelected()

valueChanged(index)#
Parameters:

index – int

This signal is emitted when the value at the position specified by index is modified.

See also

at()

valuesAdded(index, count)#
Parameters:
  • index – int

  • count – int

This signal is emitted when new values are added to the bar set. index indicates the position of the first inserted value, and count is the number of inserted values.

See also

append() insert()

valuesRemoved(index, count)#
Parameters:
  • index – int

  • count – int

This signal is emitted when values are removed from the bar set. index indicates the position of the first removed value, and count is the number of removed values.

See also

remove()