QBoxSet#

The QBoxSet class represents one item in a box-and-whiskers chart. More…

Inheritance diagram of PySide6.QtCharts.QBoxSet

Synopsis#

Functions#

Signals#

Detailed Description#

A box-and-whiskers item is a graphical representation of a range and three median values that is constructed from five different values. There are two ways to specify the values. The first one is by using a constructor or stream operator (<<). The values have to be specified in the following order: lower extreme, lower quartile, median, upper quartile, and upper extreme.

The second way is to create an empty QBoxSet instance and specify the values using the setValue() method.

See the box-and-whiskers chart example to learn how to create a box-and-whiskers chart.

See also

QBoxPlotSeries

class PySide6.QtCharts.QBoxSet([label=""[, parent=None]])#

PySide6.QtCharts.QBoxSet(le, lq, m, uq, ue[, label=””[, parent=None]])

Parameters

  • lq – float

  • label – str

  • m – float

  • uq – float

  • le – float

  • ue – float

  • parent – PySide6.QtCore.QObject

Constructs a box-and-whiskers item with the optional label label and parent parent.

Constructs a box-and-whiskers item with the following ordered values: le specifies the lower extreme, lq the lower quartile, m the median, uq the upper quartile, and ue the upper quartile. Optionally, the label and parent can be specified.

PySide6.QtCharts.QBoxSet.ValuePositions#

(inherits enum.IntEnum) This enum type defines the values of a box-and-whiskers item:

Constant

Description

QBoxSet.LowerExtreme

The smallest value of the box-and-whiskers item.

QBoxSet.LowerQuartile

The median value of the lower half of the box-and-whiskers item.

QBoxSet.Median

The median value of the box-and-whiskers item.

QBoxSet.UpperQuartile

The median value of the upper half of the box-and-whiskers item.

QBoxSet.UpperExtreme

The largest value of the box-and-whiskers item.
PySide6.QtCharts.QBoxSet.append(value)#
Parameters

value – float

Appends the new value specified by value to the end of the box-and-whiskers item.

PySide6.QtCharts.QBoxSet.append(values)
Parameters

values –

Appends a list of real values specified by values to the end of the box-and-whiskers item.

See also

append()

PySide6.QtCharts.QBoxSet.at(index)#
Parameters

index – int

Return type

float

Returns the value of the box-and-whiskers item specified by index. The index can be specified by using ValuePositions enumeration values. If the index is out of bounds, 0.0 is returned.

PySide6.QtCharts.QBoxSet.brush()#
Return type

PySide6.QtGui.QBrush

This property holds The brush used fill the box of the box-and-whiskers item..

PySide6.QtCharts.QBoxSet.brushChanged()#

This signal is emitted when the brush of the box-and-whiskers item changes.

See also

brush

PySide6.QtCharts.QBoxSet.clear()#

Sets all the values of the box-and-whiskers item to 0.

PySide6.QtCharts.QBoxSet.cleared()#

This signal is emitted when all the values of the box-and-whiskers item are set to 0.

PySide6.QtCharts.QBoxSet.clicked()#

This signal is emitted when the user clicks a box-and-whiskers item in the chart.

PySide6.QtCharts.QBoxSet.count()#
Return type

int

Returns the number of values appended to the box-and-whiskers item.

PySide6.QtCharts.QBoxSet.doubleClicked()#

This signal is emitted when the user double-clicks a box-and-whiskers item.

PySide6.QtCharts.QBoxSet.hovered(status)#
Parameters

status – bool

This signal is emitted when a mouse is hovered over a box-and-whiskers item in a chart. When the mouse moves over the item, status turns true, and when the mouse moves away again, it turns false.

PySide6.QtCharts.QBoxSet.label()#
Return type

str

Returns the label of the category of the box-and-whiskers item.

See also

setLabel()

PySide6.QtCharts.QBoxSet.__lshift__(value)#
Parameters

value – float

Return type

PySide6.QtCharts.QBoxSet

A convenience operator for appending the real value specified by value to the end of the box-and-whiskers item.

See also

append()

PySide6.QtCharts.QBoxSet.operator[](index)
Parameters

index – int

Return type

float

Returns the value of the box-and-whiskers item specified by index. The index can be specified by using ValuePositions enumeration values. If the index is out of bounds, 0.0 is returned.

PySide6.QtCharts.QBoxSet.pen()#
Return type

PySide6.QtGui.QPen

This property holds The pen used to draw the lines of the box-and-whiskers item..

PySide6.QtCharts.QBoxSet.penChanged()#

This signal is emitted when the pen of the box-and-whiskers item changes.

See also

pen

PySide6.QtCharts.QBoxSet.pressed()#

This signal is emitted when the user clicks a box-and-whiskers item in the chart and holds down the mouse button.

PySide6.QtCharts.QBoxSet.released()#

This signal is emitted when the user releases the mouse press on a box-and-whiskers item.

PySide6.QtCharts.QBoxSet.setBrush(brush)#
Parameters

brush – PySide6.QtGui.QBrush

This property holds The brush used fill the box of the box-and-whiskers item..

PySide6.QtCharts.QBoxSet.setLabel(label)#
Parameters

label – str

Sets the label specified by label for the category of the box-and-whiskers item.

See also

label()

PySide6.QtCharts.QBoxSet.setPen(pen)#
Parameters

pen – PySide6.QtGui.QPen

This property holds The pen used to draw the lines of the box-and-whiskers item..

PySide6.QtCharts.QBoxSet.setValue(index, value)#
Parameters

  • index – int

  • value – float

Sets the value specified by value in the position specified by index. The index can be specified by using the ValuePositions enumeration values.

PySide6.QtCharts.QBoxSet.valueChanged(index)#
Parameters

index – int

This signal is emitted when the value of the box-and-whiskers item specified by index is modified.

See also

at()

PySide6.QtCharts.QBoxSet.valuesChanged()#

This signal is emitted when multiple values of the box-and-whiskers item change.

See also

append()