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
	QCPBarsGroup (QCustomPlot *parentPlot)

	~QCPBarsGroup ()

SpacingType	spacingType () const

double	spacing () const

void	setSpacingType (SpacingType spacingType)

void	setSpacing (double spacing)

QList< QCPBars * >	bars () const

QCPBars *	bars (int index) const

int	size () const

bool	isEmpty () const

void	clear ()

bool	contains (QCPBars *bars) const

void	append (QCPBars *bars)

void	insert (int i, QCPBars *bars)

void	remove (QCPBars *bars)

Protected Member Functions
void	registerBars (QCPBars *bars)

void	unregisterBars (QCPBars *bars)

double	keyPixelOffset (const QCPBars *bars, double keyCoord)

double	getPixelSpacing (const QCPBars *bars, double keyCoord)

Protected Attributes
QCustomPlot *	mParentPlot

SpacingType	mSpacingType

double	mSpacing

QList< QCPBars * >	mBars

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:

QCPBarsGroup *group = new QCPBarsGroup(customPlot);
group->append(bars1);
group->append(bars2);

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.

Definition at line 2790 of file qcustomplot.h.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

QCPBarsGroup::QCPBarsGroup ( QCustomPlot * parentPlot )

Constructs a new bars group for the specified QCustomPlot instance.

Definition at line 18556 of file qcustomplot.cpp.

QCPBarsGroup::~QCPBarsGroup ( )

Definition at line 18564 of file qcustomplot.cpp.

Member Function Documentation

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

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

inline

Returns all bars currently in this group.

See also: bars(int index)

Definition at line 2820 of file qcustomplot.h.

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

void QCPBarsGroup::clear ( )

Removes all QCPBars plottables from this group.

See also: isEmpty

Definition at line 18615 of file qcustomplot.cpp.

bool QCPBarsGroup::contains ( QCPBars * bars ) const

inline

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

Definition at line 2825 of file qcustomplot.h.

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

protected

Definition at line 18800 of file qcustomplot.cpp.

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

bool QCPBarsGroup::isEmpty ( ) const

inline

Returns whether this bars group is empty.

See also: size

Definition at line 2823 of file qcustomplot.h.

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

protected

Definition at line 18715 of file qcustomplot.cpp.

void QCPBarsGroup::registerBars ( QCPBars * bars )

protected

Definition at line 18691 of file qcustomplot.cpp.

void QCPBarsGroup::remove ( QCPBars * bars )

Removes the specified bars plottable from this group.

See also: contains, clear

Definition at line 18670 of file qcustomplot.cpp.

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

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

int QCPBarsGroup::size ( ) const

inline

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

Definition at line 2822 of file qcustomplot.h.

double QCPBarsGroup::spacing ( ) const

inline

Definition at line 2813 of file qcustomplot.h.

SpacingType QCPBarsGroup::spacingType ( ) const

inline

Definition at line 2812 of file qcustomplot.h.

void QCPBarsGroup::unregisterBars ( QCPBars * bars )

protected

Definition at line 18704 of file qcustomplot.cpp.

Friends And Related Function Documentation

friend class QCPBars

friend

Definition at line 2848 of file qcustomplot.h.

Member Data Documentation

QList<QCPBars*> QCPBarsGroup::mBars

protected

Definition at line 2835 of file qcustomplot.h.

QCustomPlot* QCPBarsGroup::mParentPlot

protected

Definition at line 2832 of file qcustomplot.h.

double QCPBarsGroup::mSpacing

protected

Definition at line 2834 of file qcustomplot.h.

SpacingType QCPBarsGroup::mSpacingType

protected

Definition at line 2833 of file qcustomplot.h.

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

Projects/VespucciProject/Vespucci/Vespucci/qcustomplot.h
Projects/VespucciProject/Vespucci/Vespucci/qcustomplot.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Usage

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation