Dokumentacja klasy QCPBarsGroup

Groups multiple QCPBars together so they appear side by side. Więcej...

#include <qcustomplot.hh>

Diagram dziedziczenia dla QCPBarsGroup

Diagram współpracy dla QCPBarsGroup:

Typy publiczne
enum	SpacingType { stAbsolute, stAxisRectRatio, stPlotCoords }

Metody publiczne
	QCPBarsGroup (QCustomPlot *parentPlot)
virtual	~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)

Metody chronione
void	registerBars (QCPBars *bars)
void	unregisterBars (QCPBars *bars)
double	keyPixelOffset (const QCPBars *bars, double keyCoord)
double	getPixelSpacing (const QCPBars *bars, double keyCoord)

Atrybuty chronione
QCustomPlot *	mParentPlot
SpacingType	mSpacingType
double	mSpacing
QList< QCPBars * >	mBars

Przyjaciele
class	QCPBars

Opis szczegółowy

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:

Dokumentacja składowych wyliczanych

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.

Zobacz również

setSpacingType, setSpacing

Wartości wyliczeń
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.

Dokumentacja konstruktora i destruktora

QCPBarsGroup::QCPBarsGroup

(

QCustomPlot *

parentPlot

)

Constructs a new bars group for the specified QCustomPlot instance.

QCPBarsGroup::~QCPBarsGroup ( )

virtual

Dokumentacja funkcji składowych

void QCPBarsGroup::append

(

QCPBars *

bars

)

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

Zobacz również

insert, remove

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

inline

Returns all bars currently in this group.

Zobacz również

bars(int index)

QCPBars * QCPBarsGroup::bars

(

int

index

)

const

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

Zobacz również

bars(), size

void QCPBarsGroup::clear

(

)

Removes all QCPBars plottables from this group.

Zobacz również

isEmpty

bool QCPBarsGroup::contains ( QCPBars *  bars ) const

inline

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

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

protected

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.

Zobacz również

append, remove

bool QCPBarsGroup::isEmpty ( ) const

inline

Returns whether this bars group is empty.

Zobacz również

size

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

protected

void QCPBarsGroup::registerBars ( QCPBars *  bars )

protected

void QCPBarsGroup::remove

(

QCPBars *

bars

)

Removes the specified bars plottable from this group.

Zobacz również

contains, clear

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.

Zobacz również

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.

Zobacz również

setSpacing

int QCPBarsGroup::size ( ) const

inline

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

double QCPBarsGroup::spacing ( ) const

inline

SpacingType QCPBarsGroup::spacingType ( ) const

inline

void QCPBarsGroup::unregisterBars ( QCPBars *  bars )

protected

Dokumentacja przyjaciół i funkcji związanych

friend class QCPBars

friend

Dokumentacja atrybutów składowych

QList<QCPBars*> QCPBarsGroup::mBars

protected

QCustomPlot* QCPBarsGroup::mParentPlot

protected

double QCPBarsGroup::mSpacing

protected

SpacingType QCPBarsGroup::mSpacingType

protected

---

Dokumentacja dla tej klasy została wygenerowana z plików:

• qcustomplot.hh
• qcustomplot.cpp