QCPBars Class Reference

Inheritance diagram for QCPBars:

Public Types
enum	WidthType { wtAbsolute , wtAxisRectRatio , wtPlotCoords }
Public Types inherited from QObject
typedef	QObjectList

Public Member Functions
	QCPBars (QCPAxis *keyAxis, QCPAxis *valueAxis)
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 override
virtual QCPRange	getKeyRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth) const override
virtual QCPRange	getValueRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth, const QCPRange &inKeyRange=QCPRange()) const override
void	moveAbove (QCPBars *bars)
void	moveBelow (QCPBars *bars)
virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=nullptr) const override
virtual QCPDataSelection	selectTestRect (const QRectF &rect, bool onlySelectable) const override
void	setBarsGroup (QCPBarsGroup *barsGroup)
void	setBaseValue (double baseValue)
void	setData (const QVector< double > &keys, const QVector< double > &values, bool alreadySorted=false)
void	setData (QSharedPointer< QCPBarsDataContainer > data)
void	setStackingGap (double pixels)
void	setWidth (double width)
void	setWidthType (WidthType widthType)
double	stackingGap () const
double	width () const
WidthType	widthType () const
Public Member Functions inherited from QCPAbstractPlottable1D< QCPBarsData >
	QCPAbstractPlottable1D (QCPAxis *keyAxis, QCPAxis *valueAxis)
virtual int	dataCount () const override
virtual double	dataMainKey (int index) const override
virtual double	dataMainValue (int index) const override
virtual double	dataSortKey (int index) const override
virtual QCPRange	dataValueRange (int index) const override
virtual int	findBegin (double sortKey, bool expandedRange=true) const override
virtual int	findEnd (double sortKey, bool expandedRange=true) const override
virtual QCPPlottableInterface1D *	interface1D () override
virtual bool	sortKeyIsMainKey () const override
Public Member Functions inherited from QCPAbstractPlottable
	QCPAbstractPlottable (QCPAxis *keyAxis, QCPAxis *valueAxis)
bool	addToLegend ()
bool	addToLegend (QCPLegend *legend)
bool	antialiasedFill () const
bool	antialiasedScatters () const
QBrush	brush () const
const QPointF	coordsToPixels (double key, double value) const
void	coordsToPixels (double key, double value, double &x, double &y) const
QCPAxis *	keyAxis () const
QString	name () const
QPen	pen () const
void	pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const
void	pixelsToCoords (double x, double y, double &key, double &value) const
bool	removeFromLegend () const
bool	removeFromLegend (QCPLegend *legend) const
void	rescaleAxes (bool onlyEnlarge=false) const
void	rescaleKeyAxis (bool onlyEnlarge=false) const
void	rescaleValueAxis (bool onlyEnlarge=false, bool inKeyRange=false) const
QCP::SelectionType	selectable () const
bool	selected () const
QCPDataSelection	selection () const
QCPSelectionDecorator *	selectionDecorator () const
void	setAntialiasedFill (bool enabled)
void	setAntialiasedScatters (bool enabled)
void	setBrush (const QBrush &brush)
void	setKeyAxis (QCPAxis *axis)
void	setName (const QString &name)
void	setPen (const QPen &pen)
Q_SLOT void	setSelectable (QCP::SelectionType selectable)
Q_SLOT void	setSelection (QCPDataSelection selection)
void	setSelectionDecorator (QCPSelectionDecorator *decorator)
void	setValueAxis (QCPAxis *axis)
QCPAxis *	valueAxis () const
Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=nullptr)
bool	antialiased () const
QCPLayer *	layer () const
QCPLayerable *	parentLayerable () const
QCustomPlot *	parentPlot () const
bool	realVisibility () const
void	setAntialiased (bool enabled)
bool	setLayer (const QString &layerName)
Q_SLOT bool	setLayer (QCPLayer *layer)
void	setVisible (bool on)
bool	visible () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const
Public Member Functions inherited from QCPPlottableInterface1D

Protected Member Functions
virtual void	draw (QCPPainter *painter) override
virtual void	drawLegendIcon (QCPPainter *painter, const QRectF &rect) const override
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
Protected Member Functions inherited from QCPAbstractPlottable1D< QCPBarsData >
void	drawPolyline (QCPPainter *painter, const QVector< QPointF > &lineData) const
void	getDataSegments (QList< QCPDataRange > &selectedSegments, QList< QCPDataRange > &unselectedSegments) const
Protected Member Functions inherited from QCPAbstractPlottable
void	applyDefaultAntialiasingHint (QCPPainter *painter) const override
void	applyFillAntialiasingHint (QCPPainter *painter) const
void	applyScattersAntialiasingHint (QCPPainter *painter) const
virtual QRect	clipRect () const override
virtual void	deselectEvent (bool *selectionStateChanged) override
virtual void	selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) override
virtual QCP::Interaction	selectionCategory () const override
Protected Member Functions inherited from QCPLayerable
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
void	initializeParentPlot (QCustomPlot *parentPlot)
virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)
virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)
virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)
virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)
bool	moveToLayer (QCPLayer *layer, bool prepend)
virtual void	parentPlotInitialized (QCustomPlot *parentPlot)
void	setParentLayerable (QCPLayerable *parentLayerable)
virtual void	wheelEvent (QWheelEvent *event)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

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
Protected Attributes inherited from QCPAbstractPlottable1D< QCPBarsData >
QSharedPointer< QCPDataContainer< QCPBarsData > >	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
Properties inherited from QObject
	objectName
Signals inherited from QCPAbstractPlottable
void	selectableChanged (QCP::SelectionType selectable)
void	selectionChanged (bool selected)
void	selectionChanged (const QCPDataSelection &selection)
Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Detailed Description

A plottable representing a 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). 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.

