A plottable representing a graph in a plot. More...

Inheritance diagram for QCPGraph:

Public Types
enum	LineStyle { lsNone, lsLine, lsStepLeft, lsStepRight, lsStepCenter, lsImpulse }

enum	ErrorType { etNone, etKey, etValue, etBoth }

Public Member Functions
	QCPGraph (QCPAxis keyAxis, QCPAxis valueAxis)

const QCPDataMap *	data () const

LineStyle	lineStyle () const

QCPScatterStyle	scatterStyle () const

ErrorType	errorType () const

QPen	errorPen () const

double	errorBarSize () const

bool	errorBarSkipSymbol () const

QCPGraph *	channelFillGraph () const

void	setData (QCPDataMap *data, bool copy=false)

void	setData (const QVector< double > &key, const QVector< double > &value)

void	setDataKeyError (const QVector< double > &key, const QVector< double > &value, const QVector< double > &keyError)

void	setDataKeyError (const QVector< double > &key, const QVector< double > &value, const QVector< double > &keyErrorMinus, const QVector< double > &keyErrorPlus)

void	setDataValueError (const QVector< double > &key, const QVector< double > &value, const QVector< double > &valueError)

void	setDataValueError (const QVector< double > &key, const QVector< double > &value, const QVector< double > &valueErrorMinus, const QVector< double > &valueErrorPlus)

void	setDataBothError (const QVector< double > &key, const QVector< double > &value, const QVector< double > &keyError, const QVector< double > &valueError)

void	setDataBothError (const QVector< double > &key, const QVector< double > &value, const QVector< double > &keyErrorMinus, const QVector< double > &keyErrorPlus, const QVector< double > &valueErrorMinus, const QVector< double > &valueErrorPlus)

void	setLineStyle (LineStyle ls)

void	setScatterStyle (const QCPScatterStyle &style)

void	setErrorType (ErrorType errorType)

void	setErrorPen (const QPen &pen)

void	setErrorBarSize (double size)

void	setErrorBarSkipSymbol (bool enabled)

void	setChannelFillGraph (QCPGraph *targetGraph)

void	addData (const QCPDataMap &dataMap)

void	addData (const QCPData &data)

void	addData (double key, double value)

void	addData (const QVector< double > &keys, const QVector< double > &values)

void	removeDataBefore (double key)

void	removeDataAfter (double key)

void	removeData (double fromKey, double toKey)

void	removeData (double key)

virtual void	clearData ()

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const

void	rescaleAxes (bool onlyEnlarge, bool includeErrorBars) const

void	rescaleKeyAxis (bool onlyEnlarge, bool includeErrorBars) const

void	rescaleValueAxis (bool onlyEnlarge, bool includeErrorBars) const

Public Member Functions inherited from QCPAbstractPlottable
	QCPAbstractPlottable (QCPAxis keyAxis, QCPAxis valueAxis)

QString	name () const

bool	antialiasedFill () const

bool	antialiasedScatters () const

bool	antialiasedErrorBars () const

QPen	pen () const

QPen	selectedPen () const

QBrush	brush () const

QBrush	selectedBrush () const

QCPAxis *	keyAxis () const

QCPAxis *	valueAxis () const

bool	selectable () const

bool	selected () const

void	setName (const QString &name)

void	setAntialiasedFill (bool enabled)

void	setAntialiasedScatters (bool enabled)

void	setAntialiasedErrorBars (bool enabled)

void	setPen (const QPen &pen)

void	setSelectedPen (const QPen &pen)

void	setBrush (const QBrush &brush)

void	setSelectedBrush (const QBrush &brush)

void	setKeyAxis (QCPAxis *axis)

void	setValueAxis (QCPAxis *axis)

Q_SLOT void	setSelectable (bool selectable)

Q_SLOT void	setSelected (bool selected)

virtual bool	addToLegend ()

virtual bool	removeFromLegend () const

void	rescaleAxes (bool onlyEnlarge=false) const

void	rescaleKeyAxis (bool onlyEnlarge=false) const

void	rescaleValueAxis (bool onlyEnlarge=false) const

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer="", QCPLayerable parentLayerable=0)

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayerable *	parentLayerable () const

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)

bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setAntialiased (bool enabled)

bool	realVisibility () const

Protected Member Functions
virtual void	draw (QCPPainter *painter)

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

virtual QCPRange	getKeyRange (bool &validRange, SignDomain inSignDomain=sdBoth) const

virtual QCPRange	getValueRange (bool &validRange, SignDomain inSignDomain=sdBoth) const

virtual QCPRange	getKeyRange (bool &validRange, SignDomain inSignDomain, bool includeErrors) const

virtual QCPRange	getValueRange (bool &validRange, SignDomain inSignDomain, bool includeErrors) const

virtual void	drawFill (QCPPainter painter, QVector< QPointF > lineData) const

virtual void	drawScatterPlot (QCPPainter painter, QVector< QCPData > pointData) const

virtual void	drawLinePlot (QCPPainter painter, QVector< QPointF > lineData) const

virtual void	drawImpulsePlot (QCPPainter painter, QVector< QPointF > lineData) const

void	getPlotData (QVector< QPointF > lineData, QVector< QCPData > pointData) const

void	getScatterPlotData (QVector< QCPData > *pointData) const

void	getLinePlotData (QVector< QPointF > lineData, QVector< QCPData > pointData) const

void	getStepLeftPlotData (QVector< QPointF > lineData, QVector< QCPData > pointData) const

void	getStepRightPlotData (QVector< QPointF > lineData, QVector< QCPData > pointData) const

void	getStepCenterPlotData (QVector< QPointF > lineData, QVector< QCPData > pointData) const

void	getImpulsePlotData (QVector< QPointF > lineData, QVector< QCPData > pointData) const

void	drawError (QCPPainter *painter, double x, double y, const QCPData &data) const

void	getVisibleDataBounds (QCPDataMap::const_iterator &lower, QCPDataMap::const_iterator &upper, int &count) const

void	addFillBasePoints (QVector< QPointF > *lineData) const

void	removeFillBasePoints (QVector< QPointF > *lineData) const

QPointF	lowerFillBasePoint (double lowerKey) const

QPointF	upperFillBasePoint (double upperKey) const

const QPolygonF	getChannelFillPolygon (const QVector< QPointF > *lineData) const

int	findIndexBelowX (const QVector< QPointF > *data, double x) const

int	findIndexAboveX (const QVector< QPointF > *data, double x) const

int	findIndexBelowY (const QVector< QPointF > *data, double y) const

int	findIndexAboveY (const QVector< QPointF > *data, double y) const

double	pointDistance (const QPointF &pixelPoint) const

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

virtual QCP::Interaction	selectionCategory () const

void	applyDefaultAntialiasingHint (QCPPainter *painter) const

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

virtual void	deselectEvent (bool *selectionStateChanged)

void	coordsToPixels (double key, double value, double &x, double &y) const

const QPointF	coordsToPixels (double key, double value) const

void	pixelsToCoords (double x, double y, double &key, double &value) const

void	pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const

QPen	mainPen () const

QBrush	mainBrush () const

void	applyFillAntialiasingHint (QCPPainter *painter) const

void	applyScattersAntialiasingHint (QCPPainter *painter) const

void	applyErrorBarsAntialiasingHint (QCPPainter *painter) const

double	distSqrToLine (const QPointF &start, const QPointF &end, const QPointF &point) const

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

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
QCPDataMap *	mData

QPen	mErrorPen

LineStyle	mLineStyle

QCPScatterStyle	mScatterStyle

ErrorType	mErrorType

double	mErrorBarSize

bool	mErrorBarSkipSymbol

QPointer< QCPGraph >	mChannelFillGraph

Protected Attributes inherited from QCPAbstractPlottable
QString	mName

bool	mAntialiasedFill

bool	mAntialiasedScatters

bool	mAntialiasedErrorBars

QPen	mPen

QPen	mSelectedPen

QBrush	mBrush

QBrush	mSelectedBrush

QPointer< QCPAxis >	mKeyAxis

QPointer< QCPAxis >	mValueAxis

bool	mSelectable

bool	mSelected

Protected Attributes inherited from QCPLayerable
bool	mVisible

QCustomPlot *	mParentPlot

QPointer< QCPLayerable >	mParentLayerable

QCPLayer *	mLayer

bool	mAntialiased

Friends
class	QCustomPlot

class	QCPLegend

Additional Inherited Members
Signals inherited from QCPAbstractPlottable
void	selectionChanged (bool selected)

Protected Types inherited from QCPAbstractPlottable
enum	SignDomain { sdNegative, sdBoth, sdPositive }

Detailed Description

A plottable representing a graph in a plot.

Usually QCustomPlot creates graphs internally via QCustomPlot::addGraph and the resulting instance is accessed via QCustomPlot::graph.

To plot data, assign it with the setData or addData functions.

Graphs are used to display single-valued data. Single-valued means that there should only be one data point per unique key coordinate. In other words, the graph can't have loops. If you do want to plot non-single-valued curves, rather use the QCPCurve plottable.

Changing the appearance

The appearance of the graph is mainly determined by the line style, scatter style, brush and pen of the graph (setLineStyle, setScatterStyle, setBrush, setPen).

Filling under or between graphs

QCPGraph knows two types of fills: Normal graph fills towards the zero-value-line parallel to the key axis of the graph, and fills between two graphs, called channel fills. To enable a fill, just set a brush with setBrush which is neither Qt::NoBrush nor fully transparent.

By default, a normal fill towards the zero-value-line will be drawn. To set up a channel fill between this graph and another one, call setChannelFillGraph with the other graph as parameter.

See also: QCustomPlot::addGraph, QCustomPlot::graph, QCPLegend::addGraph

Member Enumeration Documentation

enum QCPGraph::ErrorType

Defines what kind of error bars are drawn for each data point

Enumerator
etNone	No error bars are shown.
etKey	Error bars for the key dimension of the data point are shown.
etValue	Error bars for the value dimension of the data point are shown.
etBoth	Error bars for both key and value dimensions of the data point are shown.

enum QCPGraph::LineStyle

Defines how the graph's line is represented visually in the plot. The line is drawn with the current pen of the graph (setPen).

See also: setLineStyle

Enumerator
lsNone	data points are not connected with any lines (e.g. data only represented with symbols according to the scatter style, see setScatterStyle)
lsLine	data points are connected by a straight line
lsStepLeft	line is drawn as steps where the step height is the value of the left data point
lsStepRight	line is drawn as steps where the step height is the value of the right data point
lsStepCenter	line is drawn as steps where the step is in between two data points
lsImpulse	each data point is represented by a line parallel to the value axis, which reaches from the data point to the zero-value-line

Constructor & Destructor Documentation

QCPGraph::QCPGraph	(	QCPAxis *	keyAxis,
		QCPAxis *	valueAxis
	)

explicit

Constructs a graph which uses keyAxis as its key axis ("x") and valueAxis as its value axis ("y"). keyAxis and valueAxis must reside in the same QCustomPlot instance and not have the same orientation. If either of these restrictions is violated, a corresponding message is printed to the debug output (qDebug), the construction is not aborted, though.

The constructed QCPGraph can be added to the plot with QCustomPlot::addPlottable, QCustomPlot then takes ownership of the graph.

To directly create a graph inside a plot, you can also use the simpler QCustomPlot::addGraph function.

Member Function Documentation

void QCPGraph::addData ( const QCPDataMap & dataMap )

Adds the provided data points in dataMap to the current data.

See also: removeData

void QCPGraph::addData ( const QCPData & data )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Adds the provided single data point in data to the current data.

See also: removeData

void QCPGraph::addData	(	double	key,
		double	value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Adds the provided single data point as key and value pair to the current data.

See also: removeData

void QCPGraph::addData	(	const QVector< double > &	keys,
		const QVector< double > &	values
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Adds the provided data points as key and value pairs to the current data.

See also: removeData

void QCPGraph::clearData ( )

virtual

Removes all data points.

See also: removeData, removeDataAfter, removeDataBefore

Implements QCPAbstractPlottable.

QCPRange QCPGraph::getKeyRange	(	bool &	validRange,
		SignDomain	inSignDomain,
		bool	includeErrors
	)		const

protectedvirtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Allows to specify whether the error bars should be included in the range calculation.

See also: getKeyRange(bool &validRange, SignDomain inSignDomain)

QCPRange QCPGraph::getValueRange	(	bool &	validRange,
		SignDomain	inSignDomain,
		bool	includeErrors
	)		const

protectedvirtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Allows to specify whether the error bars should be included in the range calculation.

See also: getValueRange(bool &validRange, SignDomain inSignDomain)

void QCPGraph::removeData	(	double	fromKey,
		double	toKey
	)

Removes all data points with keys between fromKey and toKey. if fromKey is greater or equal to toKey, the function does nothing. To remove a single data point with known key, use removeData(double key).

See also: addData, clearData

void QCPGraph::removeData ( double key )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Removes a single data point at key. If the position is not known with absolute precision, consider using removeData(double fromKey, double toKey) with a small fuzziness interval around the suspected position, depeding on the precision with which the key is known.

See also: addData, clearData

void QCPGraph::removeDataAfter ( double key )

Removes all data points with keys greater than key.

See also: addData, clearData

void QCPGraph::removeDataBefore ( double key )

Removes all data points with keys smaller than key.

See also: addData, clearData

void QCPGraph::rescaleAxes	(	bool	onlyEnlarge,
		bool	includeErrorBars
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Allows to define whether error bars are taken into consideration when determining the new axis range.

See also: rescaleKeyAxis, rescaleValueAxis, QCPAbstractPlottable::rescaleAxes, QCustomPlot::rescaleAxes

void QCPGraph::rescaleKeyAxis	(	bool	onlyEnlarge,
		bool	includeErrorBars
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Allows to define whether error bars (of kind QCPGraph::etKey) are taken into consideration when determining the new axis range.

See also: rescaleAxes, QCPAbstractPlottable::rescaleKeyAxis

void QCPGraph::rescaleValueAxis	(	bool	onlyEnlarge,
		bool	includeErrorBars
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Allows to define whether error bars (of kind QCPGraph::etValue) are taken into consideration when determining the new axis range.

See also: rescaleAxes, QCPAbstractPlottable::rescaleValueAxis

double QCPGraph::selectTest	(	const QPointF &	pos,
		bool	onlySelectable,
		QVariant *	details = `0`
	)		const

virtual

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the item is represented not by single lines but by an area like QCPItemRect or QCPItemText, a click inside the area returns a constant value greater zero (typically the selectionTolerance of the parent QCustomPlot multiplied by 0.99). If the click lies outside the area, this function returns -1.0.

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also: selectEvent, deselectEvent, QCustomPlot::setInteractions

Implements QCPAbstractPlottable.

void QCPGraph::setChannelFillGraph ( QCPGraph * targetGraph )

Sets the target graph for filling the area between this graph and targetGraph with the current brush (setBrush).

When targetGraph is set to 0, a normal graph fill to the zero-value-line will be shown. To disable any filling, set the brush to Qt::NoBrush.

See also: setBrush

void QCPGraph::setData	(	QCPDataMap *	data,
		bool	copy = `false`
	)

Replaces the current data with the provided data.

If copy is set to true, data points in data will only be copied. if false, the graph takes ownership of the passed data and replaces the internal data pointer with it. This is significantly faster than copying for large datasets.

void QCPGraph::setData	(	const QVector< double > &	key,
		const QVector< double > &	value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Replaces the current data with the provided points in key and value pairs. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

void QCPGraph::setDataBothError	(	const QVector< double > &	key,
		const QVector< double > &	value,
		const QVector< double > &	keyError,
		const QVector< double > &	valueError
	)

Replaces the current data with the provided points in key and value pairs. Additionally the symmetrical key and value errors of the data points are set to the values in keyError and valueError. For error bars to show appropriately, see setErrorType. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

For asymmetrical errors (plus different from minus), see the overloaded version of this function.

void QCPGraph::setDataBothError	(	const QVector< double > &	key,
		const QVector< double > &	value,
		const QVector< double > &	keyErrorMinus,
		const QVector< double > &	keyErrorPlus,
		const QVector< double > &	valueErrorMinus,
		const QVector< double > &	valueErrorPlus
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Replaces the current data with the provided points in key and value pairs. Additionally the negative key and value errors of the data points are set to the values in keyErrorMinus and valueErrorMinus. The positive key and value errors are set to the values in keyErrorPlus valueErrorPlus. For error bars to show appropriately, see setErrorType. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

void QCPGraph::setDataKeyError	(	const QVector< double > &	key,
		const QVector< double > &	value,
		const QVector< double > &	keyError
	)

Replaces the current data with the provided points in key and value pairs. Additionally the symmetrical key error of the data points are set to the values in keyError. For error bars to show appropriately, see setErrorType. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

For asymmetrical errors (plus different from minus), see the overloaded version of this function.

void QCPGraph::setDataKeyError	(	const QVector< double > &	key,
		const QVector< double > &	value,
		const QVector< double > &	keyErrorMinus,
		const QVector< double > &	keyErrorPlus
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Replaces the current data with the provided points in key and value pairs. Additionally the negative key error of the data points are set to the values in keyErrorMinus, the positive key error to keyErrorPlus. For error bars to show appropriately, see setErrorType. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

void QCPGraph::setDataValueError	(	const QVector< double > &	key,
		const QVector< double > &	value,
		const QVector< double > &	valueError
	)

Replaces the current data with the provided points in key and value pairs. Additionally the symmetrical value error of the data points are set to the values in valueError. For error bars to show appropriately, see setErrorType. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

For asymmetrical errors (plus different from minus), see the overloaded version of this function.

void QCPGraph::setDataValueError	(	const QVector< double > &	key,
		const QVector< double > &	value,
		const QVector< double > &	valueErrorMinus,
		const QVector< double > &	valueErrorPlus
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Replaces the current data with the provided points in key and value pairs. Additionally the negative value error of the data points are set to the values in valueErrorMinus, the positive value error to valueErrorPlus. For error bars to show appropriately, see setErrorType. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

void QCPGraph::setErrorBarSize ( double size )

Sets the width of the handles at both ends of an error bar in pixels.

void QCPGraph::setErrorBarSkipSymbol ( bool enabled )

If enabled is set to true, the error bar will not be drawn as a solid line under the scatter symbol but leave some free space around the symbol.

This feature uses the current scatter size (QCPScatterStyle::setSize) to determine the size of the area to leave blank. So when drawing Pixmaps as scatter points (QCPScatterStyle::ssPixmap), the scatter size must be set manually to a value corresponding to the size of the Pixmap, if the error bars should leave gaps to its boundaries.

setErrorType, setErrorBarSize, setScatterStyle

void QCPGraph::setErrorPen ( const QPen & pen )

Sets the pen with which the error bars will be drawn.

See also: setErrorBarSize, setErrorType

void QCPGraph::setErrorType ( ErrorType errorType )

Sets which kind of error bars (Key Error, Value Error or both) should be drawn on each data point. If you set errorType to something other than etNone, make sure to actually pass error data via the specific setData functions along with the data points (e.g. setDataValueError, setDataKeyError, setDataBothError).

See also: ErrorType

void QCPGraph::setLineStyle ( LineStyle ls )

Sets how the single data points are connected in the plot. For scatter-only plots, set ls to lsNone and setScatterStyle to the desired scatter style.

See also: setScatterStyle

void QCPGraph::setScatterStyle ( const QCPScatterStyle & style )

Sets the visual appearance of single data points in the plot. If set to QCPScatterStyle::ssNone, no scatter points are drawn (e.g. for line-only-plots with appropriate line style).

See also: QCPScatterStyle, setLineStyle

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Changing the appearance

Filling under or between graphs

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation