PySide6.QtGraphs.QBarSet¶

class QBarSet¶

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

Synopsis¶

Properties¶

borderColorᅟ - Border color of the bar set
borderWidthᅟ - Width of the border line. By default, the width is -1, meaning the border width is defined by the theme
colorᅟ - Fill color of the bar set
countᅟ - Number of values in the bar set
labelᅟ - Of the bar set
labelColorᅟ - Text (label) color of the bar set
selectedBarsᅟ - Indexes of the bars which are currently selected
selectedColorᅟ - Fill color of the selected set
valuesᅟ - Of the bar set

Methods¶

def __init__()
def append()
def at()
def borderColor()
def borderWidth()
def clear()
def color()
def count()
def deselectAllBars()
def deselectBar()
def deselectBars()
def insert()
def isBarSelected()
def label()
def labelColor()
def __lshift__()
def operator[]()
def remove()
def replace()
def selectAllBars()
def selectBar()
def selectBars()
def selectedBars()
def selectedColor()
def setBarSelected()
def setBorderColor()
def setBorderWidth()
def setColor()
def setLabel()
def setLabelColor()
def setSelectedColor()
def setValues()
def sum()
def toggleSelection()
def values()

Signals¶

def borderColorChanged()
def borderWidthChanged()
def colorChanged()
def countChanged()
def labelChanged()
def labelColorChanged()
def selectedBarsChanged()
def selectedColorChanged()
def update()
def updatedBars()
def valueAdded()
def valueChanged()
def valueRemoved()
def valuesAdded()
def valuesChanged()
def valuesRemoved()

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.

See also

QBarSeries

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 border color of the bar set..

Access functions:

borderColor()
setBorderColor()
Signal borderColorChanged()

property borderWidthᅟ: float¶

This property holds The width of the border line. By default, the width is -1, meaning the border width is defined by the theme..

Access functions:

borderWidth()
setBorderWidth()
Signal borderWidthChanged()

property colorᅟ: QColor¶

This property holds The fill color of the bar set..

Access functions:

color()
setColor()
Signal colorChanged()

property countᅟ: int¶

This property holds The number of values in the bar set..

Access functions:

count()
Signal countChanged()

property labelᅟ: str¶

This property holds The label of the bar set..

Access functions:

label()
setLabel()
Signal labelChanged()

property labelColorᅟ: QColor¶

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

Access functions:

labelColor()
setLabelColor()
Signal labelColorChanged()

property selectedBarsᅟ: list of qsizetype¶

This property holds The indexes of the bars which are currently selected..

Access functions:

selectedBars()
Signal selectedBarsChanged()

property selectedColorᅟ: QColor¶

This property holds The fill color of the selected set..

Access functions:

selectedColor()
setSelectedColor()
Signal selectedColorChanged()

property valuesᅟ: list of QVariant¶

This property holds The values of the bar set..

You can set a list of either real or point types as values.

If you set a list of real types as values, they directly define the bar set values.

If you set a list of point types as values, the x-coordinate of the point specifies its zero-based index in the bar set. The size of the bar set is the highest x-coordinate value + 1. If a point is missing for any x-coordinate between zero and the highest value, it gets the value zero.

Access functions:

values()
setValues()
Signal valuesChanged()

__init__([parent=None])¶

Parameters:: parent – QObject

__init__(label[, parent=None])

Parameters:

label – str
parent – QObject

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:: color – QColor

Notification signal of property borderColorᅟ .

borderWidth()¶

Return type:: float

See also

setBorderWidth()

Getter of property borderWidthᅟ .

borderWidthChanged(width)¶

Parameters:: width – float

Notification signal of property borderWidthᅟ .

clear()¶

Removes all values from the set.

color()¶

Return type:: QColor

Returns the fill color for the bar set.

See also

setColor()

Getter of property colorᅟ .

colorChanged(color)¶

Parameters:: color – QColor

Notification signal of property colorᅟ .

count()¶

Return type:: int

Returns the number of values in a bar set.

Getter of property countᅟ .

countChanged()¶

Notification signal of property countᅟ .

deselectAllBars()¶

Deselects all bars in the set.

Note

Emits selectedBarsChanged .

See also

setBarSelected()

deselectBar(index)¶

Parameters:: index – int

Deselects the bar at index.

Note

Emits selectedBarsChanged .

See also

setBarSelected()

deselectBars(indexes)¶

Parameters:: indexes – .list of qsizetype

Marks multiple bars passed in an indexes list as deselected.

Note

Emits selectedBarsChanged .

See also

setBarSelected()

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

labelChanged()¶

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:: color – QColor

Notification signal of property labelColorᅟ .

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

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 set as selected.

Note

Emits selectedBarsChanged .

See also

setBarSelected()

selectBar(index)¶

Parameters:: index – int

Marks the bar at index as selected.

Note

Emits selectedBarsChanged .

See also

setBarSelected()

selectBars(indexes)¶

Parameters:: indexes – .list of qsizetype

Marks multiple bars passed in an indexes list as selected.

Note

Emits selectedBarsChanged .

See also

setBarSelected()

selectedBars()¶

Return type:: .list of qsizetype

Returns a list of bars marked as selected.

See also

setBarSelected()

Getter of property selectedBarsᅟ .

selectedBarsChanged(indexes)¶

Parameters:: indexes – .list of qsizetype

This signal is emitted when the selected bar changes. indexes is a list selected bar indexes.

Notification signal of property selectedBarsᅟ .

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.

See also

setSelectedColor() color

Getter of property selectedColorᅟ .

selectedColorChanged(color)¶

Parameters:: color – QColor

Notification signal of property selectedColorᅟ .

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

See also

isBarSelected() setSelectedColor()

setBorderColor(color)¶

Parameters:: color – QColor

Sets the line color for the bar set to color.

See also

borderColor()

Setter of property borderColorᅟ .

setBorderWidth(borderWidth)¶

Parameters:: borderWidth – float

See also

borderWidth()

Setter of property borderWidthᅟ .

setColor(color)¶

Parameters:: color – QColor

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

setLabelColor(color)¶

Parameters:: color – QColor

Sets the text color for the bar set to color.

See also

labelColor()

Setter of property labelColorᅟ .

setSelectedColor(color)¶

Parameters:: color – QColor

Sets the color of the selected bars.

See also

selectedColor

Setter of property selectedColorᅟ .

setValues(values)¶

Parameters:: values – .list of QVariant

See also

values()

Setter of property valuesᅟ .

sum()¶

Return type:: float

Returns the sum of all values in the bar set.

toggleSelection(indexes)¶

Parameters:: indexes – .list of qsizetype

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

Note

Emits selectedBarsChanged .

See also

setBarSelected()

update()¶

This signal is emitted when the barset is updated.

updatedBars()¶

This signal is emitted when the bars in this set are updated.

valueAdded(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.

valueChanged(index)¶

Parameters:: index – int

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

See also

at()

valueRemoved(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.

values()¶

Return type:: .list of QVariant

See also

setValues()

Getter of property valuesᅟ .

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()

valuesChanged()¶

Notification signal of property valuesᅟ .

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()