Usage

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

Member Enumeration Documentation

WidthType

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.

See also

setWidthType, setWidth

Enumerator
wtAbsolute	Bar width is in absolute pixels.
wtAxisRectRatio	Bar width is given by a fraction of the axis rect size.
wtPlotCoords	Bar width is in key coordinates and thus scales with the key axis range.

Definition at line 5832 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPBars()

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

~QCPBars()

QCPBars::~QCPBars ( )

overridevirtual

Definition at line 24461 of file qcustomplot.cpp.

Member Function Documentation

addData() [1/2]

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

addData() [2/2]

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

barAbove()

QCPBars * QCPBars::barAbove ( ) const

inline

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

See also

barBelow, moveBelow, moveAbove

Definition at line 5848 of file qcustomplot.h.

barBelow()

QCPBars * QCPBars::barBelow ( ) const

inline

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

See also

barAbove, moveBelow, moveAbove

Definition at line 5847 of file qcustomplot.h.

barsGroup()

QCPBarsGroup * QCPBars::barsGroup ( ) const

inline

Definition at line 5844 of file qcustomplot.h.

baseValue()

double QCPBars::baseValue ( ) const

inline

Definition at line 5845 of file qcustomplot.h.

connectBars()

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

staticprotected

Connects below and above to each other via their mBarAbove/mBarBelow properties. The bar(s) currently above lower and below 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.

Definition at line 25100 of file qcustomplot.cpp.

data()

QSharedPointer< QCPBarsDataContainer > QCPBars::data ( ) const

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

dataPixelPosition()

QPointF QCPBars::dataPixelPosition ( int index ) const

overridevirtual

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

draw()

void QCPBars::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 24844 of file qcustomplot.cpp.

drawLegendIcon()

void QCPBars::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 24893 of file qcustomplot.cpp.

getBarRect()

QRectF QCPBars::getBarRect ( double key, double value ) const

protected

Returns the rect in pixel coordinates of a single bar with the specified key and value. The rect is shifted according to the bar stacking (see moveAbove) and base value (see setBaseValue), and to have non-overlapping border lines with the bars stacked below.

Definition at line 24978 of file qcustomplot.cpp.

getKeyRange()

QCPRange QCPBars::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 24742 of file qcustomplot.cpp.

getPixelWidth()

void QCPBars::getPixelWidth ( double key, double & lower, double & upper ) const

protected

This function is used to determine the width of the bar at coordinate key, according to the specified width (setWidth) and width type (setWidthType).

The output parameters lower and upper return the number of pixels the bar extends to lower and higher keys, relative to the key coordinate (so with a non-reversed horizontal axis, lower is negative and upper positive).

Definition at line 25015 of file qcustomplot.cpp.

getStackedBaseValue()

double QCPBars::getStackedBaseValue ( 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 baseValue upwards, negative are stacked below baseValue downwards). This can be indicated with positive. So if the bar for which we need the base value is negative, set positive to false.

Definition at line 25065 of file qcustomplot.cpp.

getValueRange()

QCPRange QCPBars::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 24781 of file qcustomplot.cpp.

getVisibleDataBounds()

void QCPBars::getVisibleDataBounds ( QCPBarsDataContainer::const_iterator & begin, QCPBarsDataContainer::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 24918 of file qcustomplot.cpp.

moveAbove()

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

See also

moveBelow, barBelow, barAbove

Definition at line 24662 of file qcustomplot.cpp.

moveBelow()

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

See also

moveBelow, barAbove, barBelow

Definition at line 24629 of file qcustomplot.cpp.

selectTest()

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

overridevirtual

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

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

\seebaseclassmethod QCPAbstractPlottable::selectTest

Reimplemented from QCPAbstractPlottable1D< QCPBarsData >.

Definition at line 24712 of file qcustomplot.cpp.

selectTestRect()

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

overridevirtual

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

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

Note

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

Reimplemented from QCPAbstractPlottable1D< QCPBarsData >.

Definition at line 24684 of file qcustomplot.cpp.

setBarsGroup()

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

Definition at line 24535 of file qcustomplot.cpp.

setBaseValue()

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

setData() [1/2]

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.

See also

addData

Definition at line 24499 of file qcustomplot.cpp.

setData() [2/2]

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:

See also

addData

Definition at line 24483 of file qcustomplot.cpp.

setStackingGap()

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

setWidth()

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

setWidthType()

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.

See also

setWidth

Definition at line 24524 of file qcustomplot.cpp.

stackingGap()

double QCPBars::stackingGap ( ) const

inline

Definition at line 5846 of file qcustomplot.h.

width()

double QCPBars::width ( ) const

inline

Definition at line 5842 of file qcustomplot.h.

widthType()

WidthType QCPBars::widthType ( ) const

inline

Definition at line 5843 of file qcustomplot.h.

Member Data Documentation

mBarAbove

QPointer<QCPBars> QCPBars::mBarAbove

protected

Definition at line 5880 of file qcustomplot.h.

mBarBelow

QPointer<QCPBars> QCPBars::mBarBelow

protected

Definition at line 5880 of file qcustomplot.h.

mBarsGroup

QCPBarsGroup* QCPBars::mBarsGroup

protected

Definition at line 5877 of file qcustomplot.h.

mBaseValue

double QCPBars::mBaseValue

protected

Definition at line 5878 of file qcustomplot.h.

mStackingGap

double QCPBars::mStackingGap

protected

Definition at line 5879 of file qcustomplot.h.

mWidth

double QCPBars::mWidth

protected

Definition at line 5875 of file qcustomplot.h.

mWidthType

WidthType QCPBars::mWidthType

protected

Definition at line 5876 of file qcustomplot.h.

---

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

• qcustomplot.h
• qcustomplot.cpp