QCPBarsData

Search for usage in LXR

Public Member Functions

 QCPBarsData ()
 
 QCPBarsData (double key, double value)
 
double mainKey () const
 
double mainValue () const
 
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 5782 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 24355 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 24364 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 5789 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 5792 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 5793 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 5788 of file qcustomplot.h.

◆ sortKeyIsMainKey()

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

Member Data Documentation

◆ key

double QCPBarsData::key

Definition at line 5797 of file qcustomplot.h.

◆ value

double QCPBarsData::value

Definition at line 5797 of file qcustomplot.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:16:42 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.