QBoxPlotSeries

The QBoxPlotSeries class presents data in box-and-whiskers charts. More…

Synopsis

Functions

• def append (box)

• def append (boxes)

• def boxOutlineVisible ()

• def boxSets ()

• def boxWidth ()

• def brush ()

• def clear ()

• def count ()

• def insert (index, box)

• def pen ()

• def remove (box)

• def setBoxOutlineVisible (visible)

• def setBoxWidth (width)

• def setBrush (brush)

• def setPen (pen)

• def take (box)

Signals

• def boxOutlineVisibilityChanged ()

• def boxWidthChanged ()

• def boxsetsAdded (sets)

• def boxsetsRemoved (sets)

• def brushChanged ()

• def clicked (boxset)

• def countChanged ()

• def doubleClicked (boxset)

• def hovered (status, boxset)

• def penChanged ()

• def pressed (boxset)

• def released (boxset)

Detailed Description

A box plot series acts as a container for box-and-whiskers items. Items from multiple series are grouped into categories according to their index value.

The QBarCategoryAxis class is used to add the categories to the chart’s axis. Category labels have to be unique. If the same category label is defined for several box-and-whiskers items, only the first one is drawn.

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

See also

QBoxSet QBarCategoryAxis

class PySide6.QtCharts.QBoxPlotSeries([parent=None])

Parameters

parent – PySide6.QtCore.QObject

Constructs an empty box plot series that is a QObject and a child of parent.

PySide6.QtCharts.QBoxPlotSeries.append(box)

Parameters

box – PySide6.QtCharts.QBoxSet

Return type

bool

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

PySide6.QtCharts.QBoxPlotSeries.append(boxes)

Parameters

boxes –

Return type

bool

Adds a list of box-and-whiskers items specified by sets to the series and takes ownership of them. If the list is null or the items already belong to the series, it will not be appended. Returns true if appending succeeded.

PySide6.QtCharts.QBoxPlotSeries.boxOutlineVisibilityChanged()

This signal is emitted when the box outline visibility changes.

PySide6.QtCharts.QBoxPlotSeries.boxOutlineVisible()

Return type

bool

This property holds The visibility of the box outline..

PySide6.QtCharts.QBoxPlotSeries.boxSets()

Return type

Returns a list of box-and-whiskers items in a box plot series. Keeps the ownership of the items.

PySide6.QtCharts.QBoxPlotSeries.boxWidth()

Return type

float

This property holds The width of the box-and-whiskers item. The value indicates the relative width of the item within its category. The value can be between 0.0 and 1.0. Negative values are replaced with 0.0 and values greater than 1.0 are replaced with 1.0..

PySide6.QtCharts.QBoxPlotSeries.boxWidthChanged()

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

PySide6.QtCharts.QBoxPlotSeries.boxsetsAdded(sets)

Parameters

sets –

This signal is emitted when the list of box-and-whiskers items specified by sets is added to the series.

PySide6.QtCharts.QBoxPlotSeries.boxsetsRemoved(sets)

Parameters

sets –

This signal is emitted when the list of box-and-whiskers items specified by sets is removed from the series.

PySide6.QtCharts.QBoxPlotSeries.brush()

Return type

PySide6.QtGui.QBrush

This property holds The brush used to fill the boxes of the box-and-whiskers items..

PySide6.QtCharts.QBoxPlotSeries.brushChanged()

This signal is emitted when the brush used to fill the boxes of the box-and-whiskers items changes.

PySide6.QtCharts.QBoxPlotSeries.clear()

Removes all box-and-whiskers items from the series and permanently deletes them.

PySide6.QtCharts.QBoxPlotSeries.clicked(boxset)

Parameters

boxset – PySide6.QtCharts.QBoxSet

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

PySide6.QtCharts.QBoxPlotSeries.count()

Return type

int

This property holds The number of box-and-whiskers items in a box plot series..

PySide6.QtCharts.QBoxPlotSeries.countChanged()

This signal is emitted when the number of box-and-whiskers items in the series changes.

PySide6.QtCharts.QBoxPlotSeries.doubleClicked(boxset)

Parameters

boxset – PySide6.QtCharts.QBoxSet

This signal is emitted when the user double-clicks the box-and-whiskers item specified by boxset in the chart.

PySide6.QtCharts.QBoxPlotSeries.hovered(status, boxset)

Parameters

• status – bool

• boxset – PySide6.QtCharts.QBoxSet

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

PySide6.QtCharts.QBoxPlotSeries.insert(index, box)

Parameters

• index – int

• box – PySide6.QtCharts.QBoxSet

Return type

bool

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

PySide6.QtCharts.QBoxPlotSeries.pen()

Return type

PySide6.QtGui.QPen

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

PySide6.QtCharts.QBoxPlotSeries.penChanged()

This signal is emitted when the pen used to draw the lines of the box-and-whiskers items changes.

PySide6.QtCharts.QBoxPlotSeries.pressed(boxset)

Parameters

boxset – PySide6.QtCharts.QBoxSet

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

PySide6.QtCharts.QBoxPlotSeries.released(boxset)

Parameters

boxset – PySide6.QtCharts.QBoxSet

This signal is emitted when the user releases the mouse press on the box-and-whiskers item specified by boxset in the chart.

PySide6.QtCharts.QBoxPlotSeries.remove(box)

Parameters

box – PySide6.QtCharts.QBoxSet

Return type

bool

Removes the box-and-whiskers item specified by set from the series and permanently deletes it if the removal succeeds. Returns true if the item was removed.

PySide6.QtCharts.QBoxPlotSeries.setBoxOutlineVisible(visible)

Parameters

visible – bool

This property holds The visibility of the box outline..

PySide6.QtCharts.QBoxPlotSeries.setBoxWidth(width)

Parameters

width – float

This property holds The width of the box-and-whiskers item. The value indicates the relative width of the item within its category. The value can be between 0.0 and 1.0. Negative values are replaced with 0.0 and values greater than 1.0 are replaced with 1.0..

PySide6.QtCharts.QBoxPlotSeries.setBrush(brush)

Parameters

brush – PySide6.QtGui.QBrush

This property holds The brush used to fill the boxes of the box-and-whiskers items..

PySide6.QtCharts.QBoxPlotSeries.setPen(pen)

Parameters

pen – PySide6.QtGui.QPen

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

PySide6.QtCharts.QBoxPlotSeries.take(box)

Parameters

box – PySide6.QtCharts.QBoxSet

Return type

bool

Takes the box-and-whiskers item specified by set from the series. Does not delete the item.

Note

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

Returns true if the take operation succeeds.