A template base class for plottables with one-dimensional data. More...

#include <qcustomplot.h>

Inheritance diagram for QCPAbstractPlottable1D< DataType >:

Public Member Functions
	QCPAbstractPlottable1D (QCPAxis keyAxis, QCPAxis valueAxis)
	Forwards keyAxis and valueAxis to the QCPAbstractPlottable constructor and allocates the mDataContainer.

virtual int	dataCount () const Q_DECL_OVERRIDE
	Returns the number of data points of the plottable.

virtual double	dataMainKey (int index) const Q_DECL_OVERRIDE
	Returns the main key of the data point at the given index.

virtual double	dataSortKey (int index) const Q_DECL_OVERRIDE
	Returns the sort key of the data point at the given index.

virtual double	dataMainValue (int index) const Q_DECL_OVERRIDE
	Returns the main value of the data point at the given index.

virtual QCPRange	dataValueRange (int index) const Q_DECL_OVERRIDE
	Returns the value range of the data point at the given index.

virtual QPointF	dataPixelPosition (int index) const Q_DECL_OVERRIDE
	Returns the pixel position on the widget surface at which the data point at the given index appears.

virtual bool	sortKeyIsMainKey () const Q_DECL_OVERRIDE
	Returns whether the sort key (dataSortKey) is identical to the main key (dataMainKey).

virtual QCPDataSelection	selectTestRect (const QRectF &rect, bool onlySelectable) const Q_DECL_OVERRIDE
	Implements a rect-selection algorithm assuming the data (accessed via the 1D data interface) is point-like.

virtual int	findBegin (double sortKey, bool expandedRange=true) const Q_DECL_OVERRIDE
	Returns the index of the data point with a (sort-)key that is equal to, just below, or just above sortKey.

virtual int	findEnd (double sortKey, bool expandedRange=true) const Q_DECL_OVERRIDE
	Returns the index one after the data point with a (sort-)key that is equal to, just above, or just below sortKey.

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE
	Implements a point-selection algorithm assuming the data (accessed via the 1D data interface) is point-like.

virtual QCPPlottableInterface1D *	interface1D () Q_DECL_OVERRIDE
	Returns a QCPPlottableInterface1D pointer to this plottable, providing access to its 1D interface.

Public Member Functions inherited from QCPAbstractPlottable
	QCPAbstractPlottable (QCPAxis keyAxis, QCPAxis valueAxis)
	Constructs an abstract plottable which uses keyAxis as its key axis ("x") and valueAxis as its value axis ("y").

QString	name () const

bool	antialiasedFill () const

bool	antialiasedScatters () const

QPen	pen () const

QBrush	brush () const

QCPAxis *	keyAxis () const

QCPAxis *	valueAxis () const

QCP::SelectionType	selectable () const

bool	selected () const
	Returns true if there are any data points of the plottable currently selected.

QCPDataSelection	selection () const
	Returns a QCPDataSelection encompassing all the data points that are currently selected on this plottable.

QCPSelectionDecorator *	selectionDecorator () const
	Provides access to the selection decorator of this plottable.

void	setName (const QString &name)
	The name is the textual representation of this plottable as it is displayed in the legend (QCPLegend).

void	setAntialiasedFill (bool enabled)
	Sets whether fills of this plottable are drawn antialiased or not.

void	setAntialiasedScatters (bool enabled)
	Sets whether the scatter symbols of this plottable are drawn antialiased or not.

void	setPen (const QPen &pen)
	The pen is used to draw basic lines that make up the plottable representation in the plot.

void	setBrush (const QBrush &brush)
	The brush is used to draw basic fills of the plottable representation in the plot.

void	setKeyAxis (QCPAxis *axis)
	The key axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal to the plottable's value axis.

void	setValueAxis (QCPAxis *axis)
	The value axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal to the plottable's key axis.

Q_SLOT void	setSelectable (QCP::SelectionType selectable)
	Sets whether and to which granularity this plottable can be selected.

Q_SLOT void	setSelection (QCPDataSelection selection)
	Sets which data ranges of this plottable are selected.

void	setSelectionDecorator (QCPSelectionDecorator *decorator)
	Use this method to set an own QCPSelectionDecorator (subclass) instance.

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const =0
	This function is used to decide whether a click hits a layerable object or not.

virtual QCPPlottableInterface1D *	interface1D ()
	If this plottable is a one-dimensional plottable, i.e.

virtual QCPRange	getKeyRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth) const =0
	Returns the coordinate range that all data in this plottable span in the key axis dimension.

virtual QCPRange	getValueRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth, const QCPRange &inKeyRange=QCPRange()) const =0
	Returns the coordinate range that the data points in the specified key range (inKeyRange) span in the value axis dimension.

void	coordsToPixels (double key, double value, double &x, double &y) const
	Convenience function for transforming a key/value pair to pixels on the QCustomPlot surface, taking the orientations of the axes associated with this plottable into account (e.g.

const QPointF	coordsToPixels (double key, double value) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Transforms the given key and value to pixel coordinates and returns them in a QPointF.

void	pixelsToCoords (double x, double y, double &key, double &value) const
	Convenience function for transforming a x/y pixel pair on the QCustomPlot surface to plot coordinates, taking the orientations of the axes associated with this plottable into account (e.g.

void	pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the pixel input pixelPos as plot coordinates key and value.

void	rescaleAxes (bool onlyEnlarge=false) const
	Rescales the key and value axes associated with this plottable to contain all displayed data, so the whole plottable is visible.

void	rescaleKeyAxis (bool onlyEnlarge=false) const
	Rescales the key axis of the plottable so the whole plottable is visible.

void	rescaleValueAxis (bool onlyEnlarge=false, bool inKeyRange=false) const
	Rescales the value axis of the plottable so the whole plottable is visible.

bool	addToLegend (QCPLegend *legend)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Adds this plottable to the specified legend.

bool	addToLegend ()
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Adds this plottable to the legend of the parent QCustomPlot (QCustomPlot::legend).

bool	removeFromLegend (QCPLegend *legend) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Removes the plottable from the specifed legend.

bool	removeFromLegend () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Removes the plottable from the legend of the parent QCustomPlot.

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)
	Creates a new QCPLayerable instance.

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayerable *	parentLayerable () const
	Returns the parent layerable of this layerable.

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)
	Sets the visibility of this layerable object.

Q_SLOT bool	setLayer (QCPLayer *layer)
	Sets the layer of this layerable object.

bool	setLayer (const QString &layerName)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the layer of this layerable object by name.

void	setAntialiased (bool enabled)
	Sets whether this object will be drawn antialiased or not.

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
	This function is used to decide whether a click hits a layerable object or not.

bool	realVisibility () const
	Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of this layerable's layer into account.

virtual int	dataCount () const =0
	Returns the number of data points of the plottable.

virtual double	dataMainKey (int index) const =0
	Returns the main key of the data point at the given index.

virtual double	dataSortKey (int index) const =0
	Returns the sort key of the data point at the given index.

virtual double	dataMainValue (int index) const =0
	Returns the main value of the data point at the given index.

virtual QCPRange	dataValueRange (int index) const =0
	Returns the value range of the data point at the given index.

virtual QPointF	dataPixelPosition (int index) const =0
	Returns the pixel position on the widget surface at which the data point at the given index appears.

virtual bool	sortKeyIsMainKey () const =0
	Returns whether the sort key (dataSortKey) is identical to the main key (dataMainKey).

virtual QCPDataSelection	selectTestRect (const QRectF &rect, bool onlySelectable) const =0
	Returns a data selection containing all the data points of this plottable which are contained (or hit by) rect.

virtual int	findBegin (double sortKey, bool expandedRange=true) const =0
	Returns the index of the data point with a (sort-)key that is equal to, just below, or just above sortKey.

virtual int	findEnd (double sortKey, bool expandedRange=true) const =0
	Returns the index one after the data point with a (sort-)key that is equal to, just above, or just below sortKey.

Protected Member Functions
void	getDataSegments (QList< QCPDataRange > &selectedSegments, QList< QCPDataRange > &unselectedSegments) const
	Splits all data into selected and unselected segments and outputs them via selectedSegments and unselectedSegments, respectively.

void	drawPolyline (QCPPainter *painter, const QVector< QPointF > &lineData) const
	A helper method which draws a line with the passed painter, according to the pixel data in lineData.

Protected Member Functions inherited from QCPAbstractPlottable
virtual QRect	clipRect () const Q_DECL_OVERRIDE

virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE=0

virtual QCP::Interaction	selectionCategory () const Q_DECL_OVERRIDE

void	applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged) Q_DECL_OVERRIDE

virtual void	deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE

virtual void	drawLegendIcon (QCPPainter *painter, const QRectF &rect) const =0

void	applyFillAntialiasingHint (QCPPainter *painter) const

void	applyScattersAntialiasingHint (QCPPainter *painter) const

Protected Member Functions inherited from QCPLayerable
virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

virtual QCP::Interaction	selectionCategory () const

virtual QRect	clipRect () const

virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const =0

virtual void	draw (QCPPainter *painter)=0

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged)

virtual void	deselectEvent (bool *selectionStateChanged)

virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)
	This event gets called when the user presses a mouse button while the cursor is over the layerable.

virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)
	This event gets called when the user moves the mouse while holding a mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent.

virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)
	This event gets called when the user releases the mouse button, after this layerable has become the mouse grabber by accepting the preceding mousePressEvent.

virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)
	This event gets called when the user presses the mouse button a second time in a double-click, while the cursor is over the layerable.

virtual void	wheelEvent (QWheelEvent *event)
	This event gets called when the user turns the mouse scroll wheel while the cursor is over the layerable.

void	initializeParentPlot (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

bool	moveToLayer (QCPLayer *layer, bool prepend)

void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

Protected Attributes
QSharedPointer< QCPDataContainer< DataType > >	mDataContainer

Protected Attributes inherited from QCPAbstractPlottable
QString	mName

bool	mAntialiasedFill

bool	mAntialiasedScatters

QPen	mPen

QBrush	mBrush

QPointer< QCPAxis >	mKeyAxis

QPointer< QCPAxis >	mValueAxis

QCP::SelectionType	mSelectable

QCPDataSelection	mSelection

QCPSelectionDecorator *	mSelectionDecorator

Protected Attributes inherited from QCPLayerable
bool	mVisible

QCustomPlot *	mParentPlot

QPointer< QCPLayerable >	mParentLayerable

QCPLayer *	mLayer

bool	mAntialiased

Additional Inherited Members
Signals inherited from QCPAbstractPlottable
void	selectionChanged (bool selected)
	This signal is emitted when the selection state of this plottable has changed, either by user interaction or by a direct call to setSelection.

void	selectionChanged (const QCPDataSelection &selection)
	This signal is emitted when the selection state of this plottable has changed, either by user interaction or by a direct call to setSelection.

void	selectableChanged (QCP::SelectionType selectable)
	This signal is emitted when the selectability of this plottable has changed.

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)
	This signal is emitted when the layer of this layerable changes, i.e.

Detailed Description

template<class DataType>
class QCPAbstractPlottable1D< DataType >

A template base class for plottables with one-dimensional data.

This template class derives from QCPAbstractPlottable and from the abstract interface QCPPlottableInterface1D. It serves as a base class for all one-dimensional data (i.e. data with one key dimension), such as QCPGraph and QCPCurve.

The template parameter DataType is the type of the data points of this plottable (e.g. QCPGraphData or QCPCurveData). The main purpose of this base class is to provide the member mDataContainer (a shared pointer to a QCPDataContainer<DataType>) and implement the according virtual methods of the QCPPlottableInterface1D, such that most subclassed plottables don't need to worry about this anymore.

Further, it provides a convenience method for retrieving selected/unselected data segments via getDataSegments. This is useful when subclasses implement their draw method and need to draw selected segments with a different pen/brush than unselected segments (also see QCPSelectionDecorator).

This class implements basic functionality of QCPAbstractPlottable::selectTest and QCPPlottableInterface1D::selectTestRect, assuming point-like data points, based on the 1D data interface. In spite of that, most plottable subclasses will want to reimplement those methods again, to provide a more accurate hit test based on their specific data visualization geometry.

Member Function Documentation

◆ dataCount()

template<class DataType >

int QCPAbstractPlottable1D< DataType >::dataCount

virtual

Returns the number of data points of the plottable.

Implements QCPPlottableInterface1D.

◆ dataMainKey()

template<class DataType >

double QCPAbstractPlottable1D< DataType >::dataMainKey ( int index ) const

virtual

Returns the main key of the data point at the given index.

What the main key is, is defined by the plottable's data type. See the QCPDataContainer DataType documentation for details about this naming convention.

Implements QCPPlottableInterface1D.

◆ dataMainValue()

template<class DataType >

double QCPAbstractPlottable1D< DataType >::dataMainValue ( int index ) const

virtual

Returns the main value of the data point at the given index.

What the main value is, is defined by the plottable's data type. See the QCPDataContainer DataType documentation for details about this naming convention.

Implements QCPPlottableInterface1D.

◆ dataPixelPosition()

template<class DataType >

QPointF QCPAbstractPlottable1D< DataType >::dataPixelPosition ( int index ) const

virtual

Returns the pixel position on the widget surface at which the data point at the given index appears.

Usually this corresponds to the point of dataMainKey/ dataMainValue, in pixel coordinates. However, depending on the plottable, this might be a different apparent position than just a coord-to-pixel transform of those values. For example, QCPBars apparent data values can be shifted depending on their stacking, bar grouping or configured base value.

Implements QCPPlottableInterface1D.

Reimplemented in QCPBars.

◆ dataSortKey()

template<class DataType >

double QCPAbstractPlottable1D< DataType >::dataSortKey ( int index ) const

virtual

Returns the sort key of the data point at the given index.

What the sort key is, is defined by the plottable's data type. See the QCPDataContainer DataType documentation for details about this naming convention.

Implements QCPPlottableInterface1D.

◆ dataValueRange()

template<class DataType >

QCPRange QCPAbstractPlottable1D< DataType >::dataValueRange ( int index ) const

virtual

Returns the value range of the data point at the given index.

What the value range is, is defined by the plottable's data type. See the QCPDataContainer DataType documentation for details about this naming convention.

Implements QCPPlottableInterface1D.

◆ drawPolyline()

template<class DataType >

void QCPAbstractPlottable1D< DataType >::drawPolyline	(	QCPPainter *	painter,
		const QVector< QPointF > &	lineData
	)		const

protected

A helper method which draws a line with the passed painter, according to the pixel data in lineData.

NaN points create gaps in the line, as expected from QCustomPlot's plottables (this is the main difference to QPainter's regular drawPolyline, which handles NaNs by lagging or crashing).

Further it uses a faster line drawing technique based on QCPPainter::drawLine rather than QPainter::drawPolyline if the configured QCustomPlot::setPlottingHints() and painter style allows.

◆ findBegin()

template<class DataType >

int QCPAbstractPlottable1D< DataType >::findBegin	(	double	sortKey,
		bool	expandedRange = `true`
	)		const

virtual

Returns the index of the data point with a (sort-)key that is equal to, just below, or just above sortKey.

If expandedRange is true, the data point just below sortKey will be considered, otherwise the one just above.

This can be used in conjunction with findEnd to iterate over data points within a given key range, including or excluding the bounding data points that are just beyond the specified range.

If expandedRange is true but there are no data points below sortKey, 0 is returned.

If the container is empty, returns 0 (in that case, findEnd will also return 0, so a loop using these methods will not iterate over the index 0).

See also: findEnd, QCPDataContainer::findBegin

Implements QCPPlottableInterface1D.

◆ findEnd()

template<class DataType >

int QCPAbstractPlottable1D< DataType >::findEnd	(	double	sortKey,
		bool	expandedRange = `true`
	)		const

virtual

Returns the index one after the data point with a (sort-)key that is equal to, just above, or just below sortKey.

If expandedRange is true, the data point just above sortKey will be considered, otherwise the one just below.

This can be used in conjunction with findBegin to iterate over data points within a given key range, including the bounding data points that are just below and above the specified range.

If expandedRange is true but there are no data points above sortKey, the index just above the highest data point is returned.

If the container is empty, returns 0.

See also: findBegin, QCPDataContainer::findEnd

Implements QCPPlottableInterface1D.

◆ getDataSegments()

template<class DataType >

void QCPAbstractPlottable1D< DataType >::getDataSegments	(	QList< QCPDataRange > &	selectedSegments,
		QList< QCPDataRange > &	unselectedSegments
	)		const

protected

Splits all data into selected and unselected segments and outputs them via selectedSegments and unselectedSegments, respectively.

This is useful when subclasses implement their draw method and need to draw selected segments with a different pen/brush than unselected segments (also see QCPSelectionDecorator).

See also: setSelection

◆ interface1D()

template<class DataType >

QCPPlottableInterface1D * QCPAbstractPlottable1D< DataType >::interface1D ( )

inlinevirtual

Returns a QCPPlottableInterface1D pointer to this plottable, providing access to its 1D interface.

\seebaseclassmethod

Reimplemented from QCPAbstractPlottable.

◆ selectTest()

template<class DataType >

double QCPAbstractPlottable1D< DataType >::selectTest	(	const QPointF &	pos,
		bool	onlySelectable,
		QVariant *	details = `0`
	)		const

virtual

Implements a point-selection algorithm assuming the data (accessed via the 1D data interface) is point-like.

Most subclasses will want to reimplement this method again, to provide a more accurate hit test based on the true data visualization geometry.

\seebaseclassmethod

Implements QCPAbstractPlottable.

Reimplemented in QCPGraph, QCPCurve, QCPBars, QCPStatisticalBox, and QCPFinancial.

◆ selectTestRect()

template<class DataType >

QCPDataSelection QCPAbstractPlottable1D< DataType >::selectTestRect	(	const QRectF &	rect,
		bool	onlySelectable
	)		const

virtual

Implements a rect-selection algorithm assuming the data (accessed via the 1D data interface) is point-like.

Most subclasses will want to reimplement this method again, to provide a more accurate hit test based on the true data visualization geometry.

\seebaseclassmethod

Implements QCPPlottableInterface1D.

Reimplemented in QCPBars, QCPStatisticalBox, and QCPFinancial.

◆ sortKeyIsMainKey()

template<class DataType >

bool QCPAbstractPlottable1D< DataType >::sortKeyIsMainKey

virtual

Returns whether the sort key (dataSortKey) is identical to the main key (dataMainKey).

What the sort and main keys are, is defined by the plottable's data type. See the QCPDataContainer DataType documentation for details about this naming convention.

Implements QCPPlottableInterface1D.

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

qcustomplot.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dataCount()

◆ dataMainKey()

◆ dataMainValue()

◆ dataPixelPosition()

◆ dataSortKey()

◆ dataValueRange()

◆ drawPolyline()

◆ findBegin()

◆ findEnd()

◆ getDataSegments()

◆ interface1D()

◆ selectTest()

◆ selectTestRect()

◆ sortKeyIsMainKey()