QCPStatisticalBox

Inheritance diagram for QCPStatisticalBox:

[legend]

Public Member Functions
	QCPStatisticalBox (QCPAxis keyAxis, QCPAxis valueAxis)

void	addData (const QVector< double > &keys, const QVector< double > &minimum, const QVector< double > &lowerQuartile, const QVector< double > &median, const QVector< double > &upperQuartile, const QVector< double > &maximum, bool alreadySorted=false)

void	addData (double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum, const QVector< double > &outliers=QVector< double >())

QSharedPointer< QCPStatisticalBoxDataContainer >	data () const

virtual QCPRange	getKeyRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth) const override

virtual QCPRange	getValueRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth, const QCPRange &inKeyRange=QCPRange()) const override

QPen	medianPen () const

QCPScatterStyle	outlierStyle () const

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=nullptr) const override

virtual QCPDataSelection	selectTestRect (const QRectF &rect, bool onlySelectable) const override

void	setData (const QVector< double > &keys, const QVector< double > &minimum, const QVector< double > &lowerQuartile, const QVector< double > &median, const QVector< double > &upperQuartile, const QVector< double > &maximum, bool alreadySorted=false)

void	setData (QSharedPointer< QCPStatisticalBoxDataContainer > data)

void	setMedianPen (const QPen &pen)

void	setOutlierStyle (const QCPScatterStyle &style)

void	setWhiskerAntialiased (bool enabled)

void	setWhiskerBarPen (const QPen &pen)

void	setWhiskerPen (const QPen &pen)

void	setWhiskerWidth (double width)

void	setWidth (double width)

bool	whiskerAntialiased () const

QPen	whiskerBarPen () const

QPen	whiskerPen () const

double	whiskerWidth () const

double	width () const

Public Member Functions inherited from QCPAbstractPlottable1D< QCPStatisticalBoxData >
	QCPAbstractPlottable1D (QCPAxis keyAxis, QCPAxis valueAxis)

virtual int	dataCount () const override

virtual double	dataMainKey (int index) const override

virtual double	dataMainValue (int index) const override

virtual QPointF	dataPixelPosition (int index) const override

virtual double	dataSortKey (int index) const override

virtual QCPRange	dataValueRange (int index) const override

virtual int	findBegin (double sortKey, bool expandedRange=true) const override

virtual int	findEnd (double sortKey, bool expandedRange=true) const override

virtual QCPPlottableInterface1D *	interface1D () override

virtual bool	sortKeyIsMainKey () const override

Public Member Functions inherited from QCPAbstractPlottable
	QCPAbstractPlottable (QCPAxis keyAxis, QCPAxis valueAxis)

bool	addToLegend ()

bool	addToLegend (QCPLegend *legend)

bool	antialiasedFill () const

bool	antialiasedScatters () const

QBrush	brush () const

const QPointF	coordsToPixels (double key, double value) const

void	coordsToPixels (double key, double value, double &x, double &y) const

QCPAxis *	keyAxis () const

QString	name () const

QPen	pen () const

void	pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const

void	pixelsToCoords (double x, double y, double &key, double &value) const

bool	removeFromLegend () const

bool	removeFromLegend (QCPLegend *legend) const

void	rescaleAxes (bool onlyEnlarge=false) const

void	rescaleKeyAxis (bool onlyEnlarge=false) const

void	rescaleValueAxis (bool onlyEnlarge=false, bool inKeyRange=false) const

QCP::SelectionType	selectable () const

bool	selected () const

QCPDataSelection	selection () const

QCPSelectionDecorator *	selectionDecorator () const

void	setAntialiasedFill (bool enabled)

void	setAntialiasedScatters (bool enabled)

void	setBrush (const QBrush &brush)

void	setKeyAxis (QCPAxis *axis)

void	setName (const QString &name)

void	setPen (const QPen &pen)

Q_SLOT void	setSelectable (QCP::SelectionType selectable)

Q_SLOT void	setSelection (QCPDataSelection selection)

void	setSelectionDecorator (QCPSelectionDecorator *decorator)

void	setValueAxis (QCPAxis *axis)

QCPAxis *	valueAxis () const

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=nullptr)

bool	antialiased () const

QCPLayer *	layer () const

QCPLayerable *	parentLayerable () const

QCustomPlot *	parentPlot () const

