class QBoxPlotSeries#

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

Synopsis#

Properties#

boxOutlineVisibleᅟ - Visibility of the box outline
boxWidthᅟ - 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
brushᅟ - Used to fill the boxes of the box-and-whiskers items
countᅟ - Number of box-and-whiskers items in a box plot series
penᅟ - Used to draw the lines of the box-and-whiskers items

Methods#

def __init__()
def append()
def boxOutlineVisible()
def boxSets()
def boxWidth()
def brush()
def clear()
def count()
def insert()
def pen()
def remove()
def setBoxOutlineVisible()
def setBoxWidth()
def setBrush()
def setPen()
def take()

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 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 Charts with Widgets Gallery to learn how to create a box-and-whiskers chart.

See also

QBoxSet QBarCategoryAxis

Note

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

property boxOutlineVisibleᅟ: bool#

This property holds The visibility of the box outline..

Access functions:

boxOutlineVisible()
setBoxOutlineVisible()
Signal boxOutlineVisibilityChanged()

property boxWidthᅟ: 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..

Access functions:

boxWidth()
setBoxWidth()
Signal boxWidthChanged()

property brushᅟ: QBrush#

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

Access functions:

brush()
setBrush()
Signal brushChanged()

property countᅟ: int#

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

Access functions:

count()
Signal countChanged()

property penᅟ: QPen#

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

Access functions:

pen()
setPen()
Signal penChanged()

__init__([parent=None])#

Parameters:: parent – QObject

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

append(box)#

Parameters:: box – 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.

append(boxes)

Parameters:: boxes – .list of QBoxSet
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.

boxOutlineVisibilityChanged()#

This signal is emitted when the box outline visibility changes.

Notification signal of property boxOutlineVisibleᅟ .

boxOutlineVisible()#

Return type:: bool

See also

setBoxOutlineVisible()

Getter of property boxOutlineVisibleᅟ .

boxSets()#

Return type:: .list of QBoxSet

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

boxWidth()#

Return type:: float

See also

setBoxWidth()

Getter of property boxWidthᅟ .

boxWidthChanged()#

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

Notification signal of property boxWidthᅟ .

boxsetsAdded(sets)#

Parameters:: sets – .list of QBoxSet

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

boxsetsRemoved(sets)#

Parameters:: sets – .list of QBoxSet

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

brush()#

Return type:: QBrush

See also

setBrush()

Getter of property brushᅟ .

brushChanged()#

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

Notification signal of property brushᅟ .

clear()#

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

clicked(boxset)#

Parameters:: boxset – QBoxSet

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

count()#

Return type:: int

Returns the number of box-and-whiskers items in a box plot series.

Getter of property countᅟ .

countChanged()#

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

Notification signal of property countᅟ .

doubleClicked(boxset)#

Parameters:: boxset – QBoxSet

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

hovered(status, boxset)#

Parameters:

status – bool
boxset – 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.

insert(index, box)#

Parameters:

index – int
box – 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.

pen()#

Return type:: QPen

See also

setPen()

Getter of property penᅟ .

penChanged()#

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

Notification signal of property penᅟ .

pressed(boxset)#

Parameters:: boxset – 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.

released(boxset)#

Parameters:: boxset – QBoxSet

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

remove(box)#

Parameters:: box – 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.

setBoxOutlineVisible(visible)#

Parameters:: visible – bool

See also

boxOutlineVisible()

Setter of property boxOutlineVisibleᅟ .

setBoxWidth(width)#

Parameters:: width – float

See also

boxWidth()

Setter of property boxWidthᅟ .

setBrush(brush)#

Parameters:: brush – QBrush

See also

brush()

Setter of property brushᅟ .

setPen(pen)#

Parameters:: pen – QPen

See also

pen()

Setter of property penᅟ .

take(box)#

Parameters:: box – 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.