A plottable representing a bar chart in a plot. More...
Public Functions | |
QCPBars (QCPAxis *keyAxis, QCPAxis *valueAxis) | |
double | width () const |
QCPBars * | barBelow () const |
QCPBars * | barAbove () const |
const QCPBarDataMap * | data () const |
void | setWidth (double width) |
void | setData (QCPBarDataMap *data, bool copy=false) |
void | setData (const QVector< double > &key, const QVector< double > &value) |
void | moveBelow (QCPBars *bars) |
void | moveAbove (QCPBars *bars) |
void | addData (const QCPBarDataMap &dataMap) |
void | addData (const QCPBarData &data) |
void | addData (double key, double value) |
void | addData (const QVector< double > &keys, const QVector< double > &values) |
void | removeDataBefore (double key) |
void | removeDataAfter (double key) |
void | removeData (double fromKey, double toKey) |
void | removeData (double key) |
virtual void | clearData () |
virtual double | selectTest (const QPointF &pos) const |
QString | name () const |
bool | antialiasedFill () const |
bool | antialiasedScatters () const |
bool | antialiasedErrorBars () const |
QPen | pen () const |
QPen | selectedPen () const |
QBrush | brush () const |
QBrush | selectedBrush () const |
QCPAxis * | keyAxis () const |
QCPAxis * | valueAxis () const |
bool | selectable () const |
bool | selected () const |
void | setName (const QString &name) |
void | setAntialiasedFill (bool enabled) |
void | setAntialiasedScatters (bool enabled) |
void | setAntialiasedErrorBars (bool enabled) |
void | setPen (const QPen &pen) |
void | setSelectedPen (const QPen &pen) |
void | setBrush (const QBrush &brush) |
void | setSelectedBrush (const QBrush &brush) |
void | setKeyAxis (QCPAxis *axis) |
void | setValueAxis (QCPAxis *axis) |
void | setSelectable (bool selectable) |
void | setSelected (bool selected) |
void | rescaleAxes (bool onlyEnlarge=false) const |
void | rescaleKeyAxis (bool onlyEnlarge=false) const |
void | rescaleValueAxis (bool onlyEnlarge=false) const |
virtual bool | addToLegend () |
virtual bool | removeFromLegend () const |
bool | visible () const |
QCustomPlot * | parentPlot () const |
QCPLayer * | layer () const |
bool | antialiased () const |
void | setVisible (bool on) |
bool | setLayer (QCPLayer *layer) |
bool | setLayer (const QString &layerName) |
void | setAntialiased (bool enabled) |
Signals | |
void | selectionChanged (bool selected) |
Protected Types | |
enum | SignDomain |
Protected Functions | |
virtual void | draw (QCPPainter *painter) |
virtual void | drawLegendIcon (QCPPainter *painter, const QRect &rect) const |
QPolygonF | getBarPolygon (double key, double value) const |
double | getBaseValue (double key, bool positive) const |
virtual QCPRange | getKeyRange (bool &validRange, SignDomain inSignDomain=sdBoth) const |
virtual QCPRange | getValueRange (bool &validRange, SignDomain inSignDomain=sdBoth) const |
virtual QRect | clipRect () const |
void | coordsToPixels (double key, double value, double &x, double &y) const |
const QPointF | coordsToPixels (double key, double value) const |
void | pixelsToCoords (double x, double y, double &key, double &value) const |
void | pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const |
QPen | mainPen () const |
QBrush | mainBrush () const |
void | applyDefaultAntialiasingHint (QCPPainter *painter) const |
void | applyFillAntialiasingHint (QCPPainter *painter) const |
void | applyScattersAntialiasingHint (QCPPainter *painter) const |
void | applyErrorBarsAntialiasingHint (QCPPainter *painter) const |
double | distSqrToLine (const QPointF &start, const QPointF &end, const QPointF &point) const |
bool | moveToLayer (QCPLayer *layer, bool prepend) |
void | applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const |
Protected Static Functions | |
static void | connectBars (QCPBars *lower, QCPBars *upper) |
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).
Bar charts are stackable. This means, Two QCPBars plottables can be placed on top of each other (see QCPBars::moveAbove). Then, when two bars are at the same key position, they will appear stacked.
Like all data representing objects in QCustomPlot, the QCPBars is a plottable (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies (QCustomPlot::plottable, QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.)
Usually, you first create an instance:
add it to the customPlot with QCustomPlot::addPlottable:
customPlot->addPlottable(newBars);
and then modify the properties of the newly created plottable, e.g.:
enum QCPAbstractPlottable::SignDomain [protected, inherited] |
Represents negative and positive sign domain for passing to getKeyRange and getValueRange.
QCPBars::QCPBars | ( | QCPAxis * | keyAxis, |
QCPAxis * | valueAxis | ||
) | [explicit] |
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 constructed QCPBars can be added to the plot with QCustomPlot::addPlottable, QCustomPlot then takes ownership of the bar chart.
QCPBars * QCPBars::barBelow | ( | ) | const [inline] |
QCPBars * QCPBars::barAbove | ( | ) | const [inline] |
void QCPBars::setWidth | ( | double | width | ) |
Sets the width of the bars in plot (key) coordinates.
void QCPBars::setData | ( | QCPBarDataMap * | data, |
bool | copy = false |
||
) |
Replaces the current data with the provided data.
If copy is set to true, data points in data will only be copied. if false, the plottable takes ownership of the passed data and replaces the internal data pointer with it. This is significantly faster than copying for large datasets.
void QCPBars::setData | ( | const QVector< double > & | key, |
const QVector< double > & | value | ||
) |
This is an overloaded function.
Replaces the current data with the provided points in key and value tuples. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.
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.
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 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.
void QCPBars::addData | ( | const QCPBarDataMap & | dataMap | ) |
Adds the provided data points in dataMap to the current data.
void QCPBars::addData | ( | const QCPBarData & | data | ) |
This is an overloaded function.
Adds the provided single data point in data to the current data.
void QCPBars::addData | ( | double | key, |
double | value | ||
) |
This is an overloaded function.
Adds the provided single data point as key and value tuple to the current data
void QCPBars::addData | ( | const QVector< double > & | keys, |
const QVector< double > & | values | ||
) |
This is an overloaded function.
Adds the provided data points as key and value tuples to the current data.
void QCPBars::removeDataBefore | ( | double | key | ) |
void QCPBars::removeDataAfter | ( | double | key | ) |
void QCPBars::removeData | ( | double | fromKey, |
double | toKey | ||
) |
Removes all data points with key between fromKey and toKey. if fromKey is greater or equal to toKey, the function does nothing. To remove a single data point with known key, use removeData(double key).
void QCPBars::removeData | ( | double | key | ) |
This is an overloaded function.
Removes a single data point at key. If the position is not known with absolute precision, consider using removeData(double fromKey, double toKey) with a small fuzziness interval around the suspected position, depeding on the precision with which the key is known.
void QCPBars::clearData | ( | ) | [virtual] |
Removes all data points.
Implements QCPAbstractPlottable.
double QCPBars::selectTest | ( | const QPointF & | pos | ) | const [virtual] |
This function is used to decide whether a click hits a plottable 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 plottable (e.g. to the scatters/lines of a graph). If the plottable is either invisible, contains no data or the distance couldn't be determined, -1.0 is returned. setSelectable has no influence on the return value of this function.
If the plottable is represented not by single lines but by an area like QCPBars or QCPStatisticalBox, a click inside the area returns a constant value greater zero (typically 99% of the selectionTolerance of the parent QCustomPlot). If the click lies outside the area, this function returns -1.0.
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.
Implements QCPAbstractPlottable.
void QCPBars::draw | ( | QCPPainter * | painter | ) | [protected, virtual] |
Draws this plottable with the provided painter. Called by QCustomPlot::draw on all its visible plottables.
The cliprect of the provided painter is set to the axis rect of the key/value axis of this plottable (what clipRect returns), before this function is called.
Implements QCPAbstractPlottable.
void QCPBars::drawLegendIcon | ( | QCPPainter * | painter, |
const QRect & | rect | ||
) | const [protected, virtual] |
called by QCPLegend::draw (via QCPPlottableLegendItem::draw) to create a graphical representation of this plottable inside rect, next to the plottable name.
Implements QCPAbstractPlottable.
QPolygonF QCPBars::getBarPolygon | ( | double | key, |
double | value | ||
) | const [protected] |
Returns the polygon of a single bar with key and value. The Polygon is open at the bottom and shifted according to the bar stacking (see moveAbove).
double QCPBars::getBaseValue | ( | double | key, |
bool | positive | ||
) | const [protected] |
This function is called to find at which value to start drawing the base of a bar at key, when it is stacked on top of another QCPBars (e.g. with moveAbove).
positive and negative bars are separated per stack (positive are stacked above 0-value upwards, negative are stacked below 0-value downwards). This can be indicated with positive. So if the bar for which we need the base value is negative, set positive to false.
void QCPBars::connectBars | ( | QCPBars * | lower, |
QCPBars * | upper | ||
) | [static, protected] |
Connects below and above to each other via their mBarAbove/mBarBelow properties. The bar(s) currently below lower and upper will become disconnected to lower/upper.
If lower is zero, upper will be disconnected at the bottom. If upper is zero, lower will be disconnected at the top.
QCPRange QCPBars::getKeyRange | ( | bool & | validRange, |
SignDomain | inSignDomain = sdBoth |
||
) | const [protected, virtual] |
called by rescaleAxes functions to get the full data key bounds. For logarithmic plots, one can set inSignDomain to either sdNegative or sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to sdBoth (default). validRange is an output parameter that indicates whether a proper range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).
Implements QCPAbstractPlottable.
QCPRange QCPBars::getValueRange | ( | bool & | validRange, |
SignDomain | inSignDomain = sdBoth |
||
) | const [protected, virtual] |
called by rescaleAxes functions to get the full data value bounds. For logarithmic plots, one can set inSignDomain to either sdNegative or sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to sdBoth (default). validRange is an output parameter that indicates whether a proper range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).
Implements QCPAbstractPlottable.
void QCPAbstractPlottable::setName | ( | const QString & | name | ) | [inherited] |
The name is the textual representation of this plottable as it is displayed in the QCPLegend of the parent QCustomPlot. It may contain any utf-8 characters, including newlines.
void QCPAbstractPlottable::setAntialiasedFill | ( | bool | enabled | ) | [inherited] |
Sets whether fills of this plottable is drawn antialiased or not.
Note that this setting may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.
void QCPAbstractPlottable::setAntialiasedScatters | ( | bool | enabled | ) | [inherited] |
Sets whether the scatter symbols of this plottable are drawn antialiased or not.
Note that this setting may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.
void QCPAbstractPlottable::setAntialiasedErrorBars | ( | bool | enabled | ) | [inherited] |
Sets whether the error bars of this plottable are drawn antialiased or not.
Note that this setting may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.
void QCPAbstractPlottable::setPen | ( | const QPen & | pen | ) | [inherited] |
void QCPAbstractPlottable::setSelectedPen | ( | const QPen & | pen | ) | [inherited] |
When the plottable is selected, this pen is used to draw basic lines instead of the normal pen set via setPen.
void QCPAbstractPlottable::setBrush | ( | const QBrush & | brush | ) | [inherited] |
void QCPAbstractPlottable::setSelectedBrush | ( | const QBrush & | brush | ) | [inherited] |
When the plottable is selected, this brush is used to draw fills instead of the normal brush set via setBrush.
void QCPAbstractPlottable::setKeyAxis | ( | QCPAxis * | axis | ) | [inherited] |
The key axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal to the plottable's value axis. This function performs no checks to make sure this is the case. The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and the y-axis (QCustomPlot::yAxis) as value axis.
Normally, the key and value axes are set in the constructor of the plottable (or QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface).
void QCPAbstractPlottable::setValueAxis | ( | QCPAxis * | axis | ) | [inherited] |
The value axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal to the plottable's key axis. This function performs no checks to make sure this is the case. The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and the y-axis (QCustomPlot::yAxis) as value axis.
Normally, the key and value axes are set in the constructor of the plottable (or QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface).
void QCPAbstractPlottable::setSelectable | ( | bool | selectable | ) | [inherited] |
Sets whether the user can (de-)select this plottable by clicking on the QCustomPlot surface. (When QCustomPlot::setInteractions contains iSelectPlottables.)
However, even when selectable was set to false, it is possible to set the selection manually, by calling setSelected directly.
void QCPAbstractPlottable::setSelected | ( | bool | selected | ) | [inherited] |
Sets whether this plottable is selected or not. When selected, it uses a different pen and brush to draw its lines and fills, see setSelectedPen and setSelectedBrush.
The entire selection mechanism for plottables is handled automatically when QCustomPlot::setInteractions contains iSelectPlottables. You only need to call this function when you wish to change the selection state manually.
This function can change the selection state even when setSelectable was set to false.
emits the selectionChanged signal when selected is different from the previous selection state.
void QCPAbstractPlottable::rescaleAxes | ( | bool | onlyEnlarge = false | ) | const [inherited] |
Rescales the key and value axes associated with this plottable to contain all displayed data, so the whole plottable is visible. If the scaling of an axis is logarithmic, rescaleAxes will make sure not to rescale to an illegal range i.e. a range containing different signs and/or zero. Instead it will stay in the current sign domain and ignore all parts of the plottable that lie outside of that domain.
onlyEnlarge makes sure the ranges are only expanded, never reduced. So it's possible to show multiple plottables in their entirety by multiple calls to rescaleAxes where the first call has onlyEnlarge set to false (the default), and all subsequent set to true.
void QCPAbstractPlottable::rescaleKeyAxis | ( | bool | onlyEnlarge = false | ) | const [inherited] |
Rescales the key axis of the plottable so the whole plottable is visible.
See rescaleAxes for detailed behaviour.
void QCPAbstractPlottable::rescaleValueAxis | ( | bool | onlyEnlarge = false | ) | const [inherited] |
Rescales the value axis of the plottable so the whole plottable is visible.
See rescaleAxes for detailed behaviour.
bool QCPAbstractPlottable::addToLegend | ( | ) | [virtual, inherited] |
Adds this plottable to the legend of the parent QCustomPlot.
Normally, a QCPPlottableLegendItem is created and inserted into the legend. If the plottable needs a more specialized representation in the plot, this function will take this into account and instead create the specialized subclass of QCPAbstractLegendItem.
Returns true on success, i.e. when a legend item associated with this plottable isn't already in the legend.
bool QCPAbstractPlottable::removeFromLegend | ( | ) | const [virtual, inherited] |
Removes the plottable from the legend of the parent QCustomPlot. This means the QCPAbstractLegendItem (usually a QCPPlottableLegendItem) that is associated with this plottable is removed.
Returns true on success, i.e. if a legend item associated with this plottable was found and removed from the legend.
void QCPAbstractPlottable::selectionChanged | ( | bool | selected | ) | [signal, inherited] |
This signal is emitted when the selection state of this plottable has changed, either by user interaction or by a direct call to setSelected.
QRect QCPAbstractPlottable::clipRect | ( | ) | const [protected, virtual, inherited] |
Returns the clipping rectangle of this layerable object. By default, this is the viewport of the parent QCustomPlot. Specific subclasses may reimplement this function to provide different clipping rects.
The returned clipping rect is set on the painter before the draw function of the respective object is called.
Reimplemented from QCPLayerable.
void QCPAbstractPlottable::coordsToPixels | ( | double | key, |
double | value, | ||
double & | x, | ||
double & | y | ||
) | const [protected, inherited] |
Convenience function for transforming a key/value pair to pixels on the QCustomPlot surface, taking the orientations of the axes associated with this plottable into account (e.g. whether key represents x or y).
key and value are transformed to the coodinates in pixels and are written to x and y.
const QPointF QCPAbstractPlottable::coordsToPixels | ( | double | key, |
double | value | ||
) | const [protected, inherited] |
This is an overloaded function.
Returns the input as pixel coordinates in a QPointF.
void QCPAbstractPlottable::pixelsToCoords | ( | double | x, |
double | y, | ||
double & | key, | ||
double & | value | ||
) | const [protected, inherited] |
Convenience function for transforming a x/y pixel pair on the QCustomPlot surface to plot coordinates, taking the orientations of the axes associated with this plottable into account (e.g. whether key represents x or y).
x and y are transformed to the plot coodinates and are written to key and value.
void QCPAbstractPlottable::pixelsToCoords | ( | const QPointF & | pixelPos, |
double & | key, | ||
double & | value | ||
) | const [protected, inherited] |
This is an overloaded function.
Returns the pixel input pixelPos as plot coordinates key and value.
QPen QCPAbstractPlottable::mainPen | ( | ) | const [protected, inherited] |
Returns the pen that should be used for drawing lines of the plottable. Returns mPen when the graph is not selected and mSelectedPen when it is.
QBrush QCPAbstractPlottable::mainBrush | ( | ) | const [protected, inherited] |
Returns the brush that should be used for drawing fills of the plottable. Returns mBrush when the graph is not selected and mSelectedBrush when it is.
void QCPAbstractPlottable::applyDefaultAntialiasingHint | ( | QCPPainter * | painter | ) | const [protected, virtual, inherited] |
A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable lines.
This is the antialiasing state the painter passed to the draw method is in by default.
This function takes into account the local setting of the antialiasing flag as well as the overrides set e.g. with QCustomPlot::setNotAntialiasedElements.
Implements QCPLayerable.
void QCPAbstractPlottable::applyFillAntialiasingHint | ( | QCPPainter * | painter | ) | const [protected, inherited] |
A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable fills.
This function takes into account the local setting of the fill antialiasing flag as well as the overrides set e.g. with QCustomPlot::setNotAntialiasedElements.
void QCPAbstractPlottable::applyScattersAntialiasingHint | ( | QCPPainter * | painter | ) | const [protected, inherited] |
A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable scatter points.
This function takes into account the local setting of the scatters antialiasing flag as well as the overrides set e.g. with QCustomPlot::setNotAntialiasedElements.
void QCPAbstractPlottable::applyErrorBarsAntialiasingHint | ( | QCPPainter * | painter | ) | const [protected, inherited] |
A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable error bars.
This function takes into account the local setting of the error bars antialiasing flag as well as the overrides set e.g. with QCustomPlot::setNotAntialiasedElements.
double QCPAbstractPlottable::distSqrToLine | ( | const QPointF & | start, |
const QPointF & | end, | ||
const QPointF & | point | ||
) | const [protected, inherited] |
Finds the shortest squared distance of point to the line segment defined by start and end.
This function may be used to help with the implementation of the selectTest function for specific plottables.
void QCPLayerable::setVisible | ( | bool | on | ) | [inherited] |
Sets the visibility of this layerable object. If an object is not visible, it will not be drawn on the QCustomPlot surface, and user interaction with it (e.g. click/selection) is not possible.
bool QCPLayerable::setLayer | ( | QCPLayer * | layer | ) | [inherited] |
Sets the layer of this layerable object. The object will be placed on top of the other objects already on layer.
Returns true on success, i.e. if layer is a valid layer.
bool QCPLayerable::setLayer | ( | const QString & | layerName | ) | [inherited] |
This is an overloaded function.
Sets the layer of this layerable object by name
Returns true on success, i.e. if layerName is a valid layer name.
void QCPLayerable::setAntialiased | ( | bool | enabled | ) | [inherited] |
Sets whether this object will be drawn antialiased or not.
Note that antialiasing settings may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.
bool QCPLayerable::moveToLayer | ( | QCPLayer * | layer, |
bool | prepend | ||
) | [protected, inherited] |
Moves this layerable object to layer. If prepend is true, this object will be prepended to the new layer's list, i.e. it will be drawn below the objects already on the layer. If it is false, the object will be appended.
Returns true on success, i.e. if layer is a valid layer.
void QCPLayerable::applyAntialiasingHint | ( | QCPPainter * | painter, |
bool | localAntialiased, | ||
QCP::AntialiasedElement | overrideElement | ||
) | const [protected, inherited] |
Sets the QPainter::Antialiasing render hint on the provided painter, depending on the localAntialiased value as well as the overrides QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements. Which override enum this function takes into account is controlled via overrideElement.