bool	realVisibility () const

void	setAntialiased (bool enabled)

bool	setLayer (const QString &layerName)

Q_SLOT bool	setLayer (QCPLayer *layer)

void	setVisible (bool on)

bool	visible () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QCPPlottableInterface1D

Protected Member Functions
virtual void	draw (QCPPainter *painter) override

virtual void	drawLegendIcon (QCPPainter *painter, const QRectF &rect) const override

virtual void	drawStatisticalBox (QCPPainter *painter, QCPStatisticalBoxDataContainer::const_iterator it, const QCPScatterStyle &outlierStyle) const

QRectF	getQuartileBox (QCPStatisticalBoxDataContainer::const_iterator it) const

void	getVisibleDataBounds (QCPStatisticalBoxDataContainer::const_iterator &begin, QCPStatisticalBoxDataContainer::const_iterator &end) const

QVector< QLineF >	getWhiskerBackboneLines (QCPStatisticalBoxDataContainer::const_iterator it) const

QVector< QLineF >	getWhiskerBarLines (QCPStatisticalBoxDataContainer::const_iterator it) const

Protected Member Functions inherited from QCPAbstractPlottable1D< QCPStatisticalBoxData >
void	drawPolyline (QCPPainter *painter, const QVector< QPointF > &lineData) const

void	getDataSegments (QList< QCPDataRange > &selectedSegments, QList< QCPDataRange > &unselectedSegments) const

Protected Member Functions inherited from QCPAbstractPlottable
void	applyDefaultAntialiasingHint (QCPPainter *painter) const override

void	applyFillAntialiasingHint (QCPPainter *painter) const

void	applyScattersAntialiasingHint (QCPPainter *painter) const

virtual QRect	clipRect () const override

virtual void	deselectEvent (bool *selectionStateChanged) override

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged) override

virtual QCP::Interaction	selectionCategory () const override

Protected Member Functions inherited from QCPLayerable
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

void	initializeParentPlot (QCustomPlot *parentPlot)

virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)

virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)

bool	moveToLayer (QCPLayer *layer, bool prepend)

virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
QPen	mMedianPen

QCPScatterStyle	mOutlierStyle

bool	mWhiskerAntialiased

QPen	mWhiskerBarPen

QPen	mWhiskerPen

double	mWhiskerWidth

double	mWidth

Protected Attributes inherited from QCPAbstractPlottable1D< QCPStatisticalBoxData >
QSharedPointer< QCPDataContainer< QCPStatisticalBoxData > >	mDataContainer

Protected Attributes inherited from QCPAbstractPlottable
bool	mAntialiasedFill

bool	mAntialiasedScatters

QBrush	mBrush

QPointer< QCPAxis >	mKeyAxis

QString	mName

QPen	mPen

QCP::SelectionType	mSelectable

QCPDataSelection	mSelection

QCPSelectionDecorator *	mSelectionDecorator

QPointer< QCPAxis >	mValueAxis

Protected Attributes inherited from QCPLayerable
bool	mAntialiased

QCPLayer *	mLayer

QPointer< QCPLayerable >	mParentLayerable

QCustomPlot *	mParentPlot

bool	mVisible

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Properties inherited from QObject
	objectName

Signals inherited from QCPAbstractPlottable
void	selectableChanged (QCP::SelectionType selectable)

void	selectionChanged (bool selected)

void	selectionChanged (const QCPDataSelection &selection)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Detailed Description

A plottable representing a single statistical box in a plot.

To plot data, assign it with the setData or addData functions. Alternatively, you can also access and modify the data via the data method, which returns a pointer to the internal QCPStatisticalBoxDataContainer.

Additionally each data point can itself have a list of outliers, drawn as scatter points at the key coordinate of the respective statistical box data point. They can either be set by using the respective addData method or accessing the individual data points through data, and setting the QVector<double> outliers of the data points directly.

Changing the appearance

The appearance of each data point box, ranging from the lower to the upper quartile, is controlled via setPen and setBrush. You may change the width of the boxes with setWidth in plot coordinates.

Each data point's visual representation also consists of two whiskers. Whiskers are the lines which reach from the upper quartile to the maximum, and from the lower quartile to the minimum. The appearance of the whiskers can be modified with: setWhiskerPen, setWhiskerBarPen, setWhiskerWidth. The whisker width is the width of the bar perpendicular to the whisker at the top (for maximum) and bottom (for minimum). If the whisker pen is changed, make sure to set the capStyle to Qt::FlatCap. Otherwise the backbone line might exceed the whisker bars by a few pixels due to the pen cap being not perfectly flat.

The median indicator line inside the box has its own pen, setMedianPen.

The outlier data points are drawn as normal scatter points. Their look can be controlled with setOutlierStyle

Usage

Like all data representing objects in QCustomPlot, the QCPStatisticalBox is a plottable (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies (QCustomPlot::plottable, QCustomPlot::removePlottable, etc.)

Usually, you first create an instance:

which registers it with the QCustomPlot instance of the passed axes. Note that this QCustomPlot instance takes ownership of the plottable, so do not delete it manually but use QCustomPlot::removePlottable() instead. The newly created plottable can be modified, e.g.:

Definition at line 5944 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPStatisticalBox()

QCPStatisticalBox::QCPStatisticalBox	(	QCPAxis *	keyAxis,
		QCPAxis *	valueAxis )

explicit

Constructs a statistical box which uses keyAxis as its key axis ("x") and valueAxis as its value axis ("y"). keyAxis and valueAxis must reside in the same QCustomPlot instance and not have the same orientation. If either of these restrictions is violated, a corresponding message is printed to the debug output (qDebug), the construction is not aborted, though.

The created QCPStatisticalBox is automatically registered with the QCustomPlot instance inferred from keyAxis. This QCustomPlot instance takes ownership of the QCPStatisticalBox, so do not delete it manually but use QCustomPlot::removePlottable() instead.

Definition at line 25329 of file qcustomplot.cpp.

Member Function Documentation

◆ addData() [1/2]

void QCPStatisticalBox::addData	(	const QVector< double > &	keys,
		const QVector< double > &	minimum,
		const QVector< double > &	lowerQuartile,
		const QVector< double > &	median,
		const QVector< double > &	upperQuartile,
		const QVector< double > &	maximum,
		bool	alreadySorted = false )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Adds the provided points in keys, minimum, lowerQuartile, median, upperQuartile and maximum to the current data. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

If you can guarantee that the passed data points are sorted by keys in ascending order, you can set alreadySorted to true, to improve performance by saving a sorting run.

Alternatively, you can also access and modify the data directly via the data method, which returns a pointer to the internal data container.

Definition at line 25475 of file qcustomplot.cpp.

◆ addData() [2/2]

void QCPStatisticalBox::addData	(	double	key,
		double	minimum,
		double	lowerQuartile,
		double	median,
		double	upperQuartile,
		double	maximum,
		const QVector< double > &	outliers = QVector<double>() )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Adds the provided data point as key, minimum, lowerQuartile, median, upperQuartile and maximum to the current data.

Alternatively, you can also access and modify the data directly via the data method, which returns a pointer to the internal data container.

Definition at line 25508 of file qcustomplot.cpp.

◆ data()

QSharedPointer< QCPStatisticalBoxDataContainer > QCPStatisticalBox::data ( ) const

inline

Returns a shared pointer to the internal data storage of type QCPStatisticalBoxDataContainer. You may use it to directly manipulate the data, which may be more convenient and faster than using the regular setData or addData methods.

Definition at line 5960 of file qcustomplot.h.

◆ draw()

void QCPStatisticalBox::draw ( QCPPainter * painter )

overrideprotectedvirtual

This function draws the layerable with the specified painter. It is only called by QCustomPlot, if the layerable is visible (setVisible).

Before this function is called, the painter's antialiasing state is set via applyDefaultAntialiasingHint, see the documentation there. Further, the clipping rectangle was set to clipRect.

Implements QCPAbstractPlottable.

Definition at line 25616 of file qcustomplot.cpp.

◆ drawLegendIcon()

void QCPStatisticalBox::drawLegendIcon	(	QCPPainter *	painter,
		const QRectF &	rect ) const

overrideprotectedvirtual

called by QCPLegend::draw (via QCPPlottableLegendItem::draw) to create a graphical representation of this plottable inside rect, next to the plottable name.

The passed painter has its cliprect set to rect, so painting outside of rect won't appear outside the legend icon border.

Implements QCPAbstractPlottable.

Definition at line 25674 of file qcustomplot.cpp.

◆ drawStatisticalBox()

void QCPStatisticalBox::drawStatisticalBox	(	QCPPainter *	painter,
		QCPStatisticalBoxDataContainer::const_iterator	it,
		const QCPScatterStyle &	outlierStyle ) const

protectedvirtual

Draws the graphical representation of a single statistical box with the data given by the iterator it with the provided painter.

If the statistical box has a set of outlier data points, they are drawn with outlierStyle.

See also: getQuartileBox, getWhiskerBackboneLines, getWhiskerBarLines

Definition at line 25693 of file qcustomplot.cpp.

◆ getKeyRange()

QCPRange QCPStatisticalBox::getKeyRange	(	bool &	foundRange,
		QCP::SignDomain	inSignDomain = QCP::sdBoth ) const

overridevirtual

Returns the coordinate range that all data in this plottable span in the key axis dimension. For logarithmic plots, one can set inSignDomain to either QCP::sdNegative or QCP::sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to QCP::sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to QCP::sdBoth (default). foundRange is an output parameter that indicates whether a range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

Note that foundRange is not the same as QCPRange::validRange, since the range returned by this function may have size zero (e.g. when there is only one data point). In this case foundRange would return true, but the returned range is not a valid range in terms of QCPRange::validRange.

See also: rescaleAxes, getValueRange

Implements QCPAbstractPlottable.

Definition at line 25595 of file qcustomplot.cpp.

◆ getQuartileBox()

QRectF QCPStatisticalBox::getQuartileBox ( QCPStatisticalBoxDataContainer::const_iterator it ) const

protected

Returns the box in plot coordinates (keys in x, values in y of the returned rect) that covers the value range from the lower to the upper quartile, of the data given by it.

See also: drawStatisticalBox, getWhiskerBackboneLines, getWhiskerBarLines

Definition at line 25752 of file qcustomplot.cpp.

◆ getValueRange()

QCPRange QCPStatisticalBox::getValueRange	(	bool &	foundRange,
		QCP::SignDomain	inSignDomain = QCP::sdBoth,
		const QCPRange &	inKeyRange = QCPRange() ) const

overridevirtual

Returns the coordinate range that the data points in the specified key range (inKeyRange) span in the value axis dimension. For logarithmic plots, one can set inSignDomain to either QCP::sdNegative or QCP::sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to QCP::sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to QCP::sdBoth (default). foundRange is an output parameter that indicates whether a range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

If inKeyRange has both lower and upper bound set to zero (is equal to QCPRange()), all data points are considered, without any restriction on the keys.

See also: rescaleAxes, getKeyRange

Implements QCPAbstractPlottable.

Definition at line 25610 of file qcustomplot.cpp.

◆ getVisibleDataBounds()

void QCPStatisticalBox::getVisibleDataBounds	(	QCPStatisticalBoxDataContainer::const_iterator &	begin,
		QCPStatisticalBoxDataContainer::const_iterator &	end ) const

protected

called by draw to determine which data (key) range is visible at the current key axis range setting, so only that needs to be processed. It also takes into account the bar width.

begin returns an iterator to the lowest data point that needs to be taken into account when plotting. Note that in order to get a clean plot all the way to the edge of the axis rect, lower may still be just outside the visible range.

end returns an iterator one higher than the highest visible data point. Same as before, end may also lie just outside of the visible range.

if the plottable contains no data, both begin and end point to constEnd.

Definition at line 25732 of file qcustomplot.cpp.

◆ getWhiskerBackboneLines()

QVector< QLineF > QCPStatisticalBox::getWhiskerBackboneLines ( QCPStatisticalBoxDataContainer::const_iterator it ) const

protected

Returns the whisker backbones (keys in x, values in y of the returned lines) that cover the value range from the minimum to the lower quartile, and from the upper quartile to the maximum of the data given by it.

See also: drawStatisticalBox, getQuartileBox, getWhiskerBarLines

Definition at line 25768 of file qcustomplot.cpp.

◆ getWhiskerBarLines()

QVector< QLineF > QCPStatisticalBox::getWhiskerBarLines ( QCPStatisticalBoxDataContainer::const_iterator it ) const

protected

Returns the whisker bars (keys in x, values in y of the returned lines) that are placed at the end of the whisker backbones, at the minimum and maximum of the data given by it.

See also: drawStatisticalBox, getQuartileBox, getWhiskerBackboneLines

Definition at line 25783 of file qcustomplot.cpp.

◆ medianPen()

QPen QCPStatisticalBox::medianPen ( ) const

inline

Definition at line 5966 of file qcustomplot.h.

◆ outlierStyle()

QCPScatterStyle QCPStatisticalBox::outlierStyle ( ) const

inline

Definition at line 5967 of file qcustomplot.h.

◆ selectTest()

double QCPStatisticalBox::selectTest	(	const QPointF &	pos,
		bool	onlySelectable,
		QVariant *	details = nullptr ) const

overridevirtual

Implements a selectTest specific to this plottable's point geometry.

If details is not 0, it will be set to a QCPDataSelection, describing the closest data point to pos.

\seebaseclassmethod QCPAbstractPlottable::selectTest

Reimplemented from QCPAbstractPlottable1D< QCPStatisticalBoxData >.

Definition at line 25544 of file qcustomplot.cpp.

◆ selectTestRect()

QCPDataSelection QCPStatisticalBox::selectTestRect	(	const QRectF &	rect,
		bool	onlySelectable ) const

overridevirtual

Returns a data selection containing all the data points of this plottable which are contained (or hit by) rect. This is used mainly in the selection rect interaction for data selection (data selection mechanism).

If onlySelectable is true, an empty QCPDataSelection is returned if this plottable is not selectable (i.e. if QCPAbstractPlottable::setSelectable is QCP::stNone).

Note: rect must be a normalized rect (positive or zero width and height). This is especially important when using the rect of QCPSelectionRect::accepted, which is not necessarily normalized. Use QRect::normalized() when passing a rect which might not be normalized.

Reimplemented from QCPAbstractPlottable1D< QCPStatisticalBoxData >.

Definition at line 25516 of file qcustomplot.cpp.

◆ setData() [1/2]

void QCPStatisticalBox::setData	(	const QVector< double > &	keys,
		const QVector< double > &	minimum,
		const QVector< double > &	lowerQuartile,
		const QVector< double > &	median,
		const QVector< double > &	upperQuartile,
		const QVector< double > &	maximum,
		bool	alreadySorted = false )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Replaces the current data with the provided points in keys, minimum, lowerQuartile, median, upperQuartile and maximum. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

If you can guarantee that the passed data points are sorted by keys in ascending order, you can set alreadySorted to true, to improve performance by saving a sorting run.

See also: addData

Definition at line 25374 of file qcustomplot.cpp.

◆ setData() [2/2]

void QCPStatisticalBox::setData ( QSharedPointer< QCPStatisticalBoxDataContainer > data )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Replaces the current data container with the provided data container.

Since a QSharedPointer is used, multiple QCPStatisticalBoxes may share the same data container safely. Modifying the data in the container will then affect all statistical boxes that share the container. Sharing can be achieved by simply exchanging the data containers wrapped in shared pointers:

If you do not wish to share containers, but create a copy from an existing container, rather use the QCPDataContainer<DataType>::set method on the statistical box data container directly:

See also: addData

Definition at line 25359 of file qcustomplot.cpp.

◆ setMedianPen()

void QCPStatisticalBox::setMedianPen ( const QPen & pen )

Sets the pen used for drawing the median indicator line inside the statistical boxes.

Definition at line 25447 of file qcustomplot.cpp.

◆ setOutlierStyle()

void QCPStatisticalBox::setOutlierStyle ( const QCPScatterStyle & style )

Sets the appearance of the outlier data points.

Outliers can be specified with the method addData(double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum, const QVector<double> &outliers)

Definition at line 25458 of file qcustomplot.cpp.

◆ setWhiskerAntialiased()

void QCPStatisticalBox::setWhiskerAntialiased ( bool enabled )

Sets whether the statistical boxes whiskers are drawn with antialiasing or not.

Note that antialiasing settings may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

Definition at line 25439 of file qcustomplot.cpp.

◆ setWhiskerBarPen()

void QCPStatisticalBox::setWhiskerBarPen ( const QPen & pen )

Sets the pen used for drawing the whisker bars. Those are the lines parallel to the key axis at each end of the whisker backbone.

Whiskers are the lines which reach from the upper quartile to the maximum, and from the lower quartile to the minimum.

See also: setWhiskerPen

Definition at line 25428 of file qcustomplot.cpp.

◆ setWhiskerPen()

void QCPStatisticalBox::setWhiskerPen ( const QPen & pen )

Sets the pen used for drawing the whisker backbone.

Whiskers are the lines which reach from the upper quartile to the maximum, and from the lower quartile to the minimum.

Make sure to set the capStyle of the passed pen to Qt::FlatCap. Otherwise the backbone line might exceed the whisker bars by a few pixels due to the pen cap being not perfectly flat.

See also: setWhiskerBarPen

Definition at line 25414 of file qcustomplot.cpp.

◆ setWhiskerWidth()

void QCPStatisticalBox::setWhiskerWidth ( double width )

Sets the width of the whiskers in key coordinates.

Whiskers are the lines which reach from the upper quartile to the maximum, and from the lower quartile to the minimum.

See also: setWidth

Definition at line 25398 of file qcustomplot.cpp.

◆ setWidth()

void QCPStatisticalBox::setWidth ( double width )

Sets the width of the boxes in key coordinates.

See also: setWhiskerWidth

Definition at line 25385 of file qcustomplot.cpp.

◆ whiskerAntialiased()

bool QCPStatisticalBox::whiskerAntialiased ( ) const

inline

Definition at line 5965 of file qcustomplot.h.

◆ whiskerBarPen()

QPen QCPStatisticalBox::whiskerBarPen ( ) const

inline

Definition at line 5964 of file qcustomplot.h.

◆ whiskerPen()

QPen QCPStatisticalBox::whiskerPen ( ) const

inline

Definition at line 5963 of file qcustomplot.h.

◆ whiskerWidth()

double QCPStatisticalBox::whiskerWidth ( ) const

inline

Definition at line 5962 of file qcustomplot.h.

◆ width()

double QCPStatisticalBox::width ( ) const

inline

Definition at line 5961 of file qcustomplot.h.

Member Data Documentation

◆ mMedianPen

QPen QCPStatisticalBox::mMedianPen

protected

Definition at line 5996 of file qcustomplot.h.

◆ mOutlierStyle

QCPScatterStyle QCPStatisticalBox::mOutlierStyle

protected

Definition at line 5997 of file qcustomplot.h.

◆ mWhiskerAntialiased

bool QCPStatisticalBox::mWhiskerAntialiased

protected

Definition at line 5995 of file qcustomplot.h.

◆ mWhiskerBarPen

QPen QCPStatisticalBox::mWhiskerBarPen

protected

Definition at line 5994 of file qcustomplot.h.

◆ mWhiskerPen

QPen QCPStatisticalBox::mWhiskerPen

protected

Definition at line 5994 of file qcustomplot.h.

◆ mWhiskerWidth

double QCPStatisticalBox::mWhiskerWidth

protected

Definition at line 5993 of file qcustomplot.h.

◆ mWidth

double QCPStatisticalBox::mWidth

protected

Definition at line 5992 of file qcustomplot.h.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kstars

QCPStatisticalBox

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Changing the appearance

Usage

Constructor & Destructor Documentation

◆ QCPStatisticalBox()

Member Function Documentation

◆ addData() [1/2]

◆ addData() [2/2]

◆ data()

◆ draw()

◆ drawLegendIcon()

◆ drawStatisticalBox()

◆ getKeyRange()

◆ getQuartileBox()

◆ getValueRange()

◆ getVisibleDataBounds()

◆ getWhiskerBackboneLines()

◆ getWhiskerBarLines()

◆ medianPen()

◆ outlierStyle()

◆ selectTest()

◆ selectTestRect()

◆ setData() [1/2]

◆ setData() [2/2]

◆ setMedianPen()

◆ setOutlierStyle()

◆ setWhiskerAntialiased()

◆ setWhiskerBarPen()

◆ setWhiskerPen()

◆ setWhiskerWidth()

◆ setWidth()

◆ whiskerAntialiased()

◆ whiskerBarPen()

◆ whiskerPen()

◆ whiskerWidth()

◆ width()

Member Data Documentation

◆ mMedianPen

◆ mOutlierStyle

◆ mWhiskerAntialiased

◆ mWhiskerBarPen

◆ mWhiskerPen

◆ mWhiskerWidth

◆ mWidth