A plottable representing a bar chart in a plot. More...
#include <qcustomplot.h>
Public Types | |
enum | WidthType { wtAbsolute, wtAxisRectRatio, wtPlotCoords } |
Public Member Functions | |
void | addData (const QVector< double > &keys, const QVector< double > &values, bool alreadySorted=false) |
void | addData (double key, double value) |
QCPBars * | barAbove () const |
QCPBars * | barBelow () const |
QCPBarsGroup * | barsGroup () const |
double | baseValue () const |
QSharedPointer< QCPBarsDataContainer > | data () const |
virtual QPointF | dataPixelPosition (int index) const Q_DECL_OVERRIDE |
virtual QCPRange | getKeyRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth) const Q_DECL_OVERRIDE |
virtual QCPRange | getValueRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth, const QCPRange &inKeyRange=QCPRange()) const Q_DECL_OVERRIDE |
void | moveAbove (QCPBars *bars) |
void | moveBelow (QCPBars *bars) |
QCPBars (QCPAxis *keyAxis, QCPAxis *valueAxis) | |
virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE |
virtual QCPDataSelection | selectTestRect (const QRectF &rect, bool onlySelectable) const Q_DECL_OVERRIDE |
void | setBarsGroup (QCPBarsGroup *barsGroup) |
void | setBaseValue (double baseValue) |
void | setData (QSharedPointer< QCPBarsDataContainer > data) |
void | setData (const QVector< double > &keys, const QVector< double > &values, bool alreadySorted=false) |
void | setStackingGap (double pixels) |
void | setWidth (double width) |
void | setWidthType (WidthType widthType) |
double | stackingGap () const |
double | width () const |
WidthType | widthType () const |
virtual | ~QCPBars () |
![]() | |
virtual int | dataCount () const Q_DECL_OVERRIDE |
virtual double | dataMainKey (int index) const Q_DECL_OVERRIDE |
virtual double | dataMainValue (int index) const Q_DECL_OVERRIDE |
virtual double | dataSortKey (int index) const Q_DECL_OVERRIDE |
virtual QCPRange | dataValueRange (int index) const Q_DECL_OVERRIDE |
virtual int | findBegin (double sortKey, bool expandedRange=true) const Q_DECL_OVERRIDE |
virtual int | findEnd (double sortKey, bool expandedRange=true) const Q_DECL_OVERRIDE |
virtual QCPPlottableInterface1D * | interface1D () Q_DECL_OVERRIDE |
QCPAbstractPlottable1D (QCPAxis *keyAxis, QCPAxis *valueAxis) | |
virtual bool | sortKeyIsMainKey () const Q_DECL_OVERRIDE |
virtual | ~QCPAbstractPlottable1D () |
![]() | |
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 |
QCPAbstractPlottable (QCPAxis *keyAxis, QCPAxis *valueAxis) | |
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 |
virtual | ~QCPAbstractPlottable () |
![]() | |
bool | antialiased () const |
QCPLayer * | layer () const |
QCPLayerable * | parentLayerable () const |
QCustomPlot * | parentPlot () const |
QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0) | |
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 |
virtual | ~QCPLayerable () |
![]() | |
virtual | ~QCPPlottableInterface1D () |
Protected Member Functions | |
virtual void | draw (QCPPainter *painter) Q_DECL_OVERRIDE |
virtual void | drawLegendIcon (QCPPainter *painter, const QRectF &rect) const Q_DECL_OVERRIDE |
QRectF | getBarRect (double key, double value) const |
void | getPixelWidth (double key, double &lower, double &upper) const |
double | getStackedBaseValue (double key, bool positive) const |
void | getVisibleDataBounds (QCPBarsDataContainer::const_iterator &begin, QCPBarsDataContainer::const_iterator &end) const |
![]() | |
void | drawPolyline (QCPPainter *painter, const QVector< QPointF > &lineData) const |
void | getDataSegments (QList< QCPDataRange > &selectedSegments, QList< QCPDataRange > &unselectedSegments) const |
![]() | |
void | applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE |
void | applyFillAntialiasingHint (QCPPainter *painter) const |
void | applyScattersAntialiasingHint (QCPPainter *painter) const |
virtual QRect | clipRect () const Q_DECL_OVERRIDE |
virtual void | deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE |
virtual void | selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) Q_DECL_OVERRIDE |
virtual QCP::Interaction | selectionCategory () const Q_DECL_OVERRIDE |
![]() | |
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) |
Static Protected Member Functions | |
static void | connectBars (QCPBars *lower, QCPBars *upper) |
Protected Attributes | |
QPointer< QCPBars > | mBarAbove |
QPointer< QCPBars > | mBarBelow |
QCPBarsGroup * | mBarsGroup |
double | mBaseValue |
double | mStackingGap |
double | mWidth |
WidthType | mWidthType |
![]() | |
QSharedPointer< QCPDataContainer< QCPBarsData > > | mDataContainer |
![]() | |
bool | mAntialiasedFill |
bool | mAntialiasedScatters |
QBrush | mBrush |
QPointer< QCPAxis > | mKeyAxis |
QString | mName |
QPen | mPen |
QCP::SelectionType | mSelectable |
QCPDataSelection | mSelection |
QCPSelectionDecorator * | mSelectionDecorator |
QPointer< QCPAxis > | mValueAxis |
![]() | |
bool | mAntialiased |
QCPLayer * | mLayer |
QPointer< QCPLayerable > | mParentLayerable |
QCustomPlot * | mParentPlot |
bool | mVisible |
Friends | |
class | QCPBarsGroup |
class | QCPLegend |
class | QCustomPlot |
Additional Inherited Members | |
![]() | |
void | selectableChanged (QCP::SelectionType selectable) |
void | selectionChanged (bool selected) |
void | selectionChanged (const QCPDataSelection &selection) |
![]() | |
void | layerChanged (QCPLayer *newLayer) |
A plottable representing a bar chart in a plot.
To plot data, assign it with the setData or addData functions.
The appearance of the bars is determined by the pen and the brush (setPen, setBrush). The width of the individual bars can be controlled with setWidthType and setWidth.
Bar charts are stackable. This means, two QCPBars plottables can be placed on top of each other (see QCPBars::moveAbove). So when two bars are at the same key position, they will appear stacked.
If you would like to group multiple QCPBars plottables together so they appear side by side as shown below, use QCPBarsGroup.
Like all data representing objects in QCustomPlot, the QCPBars 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 5482 of file qcustomplot.h.
enum QCPBars::WidthType |
Defines the ways the width of the bar can be specified. Thus it defines what the number passed to setWidth actually means.
Definition at line 5501 of file qcustomplot.h.
Constructs a bar chart 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 QCPBars is automatically registered with the QCustomPlot instance inferred from keyAxis. This QCustomPlot instance takes ownership of the QCPBars, so do not delete it manually but use QCustomPlot::removePlottable() instead.
Definition at line 23650 of file qcustomplot.cpp.
|
virtual |
Definition at line 23666 of file qcustomplot.cpp.
void QCPBars::addData | ( | const QVector< double > & | keys, |
const QVector< double > & | values, | ||
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 and values 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 23790 of file qcustomplot.cpp.
void QCPBars::addData | ( | double | key, |
double | value | ||
) |
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 and value 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 23815 of file qcustomplot.cpp.
|
inline |
Returns the bars plottable that is directly above this bars plottable. If there is no such plottable, returns 0.
Definition at line 5517 of file qcustomplot.h.
|
inline |
Returns the bars plottable that is directly below this bars plottable. If there is no such plottable, returns 0.
Definition at line 5516 of file qcustomplot.h.
|
inline |
Definition at line 5513 of file qcustomplot.h.
|
inline |
Definition at line 5514 of file qcustomplot.h.
Definition at line 24305 of file qcustomplot.cpp.
|
inline |
Returns a shared pointer to the internal data storage of type QCPBarsDataContainer. 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 5518 of file qcustomplot.h.
|
virtual |
Returns the pixel position on the widget surface at which the data point at the given index appears.
Usually this corresponds to the point of dataMainKey/dataMainValue, in pixel coordinates. However, depending on the plottable, this might be a different apparent position than just a coord-to-pixel transform of those values. For example, QCPBars apparent data values can be shifted depending on their stacking, bar grouping or configured base value.
Reimplemented from QCPAbstractPlottable1D< QCPBarsData >.
Definition at line 24026 of file qcustomplot.cpp.
|
protectedvirtual |
Implements QCPAbstractPlottable.
Definition at line 24049 of file qcustomplot.cpp.
|
protectedvirtual |
Implements QCPAbstractPlottable.
Definition at line 24098 of file qcustomplot.cpp.
|
protected |
Definition at line 24183 of file qcustomplot.cpp.
|
virtual |
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.
Implements QCPAbstractPlottable.
Definition at line 23947 of file qcustomplot.cpp.
|
protected |
Definition at line 24220 of file qcustomplot.cpp.
|
protected |
Definition at line 24270 of file qcustomplot.cpp.
|
virtual |
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.
Implements QCPAbstractPlottable.
Definition at line 23986 of file qcustomplot.cpp.
|
protected |
Definition at line 24123 of file qcustomplot.cpp.
void QCPBars::moveAbove | ( | QCPBars * | bars | ) |
Moves this bars plottable above bars. In other words, the bars of this plottable will appear above the bars of bars. The move target bars must use the same key and value axis as this plottable.
Inserting into and removing from existing bar stacking is handled gracefully. If bars already has a bars object above itself, this bars object is inserted between the two. If this bars object is already between two other bars, the two other bars will be stacked on top of each other after the operation.
To remove this bars plottable from any stacking, set bars to 0.
Definition at line 23867 of file qcustomplot.cpp.
void QCPBars::moveBelow | ( | QCPBars * | bars | ) |
Moves this bars plottable below bars. In other words, the bars of this plottable will appear below the bars of bars. The move target bars must use the same key and value axis as this plottable.
Inserting into and removing from existing bar stacking is handled gracefully. If bars already has a bars object below itself, this bars object is inserted between the two. If this bars object is already between two other bars, the two other bars will be stacked on top of each other after the operation.
To remove this bars plottable from any stacking, set bars to 0.
Definition at line 23834 of file qcustomplot.cpp.
|
virtual |
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.
QCPAbstractPlottable::selectTest
Reimplemented from QCPAbstractPlottable1D< QCPBarsData >.
Definition at line 23917 of file qcustomplot.cpp.
|
virtual |
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).
QRect::normalized()
when passing a rect which might not be normalized. Reimplemented from QCPAbstractPlottable1D< QCPBarsData >.
Definition at line 23889 of file qcustomplot.cpp.
void QCPBars::setBarsGroup | ( | QCPBarsGroup * | barsGroup | ) |
Sets to which QCPBarsGroup this QCPBars instance belongs to. Alternatively, you can also use QCPBarsGroup::append.
To remove this QCPBars from any group, set barsGroup to 0.
Definition at line 23740 of file qcustomplot.cpp.
void QCPBars::setBaseValue | ( | double | baseValue | ) |
Sets the base value of this bars plottable.
The base value defines where on the value coordinate the bars start. How far the bars extend from the base value is given by their individual value data. For example, if the base value is set to 1, a bar with data value 2 will have its lowest point at value coordinate 1 and highest point at 3.
For stacked bars, only the base value of the bottom-most QCPBars has meaning.
The default base value is 0.
Definition at line 23763 of file qcustomplot.cpp.
void QCPBars::setData | ( | QSharedPointer< QCPBarsDataContainer > | 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 QCPBars may share the same data container safely. Modifying the data in the container will then affect all bars 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 bar's data container directly:
Definition at line 23688 of file qcustomplot.cpp.
void QCPBars::setData | ( | const QVector< double > & | keys, |
const QVector< double > & | values, | ||
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 and values. 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.
Definition at line 23704 of file qcustomplot.cpp.
void QCPBars::setStackingGap | ( | double | pixels | ) |
If this bars plottable is stacked on top of another bars plottable (moveAbove), this method allows specifying a distance in pixels, by which the drawn bar rectangles will be separated by the bars below it.
Definition at line 23773 of file qcustomplot.cpp.
void QCPBars::setWidth | ( | double | width | ) |
Sets the width of the bars.
How the number passed as width is interpreted (e.g. screen pixels, plot coordinates,...), depends on the currently set width type, see setWidthType and WidthType.
Definition at line 23716 of file qcustomplot.cpp.
void QCPBars::setWidthType | ( | QCPBars::WidthType | widthType | ) |
Sets how the width of the bars is defined. See the documentation of WidthType for an explanation of the possible values for widthType.
The default value is wtPlotCoords.
Definition at line 23729 of file qcustomplot.cpp.
|
inline |
Definition at line 5515 of file qcustomplot.h.
|
inline |
Definition at line 5511 of file qcustomplot.h.
|
inline |
Definition at line 5512 of file qcustomplot.h.
|
friend |
Definition at line 5564 of file qcustomplot.h.
|
friend |
Definition at line 5563 of file qcustomplot.h.
|
friend |
Definition at line 5562 of file qcustomplot.h.
|
protected |
Definition at line 5549 of file qcustomplot.h.
|
protected |
Definition at line 5549 of file qcustomplot.h.
|
protected |
Definition at line 5546 of file qcustomplot.h.
|
protected |
Definition at line 5547 of file qcustomplot.h.
|
protected |
Definition at line 5548 of file qcustomplot.h.
|
protected |
Definition at line 5544 of file qcustomplot.h.
|
protected |
Definition at line 5545 of file qcustomplot.h.