Groups multiple QCPBars together so they appear side by side. More...

#include <qcustomplot.h>

Inheritance diagram for QCPBarsGroup:

Public Types
enum	SpacingType { stAbsolute, stAxisRectRatio, stPlotCoords }

Public Member Functions
void	append (QCPBars *bars)

QList< QCPBars * >	bars () const

QCPBars *	bars (int index) const

void	clear ()

bool	contains (QCPBars *bars) const

void	insert (int i, QCPBars *bars)

bool	isEmpty () const

	QCPBarsGroup (QCustomPlot *parentPlot)

void	remove (QCPBars *bars)

void	setSpacing (double spacing)

void	setSpacingType (SpacingType spacingType)

int	size () const

double	spacing () const

SpacingType	spacingType () const

virtual	~QCPBarsGroup ()

Protected Member Functions
double	getPixelSpacing (const QCPBars *bars, double keyCoord)

double	keyPixelOffset (const QCPBars *bars, double keyCoord)

void	registerBars (QCPBars *bars)

void	unregisterBars (QCPBars *bars)

Protected Attributes
QList< QCPBars * >	mBars

QCustomPlot *	mParentPlot

double	mSpacing

SpacingType	mSpacingType

Friends
class	QCPBars

Detailed Description

Groups multiple QCPBars together so they appear side by side.

When showing multiple QCPBars in one plot which have bars at identical keys, it may be desirable to have them appearing next to each other at each key. This is what adding the respective QCPBars plottables to a QCPBarsGroup achieves. (An alternative approach is to stack them on top of each other, see QCPBars::moveAbove.)

Usage

To add a QCPBars plottable to the group, create a new group and then add the respective bars intances:

Alternatively to appending to the group like shown above, you can also set the group on the QCPBars plottable via QCPBars::setBarsGroup.

The spacing between the bars can be configured via setSpacingType and setSpacing. The bars in this group appear in the plot in the order they were appended. To insert a bars plottable at a certain index position, or to reposition a bars plottable which is already in the group, use insert.

To remove specific bars from the group, use either remove or call QCPBars::setBarsGroup(0) on the respective bars plottable.

To clear the entire group, call clear, or simply delete the group.

Example

The image above is generated with the following code:

Definition at line 5386 of file qcustomplot.h.

Member Enumeration Documentation

◆ SpacingType

enum QCPBarsGroup::SpacingType

Defines the ways the spacing between bars in the group can be specified. Thus it defines what the number passed to setSpacing actually means.

See also: setSpacingType, setSpacing

Enumerator
stAbsolute	Bar spacing is in absolute pixels.
stAxisRectRatio	Bar spacing is given by a fraction of the axis rect size.
stPlotCoords	Bar spacing is in key coordinates and thus scales with the key axis range.

Definition at line 5400 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPBarsGroup()

QCPBarsGroup::QCPBarsGroup ( QCustomPlot * parentPlot )

explicit

Constructs a new bars group for the specified QCustomPlot instance.

Definition at line 23236 of file qcustomplot.cpp.

◆ ~QCPBarsGroup()

QCPBarsGroup::~QCPBarsGroup ( )

virtual

Definition at line 23244 of file qcustomplot.cpp.

Member Function Documentation

◆ append()

void QCPBarsGroup::append ( QCPBars * bars )

Adds the specified bars plottable to this group. Alternatively, you can also use QCPBars::setBarsGroup on the bars instance.

See also: insert, remove

Definition at line 23307 of file qcustomplot.cpp.

◆ bars() [1/2]

QList< QCPBars * > QCPBarsGroup::bars ( ) const

inline

Returns all bars currently in this group.

See also: bars(int index)

Definition at line 5418 of file qcustomplot.h.

◆ bars() [2/2]

QCPBars * QCPBarsGroup::bars ( int index ) const

Returns the QCPBars instance with the specified index in this group. If no such QCPBars exists, returns 0.

See also: bars(), size

Definition at line 23278 of file qcustomplot.cpp.

◆ clear()

void QCPBarsGroup::clear ( )

Removes all QCPBars plottables from this group.

See also: isEmpty

Definition at line 23295 of file qcustomplot.cpp.

◆ contains()

bool QCPBarsGroup::contains ( QCPBars * bars ) const

inline

Returns whether the specified bars plottable is part of this group.

Definition at line 5423 of file qcustomplot.h.

◆ getPixelSpacing()

double QCPBarsGroup::getPixelSpacing	(	const QCPBars *	bars,
		double	keyCoord
	)

protected

Definition at line 23461 of file qcustomplot.cpp.

◆ insert()

void QCPBarsGroup::insert	(	int	i,
		QCPBars *	bars
	)

Inserts the specified bars plottable into this group at the specified index position i. This gives you full control over the ordering of the bars.

bars may already be part of this group. In that case, bars is just moved to the new index position.

See also: append, remove

Definition at line 23330 of file qcustomplot.cpp.

◆ isEmpty()

bool QCPBarsGroup::isEmpty ( ) const

inline

Returns whether this bars group is empty.

See also: size

Definition at line 5421 of file qcustomplot.h.

◆ keyPixelOffset()

double QCPBarsGroup::keyPixelOffset	(	const QCPBars *	bars,
		double	keyCoord
	)

protected

Definition at line 23395 of file qcustomplot.cpp.

◆ registerBars()

void QCPBarsGroup::registerBars ( QCPBars * bars )

protected

Definition at line 23371 of file qcustomplot.cpp.

◆ remove()

void QCPBarsGroup::remove ( QCPBars * bars )

Removes the specified bars plottable from this group.

See also: contains, clear

Definition at line 23350 of file qcustomplot.cpp.

◆ setSpacing()

void QCPBarsGroup::setSpacing ( double spacing )

Sets the spacing between adjacent bars. What the number passed as spacing actually means, is defined by the current SpacingType, which can be set with setSpacingType.

See also: setSpacingType

Definition at line 23267 of file qcustomplot.cpp.

◆ setSpacingType()

void QCPBarsGroup::setSpacingType ( SpacingType spacingType )

Sets how the spacing between adjacent bars is interpreted. See SpacingType.

The actual spacing can then be specified with setSpacing.

See also: setSpacing

Definition at line 23256 of file qcustomplot.cpp.

◆ size()

int QCPBarsGroup::size ( ) const

inline

Returns the number of QCPBars plottables that are part of this group.

Definition at line 5420 of file qcustomplot.h.

◆ spacing()

double QCPBarsGroup::spacing ( ) const

inline

Definition at line 5411 of file qcustomplot.h.

◆ spacingType()

SpacingType QCPBarsGroup::spacingType ( ) const

inline

Definition at line 5410 of file qcustomplot.h.

◆ unregisterBars()

void QCPBarsGroup::unregisterBars ( QCPBars * bars )

protected

Definition at line 23384 of file qcustomplot.cpp.

Friends And Related Function Documentation

◆ QCPBars

friend class QCPBars

friend

Definition at line 5446 of file qcustomplot.h.

Member Data Documentation

◆ mBars

QList<QCPBars*> QCPBarsGroup::mBars

protected

Definition at line 5433 of file qcustomplot.h.

◆ mParentPlot

QCustomPlot* QCPBarsGroup::mParentPlot

protected

Definition at line 5430 of file qcustomplot.h.

◆ mSpacing

double QCPBarsGroup::mSpacing

protected

Definition at line 5432 of file qcustomplot.h.

◆ mSpacingType

SpacingType QCPBarsGroup::mSpacingType

protected

Definition at line 5431 of file qcustomplot.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Usage

Example

Member Enumeration Documentation

◆ SpacingType

Constructor & Destructor Documentation

◆ QCPBarsGroup()

◆ ~QCPBarsGroup()

Member Function Documentation

◆ append()

◆ bars() [1/2]

◆ bars() [2/2]

◆ clear()

◆ contains()

◆ getPixelSpacing()

◆ insert()

◆ isEmpty()

◆ keyPixelOffset()

◆ registerBars()

◆ remove()

◆ setSpacing()

◆ setSpacingType()

◆ size()

◆ spacing()

◆ spacingType()

◆ unregisterBars()

Friends And Related Function Documentation

◆ QCPBars

Member Data Documentation

◆ mBars

◆ mParentPlot

◆ mSpacing

◆ mSpacingType