QCPBarsData Class Reference

Holds the data of one single data point (one bar) for QCPBars. More...

#include <qcustomplot.h>

Public Member Functions
double	mainKey () const
double	mainValue () const
	QCPBarsData ()
	QCPBarsData (double key, double value)
double	sortKey () const
QCPRange	valueRange () const

Static Public Member Functions
static QCPBarsData	fromSortKey (double sortKey)
static bool	sortKeyIsMainKey ()

Public Attributes
double	key
double	value

Detailed Description

Holds the data of one single data point (one bar) for QCPBars.

The stored data is:

• key: coordinate on the key axis of this bar (this is the mainKey and the sortKey)
• value: height coordinate on the value axis of this bar (this is the mainValue)

The container for storing multiple data points is QCPBarsDataContainer. It is a typedef for QCPDataContainer with QCPBarsData as the DataType template parameter. See the documentation there for an explanation regarding the data type's generic methods.

See also

QCPBarsDataContainer

Definition at line 5451 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPBarsData() [1/2]

QCPBarsData::QCPBarsData

(

)

Constructs a bar data point with key and value set to zero.

Definition at line 23560 of file qcustomplot.cpp.

QCPBarsData() [2/2]

QCPBarsData::QCPBarsData	(	double	key,
		double	value
	)

Constructs a bar data point with the specified key and value.

Definition at line 23569 of file qcustomplot.cpp.

Member Function Documentation

fromSortKey()

static QCPBarsData QCPBarsData::fromSortKey ( double  sortKey )

inlinestatic

Returns a data point with the specified sortKey. All other members are set to zero.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5458 of file qcustomplot.h.

mainKey()

double QCPBarsData::mainKey ( ) const

inline

Returns the key member of this data point.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5461 of file qcustomplot.h.

mainValue()

double QCPBarsData::mainValue ( ) const

inline

Returns the value member of this data point.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5462 of file qcustomplot.h.

sortKey()

double QCPBarsData::sortKey ( ) const

inline

Returns the key member of this data point.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5457 of file qcustomplot.h.

sortKeyIsMainKey()

static static bool QCPBarsData::sortKeyIsMainKey ( )

inlinestatic

Since the member key is both the data point key coordinate and the data ordering parameter, this method returns true.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5459 of file qcustomplot.h.

valueRange()

QCPRange QCPBarsData::valueRange ( ) const

inline

Returns a QCPRange with both lower and upper boundary set to value of this data point.

For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.

Definition at line 5464 of file qcustomplot.h.

Member Data Documentation

key

double QCPBarsData::key

Definition at line 5466 of file qcustomplot.h.

value

double QCPBarsData::value

Definition at line 5466 of file qcustomplot.h.

---

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

• qcustomplot.h
• qcustomplot.cpp