• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • edu API Reference
  • KDE Home
  • Contact Us
 

kstars

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QCPStatisticalBox Class Reference

#include <qcustomplot.h>

Inheritance diagram for QCPStatisticalBox:
Inheritance graph
[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
 
QCPRange getKeyRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth) const override
 
QCPRange getValueRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth, const QCPRange &inKeyRange=QCPRange()) const override
 
QPen medianPen () const
 
QCPScatterStyle outlierStyle () const
 
double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=nullptr) const override
 
QCPDataSelection selectTestRect (const QRectF &rect, bool onlySelectable) const override
 
void setData (QSharedPointer< QCPStatisticalBoxDataContainer > data)
 
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 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)
 
 ~QCPAbstractPlottable1D () override
 
int dataCount () const override
 
double dataMainKey (int index) const override
 
double dataMainValue (int index) const override
 
QPointF dataPixelPosition (int index) const override
 
double dataSortKey (int index) const override
 
QCPRange dataValueRange (int index) const override
 
int findBegin (double sortKey, bool expandedRange=true) const override
 
int findEnd (double sortKey, bool expandedRange=true) const override
 
QCPPlottableInterface1D * interface1D () override
 
double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=nullptr) const override
 
QCPDataSelection selectTestRect (const QRectF &rect, bool onlySelectable) const override
 
bool sortKeyIsMainKey () const override
 
- Public Member Functions inherited from QCPAbstractPlottable
 QCPAbstractPlottable (QCPAxis *keyAxis, QCPAxis *valueAxis)
 
 ~QCPAbstractPlottable () override
 
bool addToLegend (QCPLegend *legend)
 
bool addToLegend ()
 
bool antialiasedFill () const
 
bool antialiasedScatters () const
 
QBrush brush () const
 
void coordsToPixels (double key, double value, double &x, double &y) const
 
const QPointF coordsToPixels (double key, double value) const
 
QCPAxis * keyAxis () const
 
QString name () const
 
QPen pen () const
 
void pixelsToCoords (double x, double y, double &key, double &value) const
 
void pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const
 
bool removeFromLegend (QCPLegend *legend) const
 
bool removeFromLegend () 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)
 
 ~QCPLayerable () override
 
bool antialiased () const
 
QCPLayer * layer () const
 
QCPLayerable * parentLayerable () const
 
QCustomPlot * parentPlot () const
 
bool realVisibility () const
 
void setAntialiased (bool enabled)
 
Q_SLOT bool setLayer (QCPLayer *layer)
 
bool setLayer (const QString &layerName)
 
void setVisible (bool on)
 
bool visible () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Protected Member Functions

void draw (QCPPainter *painter) override
 
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
 
QRect clipRect () const override
 
void deselectEvent (bool *selectionStateChanged) override
 
void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) override
 
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
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () 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

- 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
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
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)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

A plottable representing a single statistical box in a plot.

QCPStatisticalBox.png

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 6850 of file qcustomplot.h.

Constructor & Destructor Documentation

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 25332 of file qcustomplot.cpp.

Member Function Documentation

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 25476 of file qcustomplot.cpp.

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 25516 of file qcustomplot.cpp.

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 6866 of file qcustomplot.h.

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 25621 of file qcustomplot.cpp.

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 25686 of file qcustomplot.cpp.

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 25705 of file qcustomplot.cpp.

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 25599 of file qcustomplot.cpp.

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 25770 of file qcustomplot.cpp.

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.

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, getKeyRange

Implements QCPAbstractPlottable.

Definition at line 25614 of file qcustomplot.cpp.

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 25746 of file qcustomplot.cpp.

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 25786 of file qcustomplot.cpp.

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 25803 of file qcustomplot.cpp.

QPen QCPStatisticalBox::medianPen ( ) const
inline

Definition at line 6890 of file qcustomplot.h.

QCPScatterStyle QCPStatisticalBox::outlierStyle ( ) const
inline

Definition at line 6894 of file qcustomplot.h.

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

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also
selectEvent, deselectEvent, mousePressEvent, wheelEvent, QCustomPlot::setInteractions

Reimplemented from QCPLayerable.

Definition at line 25547 of file qcustomplot.cpp.

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.

Implements QCPPlottableInterface1D.

Definition at line 25525 of file qcustomplot.cpp.

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 25357 of file qcustomplot.cpp.

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 25372 of file qcustomplot.cpp.

void QCPStatisticalBox::setMedianPen ( const QPen &  pen)

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

Definition at line 25448 of file qcustomplot.cpp.

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 25459 of file qcustomplot.cpp.

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 25440 of file qcustomplot.cpp.

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 25429 of file qcustomplot.cpp.

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 25415 of file qcustomplot.cpp.

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 25399 of file qcustomplot.cpp.

void QCPStatisticalBox::setWidth ( double  width)

Sets the width of the boxes in key coordinates.

See also
setWhiskerWidth

Definition at line 25386 of file qcustomplot.cpp.

bool QCPStatisticalBox::whiskerAntialiased ( ) const
inline

Definition at line 6886 of file qcustomplot.h.

QPen QCPStatisticalBox::whiskerBarPen ( ) const
inline

Definition at line 6882 of file qcustomplot.h.

QPen QCPStatisticalBox::whiskerPen ( ) const
inline

Definition at line 6878 of file qcustomplot.h.

double QCPStatisticalBox::whiskerWidth ( ) const
inline

Definition at line 6874 of file qcustomplot.h.

double QCPStatisticalBox::width ( ) const
inline

Definition at line 6870 of file qcustomplot.h.

Member Data Documentation

QPen QCPStatisticalBox::mMedianPen
protected

Definition at line 6932 of file qcustomplot.h.

QCPScatterStyle QCPStatisticalBox::mOutlierStyle
protected

Definition at line 6933 of file qcustomplot.h.

bool QCPStatisticalBox::mWhiskerAntialiased
protected

Definition at line 6931 of file qcustomplot.h.

QPen QCPStatisticalBox::mWhiskerBarPen
protected

Definition at line 6930 of file qcustomplot.h.

QPen QCPStatisticalBox::mWhiskerPen
protected

Definition at line 6930 of file qcustomplot.h.

double QCPStatisticalBox::mWhiskerWidth
protected

Definition at line 6929 of file qcustomplot.h.

double QCPStatisticalBox::mWidth
protected

Definition at line 6928 of file qcustomplot.h.


The documentation for this class was generated from the following files:
  • qcustomplot.h
  • qcustomplot.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Sun Dec 15 2019 03:10:25 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kstars

Skip menu "kstars"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

edu API Reference

Skip menu "edu API Reference"
  •     core
  • kstars

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal