Main Page · Class Overview · Hierarchy · All Classes
Public Types | Public Functions | Signals | Protected Types | Protected Functions
QCPGraph Class Reference

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

Inheritance diagram for QCPGraph:
Inheritance graph

Public Types

enum  LineStyle
enum  ErrorType

Public Functions

 QCPGraph (QCPAxis *keyAxis, QCPAxis *valueAxis)
const QCPDataMapdata () const
LineStyle lineStyle () const
QCP::ScatterStyle scatterStyle () const
double scatterSize () const
const QPixmap scatterPixmap () const
ErrorType errorType () const
QPen errorPen () const
double errorBarSize () const
bool errorBarSkipSymbol () const
QCPGraphchannelFillGraph () 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 (QCP::ScatterStyle ss)
void setScatterSize (double size)
void setScatterPixmap (const QPixmap &pixmap)
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) const
virtual void rescaleAxes (bool onlyEnlarge, bool includeErrorBars) const
virtual void rescaleKeyAxis (bool onlyEnlarge, bool includeErrorBars) const
virtual void rescaleValueAxis (bool onlyEnlarge, bool includeErrorBars) const
QString name () const
bool antialiasedFill () const
bool antialiasedScatters () const
bool antialiasedErrorBars () const
QPen pen () const
QPen selectedPen () const
QBrush brush () const
QBrush selectedBrush () const
QCPAxiskeyAxis () const
QCPAxisvalueAxis () 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)
void setSelectable (bool selectable)
void setSelected (bool selected)
void rescaleAxes (bool onlyEnlarge=false) const
void rescaleKeyAxis (bool onlyEnlarge=false) const
void rescaleValueAxis (bool onlyEnlarge=false) const
virtual bool addToLegend ()
virtual bool removeFromLegend () const
bool visible () const
QCustomPlotparentPlot () const
QCPLayerlayer () const
bool antialiased () const
void setVisible (bool on)
bool setLayer (QCPLayer *layer)
bool setLayer (const QString &layerName)
void setAntialiased (bool enabled)

Signals

void selectionChanged (bool selected)

Protected Types

enum  SignDomain

Protected Functions

virtual void draw (QCPPainter *painter)
virtual void drawLegendIcon (QCPPainter *painter, const QRect &rect) 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 drawFill (QCPPainter *painter, QVector< QPointF > *lineData) const
void drawScatterPlot (QCPPainter *painter, QVector< QCPData > *pointData) const
void drawLinePlot (QCPPainter *painter, QVector< QPointF > *lineData) const
void drawImpulsePlot (QCPPainter *painter, QVector< QPointF > *lineData) 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
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 QRect clipRect () const
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 applyDefaultAntialiasingHint (QCPPainter *painter) 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
bool moveToLayer (QCPLayer *layer, bool prepend)
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

Detailed Description

A plottable representing a graph in a plot.

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

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

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

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

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 QCPAbstractPlottable::SignDomain [protected, inherited]

Represents negative and positive sign domain for passing to getKeyRange and getValueRange.

Enumerator:
sdNegative 

The negative sign domain, i.e. numbers smaller than zero.

sdBoth 

Both sign domains, including zero, i.e. all (rational) numbers.

sdPositive 

The positive sign domain, i.e. numbers greater than zero.


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::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 function.

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::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 function.

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 function.

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::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 function.

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.

Sets how the single data points are connected in the plot or how they are represented visually apart from the scatter symbol. For scatter-only plots, set ls to lsNone and setScatterStyle to the desired scatter style.

See also:
setScatterStyle

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

See also:
ScatterStyle, setLineStyle
void QCPGraph::setScatterSize ( double  size)

This defines how big (in pixels) single scatters are drawn, if scatter style (setScatterStyle) isn't QCP::ssNone, QCP::ssDot or QCP::ssPixmap. Floating point values are allowed for fine grained control over optical appearance with antialiased painting.

See also:
ScatterStyle
void QCPGraph::setScatterPixmap ( const QPixmap &  pixmap)

If the scatter style (setScatterStyle) is set to ssPixmap, this function defines the QPixmap that will be drawn centered on the data point coordinate.

See also:
ScatterStyle
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::setErrorPen ( const QPen &  pen)

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

See also:
setErrorBarSize, setErrorType
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 (setScatterSize) to determine the size of the area to leave blank. So when drawing Pixmaps as scatter points (QCP::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.

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 will be produced. This means, when the brush is not Qt::NoBrush or fully transparent, a fill all the way to the zero-value-line parallel to the key axis of this graph will be drawn. To disable any filling, set the brush to Qt::NoBrush.

See also:
setBrush
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 function.

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 function.

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 function.

Adds the provided data points as key and value pairs to the current data.

See also:
removeData
void QCPGraph::removeDataBefore ( double  key)

Removes all data points with keys smaller than key.

See also:
addData, clearData
void QCPGraph::removeDataAfter ( double  key)

Removes all data points with keys greater than key.

See also:
addData, clearData
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 function.

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::clearData ( ) [virtual]

Removes all data points.

See also:
removeData, removeDataAfter, removeDataBefore

Implements QCPAbstractPlottable.

double QCPGraph::selectTest ( const QPointF &  pos) const [virtual]

This function is used to decide whether a click hits a plottable 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 plottable (e.g. to the scatters/lines of a graph). If the plottable is either invisible, contains no data or the distance couldn't be determined, -1.0 is returned. setSelectable has no influence on the return value of this function.

If the plottable is represented not by single lines but by an area like QCPBars or QCPStatisticalBox, a click inside the area returns a constant value greater zero (typically 99% of the selectionTolerance of the parent QCustomPlot). 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.

See also:
setSelected, QCustomPlot::setInteractions

Implements QCPAbstractPlottable.

void QCPGraph::rescaleAxes ( bool  onlyEnlarge,
bool  includeErrorBars 
) const [virtual]

This is an overloaded function.

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

void QCPGraph::rescaleKeyAxis ( bool  onlyEnlarge,
bool  includeErrorBars 
) const [virtual]

This is an overloaded function.

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

void QCPGraph::rescaleValueAxis ( bool  onlyEnlarge,
bool  includeErrorBars 
) const [virtual]

This is an overloaded function.

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

void QCPGraph::draw ( QCPPainter painter) [protected, virtual]

Draws this plottable with the provided painter. Called by QCustomPlot::draw on all its visible plottables.

The cliprect of the provided painter is set to the axis rect of the key/value axis of this plottable (what clipRect returns), before this function is called.

Implements QCPAbstractPlottable.

void QCPGraph::drawLegendIcon ( QCPPainter painter,
const QRect &  rect 
) const [protected, virtual]

called by QCPLegend::draw (via QCPPlottableLegendItem::draw) to create a graphical representation of this plottable inside rect, next to the plottable name.

Implements QCPAbstractPlottable.

void QCPGraph::getPlotData ( QVector< QPointF > *  lineData,
QVector< QCPData > *  pointData 
) const [protected]

This function branches out to the line style specific "get(...)PlotData" functions, according to the line style of the graph.

Parameters:
lineDatawill be filled with raw points that will be drawn with the according draw functions, e.g. drawLinePlot and drawImpulsePlot. These aren't necessarily the original data points, since for step plots for example, additional points are needed for drawing lines that make up steps. If the line style of the graph is lsNone, the lineData vector will be left untouched.
pointDatawill be filled with the original data points so drawScatterPlot can draw the scatter symbols accordingly. If no scatters need to be drawn, i.e. scatter style is QCP::ssNone, pass 0 as pointData, and this step will be skipped.
See also:
getScatterPlotData, getLinePlotData, getStepLeftPlotData, getStepRightPlotData, getStepCenterPlotData, getImpulsePlotData
void QCPGraph::getScatterPlotData ( QVector< QCPData > *  pointData) const [protected]

If line style is lsNone and scatter style is not QCP::ssNone, this function serves at providing the visible data points in pointData, so the drawScatterPlot function can draw the scatter points accordingly.

If line style is not lsNone, this function is not called and the data for the scatter points are (if needed) calculated inside the corresponding other "get(...)PlotData" functions.

See also:
drawScatterPlot
void QCPGraph::getLinePlotData ( QVector< QPointF > *  lineData,
QVector< QCPData > *  pointData 
) const [protected]

Places the raw data points needed for a normal linearly connected plot in lineData.

As for all plot data retrieval functions, pointData just contains all unaltered data (scatter) points that are visible, for drawing scatter points, if necessary. If drawing scatter points is disabled (i.e. scatter style QCP::ssNone), pass 0 as pointData, and the function will skip filling the vector.

See also:
drawLinePlot
void QCPGraph::getStepLeftPlotData ( QVector< QPointF > *  lineData,
QVector< QCPData > *  pointData 
) const [protected]

Places the raw data points needed for a step plot with left oriented steps in lineData.

As for all plot data retrieval functions, pointData just contains all unaltered data (scatter) points that are visible, for drawing scatter points, if necessary. If drawing scatter points is disabled (i.e. scatter style QCP::ssNone), pass 0 as pointData, and the function will skip filling the vector.

See also:
drawLinePlot
void QCPGraph::getStepRightPlotData ( QVector< QPointF > *  lineData,
QVector< QCPData > *  pointData 
) const [protected]

Places the raw data points needed for a step plot with right oriented steps in lineData.

As for all plot data retrieval functions, pointData just contains all unaltered data (scatter) points that are visible, for drawing scatter points, if necessary. If drawing scatter points is disabled (i.e. scatter style QCP::ssNone), pass 0 as pointData, and the function will skip filling the vector.

See also:
drawLinePlot
void QCPGraph::getStepCenterPlotData ( QVector< QPointF > *  lineData,
QVector< QCPData > *  pointData 
) const [protected]

Places the raw data points needed for a step plot with centered steps in lineData.

As for all plot data retrieval functions, pointData just contains all unaltered data (scatter) points that are visible, for drawing scatter points, if necessary. If drawing scatter points is disabled (i.e. scatter style QCP::ssNone), pass 0 as pointData, and the function will skip filling the vector.

See also:
drawLinePlot
void QCPGraph::getImpulsePlotData ( QVector< QPointF > *  lineData,
QVector< QCPData > *  pointData 
) const [protected]

Places the raw data points needed for an impulse plot in lineData.

As for all plot data retrieval functions, pointData just contains all unaltered data (scatter) points that are visible, for drawing scatter points, if necessary. If drawing scatter points is disabled (i.e. scatter style QCP::ssNone), pass 0 as pointData, and the function will skip filling the vector.

See also:
drawImpulsePlot
void QCPGraph::drawFill ( QCPPainter painter,
QVector< QPointF > *  lineData 
) const [protected]

Draws the fill of the graph with the specified brush. If the fill is a normal "base" fill, i.e. under the graph toward the zero-value-line, only the lineData is required (and two extra points at the zero-value-line, which are added by addFillBasePoints and removed by removeFillBasePoints after the fill drawing is done).

If the fill is a channel fill between this graph and another graph (mChannelFillGraph), the more complex polygon is calculated with the getChannelFillPolygon function.

See also:
drawLinePlot
void QCPGraph::drawScatterPlot ( QCPPainter painter,
QVector< QCPData > *  pointData 
) const [protected]

Draws scatter symbols at every data point passed in pointData. scatter symbols are independent of the line style and are always drawn if scatter style is not QCP::ssNone. Hence, the pointData vector is outputted by all "get(...)PlotData" functions, together with the (line style dependent) line data.

See also:
drawLinePlot, drawImpulsePlot
void QCPGraph::drawLinePlot ( QCPPainter painter,
QVector< QPointF > *  lineData 
) const [protected]

Draws line graphs from the provided data. It connects all points in lineData, which was created by one of the "get(...)PlotData" functions for line styles that require simple line connections between the point vector they create. These are for example getLinePlotData, getStepLeftPlotData, getStepRightPlotData and getStepCenterPlotData.

See also:
drawScatterPlot, drawImpulsePlot
void QCPGraph::drawImpulsePlot ( QCPPainter painter,
QVector< QPointF > *  lineData 
) const [protected]

Draws impulses graphs from the provided data, i.e. it connects all line pairs in lineData, which was created by getImpulsePlotData.

See also:
drawScatterPlot, drawLinePlot
void QCPGraph::drawError ( QCPPainter painter,
double  x,
double  y,
const QCPData data 
) const [protected]

called by the scatter drawing function (drawScatterPlot) to draw the error bars on one data point. x and y pixel positions of the data point are passed since they are already known in pixel coordinates in the drawing function, so we save some extra coordToPixel transforms here. data is therefore only used for the errors, not key and value.

void QCPGraph::getVisibleDataBounds ( QCPDataMap::const_iterator &  lower,
QCPDataMap::const_iterator &  upper,
int &  count 
) const [protected]

called by the specific plot data generating functions "get(...)PlotData" to determine which data range is visible, so only that needs to be processed.

Parameters:
[out]lowerreturns an iterator to the lowest data point that needs to be taken into account when plotting. Note that in order to get a clean plot all the way to the edge of the axes, lower may still be outside the visible range.
[out]upperreturns an iterator to the highest data point. Same as before, upper may also lie outside of the visible range.
[out]countnumber of data points that need plotting, i.e. points between lower and upper, including them. This is useful for allocating the array of QPointFs in the specific drawing functions.
void QCPGraph::addFillBasePoints ( QVector< QPointF > *  lineData) const [protected]

The line data vector generated by e.g. getLinePlotData contains only the line that connects the data points. If the graph needs to be filled, two additional points need to be added at the value-zero-line in the lower and upper key positions, the graph reaches. This function calculates these points and adds them to the end of lineData. Since the fill is typically drawn before the line stroke, these added points need to be removed again after the fill is done, with the removeFillBasePoints function.

The expanding of lineData by two points will not cause unnecessary memory reallocations, because the data vector generation functions (getLinePlotData etc.) reserve two extra points when they allocate memory for lineData.

See also:
removeFillBasePoints, lowerFillBasePoint, upperFillBasePoint
void QCPGraph::removeFillBasePoints ( QVector< QPointF > *  lineData) const [protected]

removes the two points from lineData that were added by addFillBasePoints.

See also:
addFillBasePoints, lowerFillBasePoint, upperFillBasePoint
QPointF QCPGraph::lowerFillBasePoint ( double  lowerKey) const [protected]

called by addFillBasePoints to conveniently assign the point which closes the fill polygon on the lower side of the zero-value-line parallel to the key axis. The logarithmic axis scale case is a bit special, since the zero-value-line in pixel coordinates is in positive or negative infinity. So this case is handled separately by just closing the fill polygon on the axis which lies in the direction towards the zero value.

Parameters:
lowerKeypixel position of the lower key of the point. Depending on whether the key axis is horizontal or vertical, lowerKey will end up as the x or y value of the returned point, respectively.
See also:
upperFillBasePoint, addFillBasePoints
QPointF QCPGraph::upperFillBasePoint ( double  upperKey) const [protected]

called by addFillBasePoints to conveniently assign the point which closes the fill polygon on the upper side of the zero-value-line parallel to the key axis. The logarithmic axis scale case is a bit special, since the zero-value-line in pixel coordinates is in positive or negative infinity. So this case is handled separately by just closing the fill polygon on the axis which lies in the direction towards the zero value.

Parameters:
upperKeypixel position of the upper key of the point. Depending on whether the key axis is horizontal or vertical, upperKey will end up as the x or y value of the returned point, respectively.
See also:
lowerFillBasePoint, addFillBasePoints
const QPolygonF QCPGraph::getChannelFillPolygon ( const QVector< QPointF > *  lineData) const [protected]

Generates the polygon needed for drawing channel fills between this graph (data passed via lineData) and the graph specified by mChannelFillGraph (data generated by calling its getPlotData function). May return an empty polygon if the key ranges have no overlap or fill target graph and this graph don't have same orientation (i.e. both key axes horizontal or both key axes vertical). For increased performance (due to implicit sharing), keep the returned QPolygonF const.

int QCPGraph::findIndexBelowX ( const QVector< QPointF > *  data,
double  x 
) const [protected]

Finds the greatest index of data, whose points x value is just below x. Assumes x values in data points are ordered ascending, as is the case when plotting with horizontal key axis. Used to calculate the channel fill polygon, see getChannelFillPolygon.

int QCPGraph::findIndexAboveX ( const QVector< QPointF > *  data,
double  x 
) const [protected]

Finds the smallest index of data, whose points x value is just above x. Assumes x values in data points are ordered ascending, as is the case when plotting with horizontal key axis. Used to calculate the channel fill polygon, see getChannelFillPolygon.

int QCPGraph::findIndexBelowY ( const QVector< QPointF > *  data,
double  y 
) const [protected]

Finds the greatest index of data, whose points y value is just below y. Assumes y values in data points are ordered descending, as is the case when plotting with vertical key axis (since keys are ordered ascending). Used to calculate the channel fill polygon, see getChannelFillPolygon.

int QCPGraph::findIndexAboveY ( const QVector< QPointF > *  data,
double  y 
) const [protected]

Finds the smallest index of data, whose points y value is just above y. Assumes y values in data points are ordered descending, as is the case when plotting with vertical key axis. Used to calculate the channel fill polygon, see getChannelFillPolygon.

double QCPGraph::pointDistance ( const QPointF &  pixelPoint) const [protected]

Calculates the (minimum) distance (in pixels) the graph's representation has from the given pixelPoint in pixels. This is used to determine whether the graph was clicked or not, e.g. in selectTest.

QCPRange QCPGraph::getKeyRange ( bool &  validRange,
SignDomain  inSignDomain = sdBoth 
) const [protected, virtual]

called by rescaleAxes functions to get the full data key bounds. For logarithmic plots, one can set inSignDomain to either sdNegative or sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to sdBoth (default). validRange is an output parameter that indicates whether a proper range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

See also:
rescaleAxes, getValueRange

Implements QCPAbstractPlottable.

QCPRange QCPGraph::getValueRange ( bool &  validRange,
SignDomain  inSignDomain = sdBoth 
) const [protected, virtual]

called by rescaleAxes functions to get the full data value bounds. For logarithmic plots, one can set inSignDomain to either sdNegative or sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to sdBoth (default). validRange is an output parameter that indicates whether a proper range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

See also:
rescaleAxes, getKeyRange

Implements QCPAbstractPlottable.

QCPRange QCPGraph::getKeyRange ( bool &  validRange,
SignDomain  inSignDomain,
bool  includeErrors 
) const [protected, virtual]

This is an overloaded function.

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 [protected, virtual]

This is an overloaded function.

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

See also:
getValueRange(bool &validRange, SignDomain inSignDomain)
void QCPAbstractPlottable::setName ( const QString &  name) [inherited]

The name is the textual representation of this plottable as it is displayed in the QCPLegend of the parent QCustomPlot. It may contain any utf-8 characters, including newlines.

void QCPAbstractPlottable::setAntialiasedFill ( bool  enabled) [inherited]

Sets whether fills of this plottable is drawn antialiased or not.

Note that this setting may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

void QCPAbstractPlottable::setAntialiasedScatters ( bool  enabled) [inherited]

Sets whether the scatter symbols of this plottable are drawn antialiased or not.

Note that this setting may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

void QCPAbstractPlottable::setAntialiasedErrorBars ( bool  enabled) [inherited]

Sets whether the error bars of this plottable are drawn antialiased or not.

Note that this setting may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

void QCPAbstractPlottable::setPen ( const QPen &  pen) [inherited]

The pen is used to draw basic lines that make up the plottable representation in the plot.

For example, the QCPGraph subclass draws its graph lines and scatter points with this pen.

See also:
setBrush
void QCPAbstractPlottable::setSelectedPen ( const QPen &  pen) [inherited]

When the plottable is selected, this pen is used to draw basic lines instead of the normal pen set via setPen.

See also:
setSelected, setSelectable, setSelectedBrush, selectTest
void QCPAbstractPlottable::setBrush ( const QBrush &  brush) [inherited]

The brush is used to draw basic fills of the plottable representation in the plot. The Fill can be a color, gradient or texture, see the usage of QBrush.

For example, the QCPGraph subclass draws the fill under the graph with this brush, when it's not set to Qt::NoBrush.

See also:
setPen
void QCPAbstractPlottable::setSelectedBrush ( const QBrush &  brush) [inherited]

When the plottable is selected, this brush is used to draw fills instead of the normal brush set via setBrush.

See also:
setSelected, setSelectable, setSelectedPen, selectTest
void QCPAbstractPlottable::setKeyAxis ( QCPAxis axis) [inherited]

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. This function performs no checks to make sure this is the case. The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and the y-axis (QCustomPlot::yAxis) as value axis.

Normally, the key and value axes are set in the constructor of the plottable (or QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface).

See also:
setValueAxis
void QCPAbstractPlottable::setValueAxis ( QCPAxis axis) [inherited]

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. This function performs no checks to make sure this is the case. The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and the y-axis (QCustomPlot::yAxis) as value axis.

Normally, the key and value axes are set in the constructor of the plottable (or QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface).

See also:
setKeyAxis
void QCPAbstractPlottable::setSelectable ( bool  selectable) [inherited]

Sets whether the user can (de-)select this plottable by clicking on the QCustomPlot surface. (When QCustomPlot::setInteractions contains iSelectPlottables.)

However, even when selectable was set to false, it is possible to set the selection manually, by calling setSelected directly.

See also:
setSelected
void QCPAbstractPlottable::setSelected ( bool  selected) [inherited]

Sets whether this plottable is selected or not. When selected, it uses a different pen and brush to draw its lines and fills, see setSelectedPen and setSelectedBrush.

The entire selection mechanism for plottables is handled automatically when QCustomPlot::setInteractions contains iSelectPlottables. You only need to call this function when you wish to change the selection state manually.

This function can change the selection state even when setSelectable was set to false.

emits the selectionChanged signal when selected is different from the previous selection state.

See also:
selectTest
void QCPAbstractPlottable::rescaleAxes ( bool  onlyEnlarge = false) const [inherited]

Rescales the key and value axes associated with this plottable to contain all displayed data, so the whole plottable is visible. If the scaling of an axis is logarithmic, rescaleAxes will make sure not to rescale to an illegal range i.e. a range containing different signs and/or zero. Instead it will stay in the current sign domain and ignore all parts of the plottable that lie outside of that domain.

onlyEnlarge makes sure the ranges are only expanded, never reduced. So it's possible to show multiple plottables in their entirety by multiple calls to rescaleAxes where the first call has onlyEnlarge set to false (the default), and all subsequent set to true.

void QCPAbstractPlottable::rescaleKeyAxis ( bool  onlyEnlarge = false) const [inherited]

Rescales the key axis of the plottable so the whole plottable is visible.

See rescaleAxes for detailed behaviour.

void QCPAbstractPlottable::rescaleValueAxis ( bool  onlyEnlarge = false) const [inherited]

Rescales the value axis of the plottable so the whole plottable is visible.

See rescaleAxes for detailed behaviour.

bool QCPAbstractPlottable::addToLegend ( ) [virtual, inherited]

Adds this plottable to the legend of the parent QCustomPlot.

Normally, a QCPPlottableLegendItem is created and inserted into the legend. If the plottable needs a more specialized representation in the plot, this function will take this into account and instead create the specialized subclass of QCPAbstractLegendItem.

Returns true on success, i.e. when a legend item associated with this plottable isn't already in the legend.

See also:
removeFromLegend, QCPLegend::addItem
bool QCPAbstractPlottable::removeFromLegend ( ) const [virtual, inherited]

Removes the plottable from the legend of the parent QCustomPlot. This means the QCPAbstractLegendItem (usually a QCPPlottableLegendItem) that is associated with this plottable is removed.

Returns true on success, i.e. if a legend item associated with this plottable was found and removed from the legend.

See also:
addToLegend, QCPLegend::removeItem
void QCPAbstractPlottable::selectionChanged ( bool  selected) [signal, inherited]

This signal is emitted when the selection state of this plottable has changed, either by user interaction or by a direct call to setSelected.

QRect QCPAbstractPlottable::clipRect ( ) const [protected, virtual, inherited]

Returns the clipping rectangle of this layerable object. By default, this is the viewport of the parent QCustomPlot. Specific subclasses may reimplement this function to provide different clipping rects.

The returned clipping rect is set on the painter before the draw function of the respective object is called.

Reimplemented from QCPLayerable.

void QCPAbstractPlottable::coordsToPixels ( double  key,
double  value,
double &  x,
double &  y 
) const [protected, inherited]

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. whether key represents x or y).

key and value are transformed to the coodinates in pixels and are written to x and y.

See also:
pixelsToCoords, QCPAxis::coordToPixel
const QPointF QCPAbstractPlottable::coordsToPixels ( double  key,
double  value 
) const [protected, inherited]

This is an overloaded function.

Returns the input as pixel coordinates in a QPointF.

void QCPAbstractPlottable::pixelsToCoords ( double  x,
double  y,
double &  key,
double &  value 
) const [protected, inherited]

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. whether key represents x or y).

x and y are transformed to the plot coodinates and are written to key and value.

See also:
coordsToPixels, QCPAxis::coordToPixel
void QCPAbstractPlottable::pixelsToCoords ( const QPointF &  pixelPos,
double &  key,
double &  value 
) const [protected, inherited]

This is an overloaded function.

Returns the pixel input pixelPos as plot coordinates key and value.

QPen QCPAbstractPlottable::mainPen ( ) const [protected, inherited]

Returns the pen that should be used for drawing lines of the plottable. Returns mPen when the graph is not selected and mSelectedPen when it is.

QBrush QCPAbstractPlottable::mainBrush ( ) const [protected, inherited]

Returns the brush that should be used for drawing fills of the plottable. Returns mBrush when the graph is not selected and mSelectedBrush when it is.

void QCPAbstractPlottable::applyDefaultAntialiasingHint ( QCPPainter painter) const [protected, virtual, inherited]

A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable lines.

This is the antialiasing state the painter passed to the draw method is in by default.

This function takes into account the local setting of the antialiasing flag as well as the overrides set e.g. with QCustomPlot::setNotAntialiasedElements.

See also:
setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, applyErrorBarsAntialiasingHint

Implements QCPLayerable.

void QCPAbstractPlottable::applyFillAntialiasingHint ( QCPPainter painter) const [protected, inherited]

A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable fills.

This function takes into account the local setting of the fill antialiasing flag as well as the overrides set e.g. with QCustomPlot::setNotAntialiasedElements.

See also:
setAntialiased, applyDefaultAntialiasingHint, applyScattersAntialiasingHint, applyErrorBarsAntialiasingHint
void QCPAbstractPlottable::applyScattersAntialiasingHint ( QCPPainter painter) const [protected, inherited]

A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable scatter points.

This function takes into account the local setting of the scatters antialiasing flag as well as the overrides set e.g. with QCustomPlot::setNotAntialiasedElements.

See also:
setAntialiased, applyFillAntialiasingHint, applyDefaultAntialiasingHint, applyErrorBarsAntialiasingHint
void QCPAbstractPlottable::applyErrorBarsAntialiasingHint ( QCPPainter painter) const [protected, inherited]

A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable error bars.

This function takes into account the local setting of the error bars antialiasing flag as well as the overrides set e.g. with QCustomPlot::setNotAntialiasedElements.

See also:
setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, applyDefaultAntialiasingHint
double QCPAbstractPlottable::distSqrToLine ( const QPointF &  start,
const QPointF &  end,
const QPointF &  point 
) const [protected, inherited]

Finds the shortest squared distance of point to the line segment defined by start and end.

This function may be used to help with the implementation of the selectTest function for specific plottables.

Note:
This function is identical to QCPAbstractItem::distSqrToLine
void QCPLayerable::setVisible ( bool  on) [inherited]

Sets the visibility of this layerable object. If an object is not visible, it will not be drawn on the QCustomPlot surface, and user interaction with it (e.g. click/selection) is not possible.

bool QCPLayerable::setLayer ( QCPLayer layer) [inherited]

Sets the layer of this layerable object. The object will be placed on top of the other objects already on layer.

Returns true on success, i.e. if layer is a valid layer.

bool QCPLayerable::setLayer ( const QString &  layerName) [inherited]

This is an overloaded function.

Sets the layer of this layerable object by name

Returns true on success, i.e. if layerName is a valid layer name.

void QCPLayerable::setAntialiased ( bool  enabled) [inherited]

Sets whether this object will be drawn antialiased or not.

Note that antialiasing settings may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

bool QCPLayerable::moveToLayer ( QCPLayer layer,
bool  prepend 
) [protected, inherited]

Moves this layerable object to layer. If prepend is true, this object will be prepended to the new layer's list, i.e. it will be drawn below the objects already on the layer. If it is false, the object will be appended.

Returns true on success, i.e. if layer is a valid layer.

void QCPLayerable::applyAntialiasingHint ( QCPPainter painter,
bool  localAntialiased,
QCP::AntialiasedElement  overrideElement 
) const [protected, inherited]

Sets the QPainter::Antialiasing render hint on the provided painter, depending on the localAntialiased value as well as the overrides QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements. Which override enum this function takes into account is controlled via overrideElement.


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