A plottable representing a bar chart in a plot. More...

#include <qcustomplot.h>

Public Slots
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 ()

Public Slots inherited from QCPAbstractPlottable
QCustomPlot *	parentPlot () const

QString	name () const

bool	visible () const

QPen	pen () const

QBrush	brush () const

QCPAxis *	keyAxis () const

QCPAxis *	valueAxis () const

void	setName (const QString &name)

void	setVisible (bool visible)

void	setPen (const QPen &pen)

void	setBrush (const QBrush &brush)

void	setKeyAxis (QCPAxis *axis)

void	setValueAxis (QCPAxis *axis)

void	rescaleAxes (bool onlyEnlarge=false) const

void	rescaleKeyAxis (bool onlyEnlarge=false) const

void	rescaleValueAxis (bool onlyEnlarge=false) const

virtual void	clearData ()=0

virtual bool	addToLegend () const

virtual bool	removeFromLegend () const

Public Member Functions
	QCPBars (QCPAxis keyAxis, QCPAxis valueAxis)

virtual	~QCPBars ()

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

virtual	~QCPAbstractPlottable ()

Protected Member Functions
virtual void	draw (QPainter *painter) const

virtual void	drawLegendIcon (QPainter *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

Protected Member Functions inherited from QCPAbstractPlottable
void	coordsToPixels (double key, double value, double &x, double &y) const

const QPointF	coordsToPixels (double key, double value) const

Static Protected Member Functions
static void	connectBars (QCPBars lower, QCPBars upper)

Protected Attributes
QCPBarDataMap *	mData

double	mWidth

QCPBars *	mBarBelow

QCPBars *	mBarAbove

Protected Attributes inherited from QCPAbstractPlottable
QCustomPlot *	mParentPlot

QString	mName

bool	mVisible

QPen	mPen

QBrush	mBrush

QCPAxis *	mKeyAxis

QCPAxis *	mValueAxis

Friends
class	QCustomPlot

class	QCPLegend

Additional Inherited Members
Protected Types inherited from QCPAbstractPlottable
enum	SignDomain { SDNegative, SDBoth, SDPositive }

Detailed Description

A plottable representing a bar chart in a plot.

To plot data, assign it with the setData or addData functions.

Changing the appearance

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 ontop of eachother (see QCPBars::moveAbove). Then, when two bars are at the same key position, they will appear stacked.

Usage

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:

QCPBars *newBars = new QCPBars(customPlot->xAxis, customPlot->yAxis);

add it to the customPlot with QCustomPlot::addPlottable:

customPlot->addPlottable(newBars);

and then modify the properties of the newly created plottable, e.g.:

newBars->setName("Country population");

newBars->setData(xData, yData);

Definition at line 372 of file qcustomplot.h.

Constructor & Destructor Documentation

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 both reside in the same QCustomPlot.

The constructed QCPBars can be added to the plot with QCustomPlot::addPlottable, QCustomPlot then takes ownership of the bar chart.

Definition at line 7081 of file qcustomplot.cc.

                                                      :
   QCPAbstractPlottable(keyAxis, valueAxis),
   mBarBelow(0),
   mBarAbove(0)
 {
   mData = new QCPBarDataMap;
   mPen.setColor(Qt::blue);
   mPen.setStyle(Qt::SolidLine);
   mBrush.setColor(QColor(40, 50, 255, 30));
   mBrush.setStyle(Qt::SolidPattern);
   mWidth = 0.75;
 }

QCPBars::~QCPBars ( )

virtual

Definition at line 7094 of file qcustomplot.cc.

 {
   if (mBarBelow || mBarAbove)
     connectBars(mBarBelow, mBarAbove); // take this bar out of any stacking
   delete mData;
 }

Member Function Documentation

void QCPBars::addData ( const QCPBarDataMap & dataMap )

slot

Adds the provided data points in dataMap to the current data.

See also: removeData

Definition at line 7218 of file qcustomplot.cc.

 {
   mData->unite(dataMap);
 }

void QCPBars::addData ( const QCPBarData & data )

slot

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 single data point in data to the current data.

See also: removeData

Definition at line 7227 of file qcustomplot.cc.

 {
   mData->insertMulti(data.key, data);
 }

void QCPBars::addData	(	double	key,
		double	value
	)

slot

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 single data point as key and value tuple to the current data

See also: removeData

Definition at line 7236 of file qcustomplot.cc.

 {
   QCPBarData newData;
   newData.key = key;
   newData.value = value;
   mData->insertMulti(newData.key, newData);
 }

void QCPBars::addData	(	const QVector< double > &	keys,
		const QVector< double > &	values
	)

slot

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 points as key and value tuples to the current data.

See also: removeData

Definition at line 7248 of file qcustomplot.cc.

 {
   int n = keys.size();
   n = qMin(n, values.size());
   QCPBarData newData;
   for (int i=0; i<n; ++i)
   {
     newData.key = keys[i];
     newData.value = values[i];
     mData->insertMulti(newData.key, newData);
   }
 }

QCPBars * QCPBars::barAbove ( ) const

inlineslot

Returns the bars plottable that is directly above this bars plottable. If there is no such plottable, returns 0.

See also: barBelow, moveBelow, moveAbove

Definition at line 383 of file qcustomplot.h.

383 { return mBarAbove; }

QCPBars::mBarAbove

QCPBars * mBarAbove

Definition: qcustomplot.h:407

QCPBars * QCPBars::barBelow ( ) const

inlineslot

Returns the bars plottable that is directly below this bars plottable. If there is no such plottable, returns 0.

See also: barAbove, moveBelow, moveAbove

Definition at line 382 of file qcustomplot.h.

382 { return mBarBelow; }

QCPBars::mBarBelow

QCPBars * mBarBelow

Definition: qcustomplot.h:407

void QCPBars::clearData ( )

virtualslot

Removes all data points.

See also: removeData, removeDataAfter, removeDataBefore

Definition at line 7317 of file qcustomplot.cc.

 {
   mData->clear();
 }

void QCPBars::connectBars	(	QCPBars *	lower,
		QCPBars *	upper
	)

staticprotected

Definition at line 7419 of file qcustomplot.cc.

 {
   if (!lower && !upper) return;
   
   if (!lower) // disconnect upper at bottom
   {
     // disconnect old bar below upper:
     if (upper->mBarBelow && upper->mBarBelow->mBarAbove == upper)
       upper->mBarBelow->mBarAbove = 0;
     upper->mBarBelow = 0;
   } else if (!upper) // disconnect lower at top
   {
     // disconnect old bar above lower:
     if (lower->mBarAbove && lower->mBarAbove->mBarBelow == lower)
       lower->mBarAbove->mBarBelow = 0;
     lower->mBarAbove = 0;
   } else // connect lower and upper
   {
     // disconnect old bar above lower:
     if (lower->mBarAbove && lower->mBarAbove->mBarBelow == lower)
       lower->mBarAbove->mBarBelow = 0;
     // disconnect old bar below upper:
     if (upper->mBarBelow && upper->mBarBelow->mBarAbove == upper)
       upper->mBarBelow->mBarAbove = 0;
     lower->mBarAbove = upper;
     upper->mBarBelow = lower;
   }
 }

const QCPBarDataMap* QCPBars::data ( ) const

inlineslot

Definition at line 384 of file qcustomplot.h.

384 { return mData; }

QCPBars::mData

QCPBarDataMap * mData

Definition: qcustomplot.h:405

void QCPBars::draw ( QPainter * painter ) const

protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 7323 of file qcustomplot.cc.

 {
   if (!mVisible || mData->isEmpty()) return;
   painter->setClipRect(mKeyAxis->axisRect().united(mValueAxis->axisRect()));
   
   QCPBarDataMap::const_iterator it;
   for (it = mData->constBegin(); it != mData->constEnd(); ++it)
   {
     if (it.key()+mWidth*0.5 < mKeyAxis->range().lower || it.key()-mWidth*0.5 > mKeyAxis->range().upper)
       continue;
     QPolygonF barPolygon = getBarPolygon(it.key(), it.value().value);
     // draw bar fill:
     if (mBrush.style() != Qt::NoBrush && mBrush.color().alpha() != 0)
     {
       painter->setRenderHint(QPainter::Antialiasing, mParentPlot->antialiasedElements().testFlag(QCustomPlot::AEFills));
       painter->setPen(Qt::NoPen);
       painter->setBrush(mBrush);
       painter->drawPolygon(barPolygon);
     }
     // draw bar line:
     if (mPen.style() != Qt::NoPen && mPen.color().alpha() != 0)
     {
       painter->setRenderHint(QPainter::Antialiasing, mParentPlot->antialiasedElements().testFlag(QCustomPlot::AEGraphs));
       painter->setPen(mPen);
       painter->setBrush(Qt::NoBrush);
       painter->drawPolyline(barPolygon);
     }
   }
 }

void QCPBars::drawLegendIcon	(	QPainter *	painter,
		const QRect &	rect
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 7354 of file qcustomplot.cc.

 {
   // draw filled rect:
   painter->setBrush(mBrush);
   painter->setPen(mPen);
   painter->setRenderHint(QPainter::Antialiasing, mParentPlot->antialiasedElements().testFlag(QCustomPlot::AEGraphs));
   QRect r = QRect(0, 0, rect.width()*0.67, rect.height()*0.67);
   r.moveCenter(rect.center());
   painter->drawRect(r);
 }

QPolygonF QCPBars::getBarPolygon	(	double	key,
		double	value
	)		const

protected

Definition at line 7370 of file qcustomplot.cc.

 {
   QPolygonF result;
   double baseValue = getBaseValue(key, value >= 0); // calculates base value dependant on stacking
   result << coordsToPixels(key-mWidth*0.5, baseValue);
   result << coordsToPixels(key-mWidth*0.5, baseValue+value);
   result << coordsToPixels(key+mWidth*0.5, baseValue+value);
   result << coordsToPixels(key+mWidth*0.5, baseValue);
   return result;
 }

double QCPBars::getBaseValue	(	double	key,
		bool	positive
	)		const

protected

Definition at line 7390 of file qcustomplot.cc.

 {
   if (mBarBelow)
   {
     double max = 0;
     // find bars of mBarBelow that are approximately at key and find largest one:
     QCPBarDataMap::const_iterator it = mBarBelow->mData->lowerBound(key-mWidth*0.1);
     QCPBarDataMap::const_iterator itEnd = mBarBelow->mData->upperBound(key+mWidth*0.1);
     while (it != itEnd)
     {
       if ((positive && it.value().value > max) ||
           (!positive && it.value().value < max))
         max = it.value().value;
       ++it;
     }
     // recurse down the bar-stack to find the total height:
     return max + mBarBelow->getBaseValue(key, positive);
   } else
     return 0;
 }

QCPRange QCPBars::getKeyRange	(	bool &	validRange,
		SignDomain	inSignDomain = `SDBoth`
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 7449 of file qcustomplot.cc.

 {
   QCPRange range;
   bool haveLower = false;
   bool haveUpper = false;
   
   double current;
   double barWidthHalf = mWidth*0.5;
   QCPBarDataMap::const_iterator it = mData->constBegin();
   while (it != mData->constEnd())
   {
     current = it.value().key;
     if (inSignDomain == SDBoth || (inSignDomain == SDNegative && current+barWidthHalf < 0) || (inSignDomain == SDPositive && current-barWidthHalf > 0))
     {
       if (current-barWidthHalf < range.lower || !haveLower)
       {
         range.lower = current-barWidthHalf;
         haveLower = true;
       }
       if (current+barWidthHalf > range.upper || !haveUpper)
       {
         range.upper = current+barWidthHalf;
         haveUpper = true;
       }
     }
     ++it;
   }
   
   validRange = haveLower && haveUpper;
   return range;
 }

QCPRange QCPBars::getValueRange	(	bool &	validRange,
		SignDomain	inSignDomain = `SDBoth`
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 7482 of file qcustomplot.cc.

 {
   QCPRange range;
   bool haveLower = true; // set to true, because 0 should always be visible in bar charts
   bool haveUpper = true; // set to true, because 0 should always be visible in bar charts
   
   double current;
   
   QCPBarDataMap::const_iterator it = mData->constBegin();
   while (it != mData->constEnd())
   {
     current = it.value().value + getBaseValue(it.value().key, it.value().value >= 0);
     if (inSignDomain == SDBoth || (inSignDomain == SDNegative && current < 0) || (inSignDomain == SDPositive && current > 0))
     {
       if (current < range.lower || !haveLower)
       {
         range.lower = current;
         haveLower = true;
       }
       if (current > range.upper || !haveUpper)
       {
         range.upper = current;
         haveUpper = true;
       }
     }
     ++it;
   }
   
   validRange = !qFuzzyCompare(range.lower+1.0, range.upper+1.0);
   return range;
 }

void QCPBars::moveAbove ( QCPBars * bars )

slot

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 ontop of each other after the operation.

To remove this bars plottable from any stacking, set bars to 0.

See also: moveBelow, barBelow, barAbove

Definition at line 7195 of file qcustomplot.cc.

 {
   if (bars == this) return;
   if (bars && (bars->keyAxis() != mKeyAxis || bars->valueAxis() != mValueAxis))
   {
     qDebug() << FUNCNAME << "passed QCPBars* doesn't have same key and value axis as this QCPBars";
     return;
   }
   // remove from stacking:
   connectBars(mBarBelow, mBarAbove); // Note: also works if one (or both) of them is 0
   // if new bar given, insert this bar above it:
   if (bars)
   {
     if (bars->mBarAbove)
       connectBars(this, bars->mBarAbove);
     connectBars(bars, this);
   }
 }

void QCPBars::moveBelow ( QCPBars * bars )

slot

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 ontop of each other after the operation.

To remove this bars plottable from any stacking, set bars to 0.

See also: moveBelow, barAbove, barBelow

Definition at line 7162 of file qcustomplot.cc.

 {
   if (bars == this) return;
   if (bars->keyAxis() != mKeyAxis || bars->valueAxis() != mValueAxis)
   {
     qDebug() << FUNCNAME << "passed QCPBars* doesn't have same key and value axis as this QCPBars";
     return;
   }
   // remove from stacking:
   connectBars(mBarBelow, mBarAbove); // Note: also works if one (or both) of them is 0
   // if new bar given, insert this bar below it:
   if (bars)
   {
     if (bars->mBarBelow)
       connectBars(bars->mBarBelow, this);
     connectBars(this, bars);
   }
 }

void QCPBars::removeData	(	double	fromKey,
		double	toKey
	)

slot

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).

See also: addData, clearData

Definition at line 7291 of file qcustomplot.cc.

 {
   if (fromKey >= toKey || mData->isEmpty()) return;
   QCPBarDataMap::iterator it = mData->upperBound(fromKey);
   QCPBarDataMap::iterator itEnd = mData->upperBound(toKey);
   while (it != itEnd)
     it = mData->erase(it);
 }

void QCPBars::removeData ( double key )

slot

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

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.

See also: addData, clearData

Definition at line 7308 of file qcustomplot.cc.

 {
   mData->remove(key);
 }

void QCPBars::removeDataAfter ( double key )

slot

Removes all data points with key greater than key.

See also: addData, clearData

Definition at line 7276 of file qcustomplot.cc.

 {
   if (mData->isEmpty()) return;
   QCPBarDataMap::iterator it = mData->upperBound(key);
   while (it != mData->end())
     it = mData->erase(it);
 }

void QCPBars::removeDataBefore ( double key )

slot

Removes all data points with key smaller than key.

See also: addData, clearData

Definition at line 7265 of file qcustomplot.cc.

 {
   QCPBarDataMap::iterator it = mData->begin();
   while (it != mData->end() && it.key() < key)
     it = mData->erase(it);
 }

void QCPBars::setData	(	QCPBarDataMap *	data,
		bool	copy = `false`
	)

slot

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.

Definition at line 7116 of file qcustomplot.cc.

 {
   if (copy)
   {
     *mData = *data;
   } else
   {
     delete mData;
     mData = data;
   }
 }

void QCPBars::setData	(	const QVector< double > &	key,
		const QVector< double > &	value
	)

slot

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 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.

Definition at line 7134 of file qcustomplot.cc.

 {
   mData->clear();
   int n = key.size();
   n = qMin(n, value.size());
   QCPBarData newData;
   for (int i=0; i<n; ++i)
   {
     newData.key = key[i];
     newData.value = value[i];
     mData->insertMulti(newData.key, newData);
   }
 }

void QCPBars::setWidth ( double width )

slot

Sets the width of the bars in plot (key) coordinates.

Definition at line 7104 of file qcustomplot.cc.

 {
   mWidth = width;
 }

double QCPBars::width ( ) const

inlineslot

Definition at line 381 of file qcustomplot.h.

381 { return mWidth; }

QCPBars::mWidth

double mWidth

Definition: qcustomplot.h:406

Friends And Related Function Documentation

friend class QCPLegend

friend

Definition at line 419 of file qcustomplot.h.

friend class QCustomPlot

friend

Definition at line 418 of file qcustomplot.h.

Member Data Documentation

QCPBars * QCPBars::mBarAbove

protected

Definition at line 407 of file qcustomplot.h.

QCPBars* QCPBars::mBarBelow

protected

Definition at line 407 of file qcustomplot.h.

QCPBarDataMap* QCPBars::mData

protected

Definition at line 405 of file qcustomplot.h.

double QCPBars::mWidth

protected

Definition at line 406 of file qcustomplot.h.

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

/build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/plot2d/qcustomplot.h
/build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/plot2d/qcustomplot.cc

Public Slots

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Changing the appearance

Usage

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation