Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
QCPGraph Class Reference

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

#include <qcustomplot.h>

Inheritance diagram for QCPGraph:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

bool adaptiveSampling () const
 
void addData (const QVector< double > &keys, const QVector< double > &values, bool alreadySorted=false)
 
void addData (double key, double value)
 
QCPGraphchannelFillGraph () const
 
QSharedPointer< QCPGraphDataContainerdata () const
 
virtual QCPRange getKeyRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth) const Q_DECL_OVERRIDE
 
virtual QCPRange getValueRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth, const QCPRange &inKeyRange=QCPRange()) const Q_DECL_OVERRIDE
 
LineStyle lineStyle () const
 
 QCPGraph (QCPAxis *keyAxis, QCPAxis *valueAxis)
 
int scatterSkip () const
 
QCPScatterStyle scatterStyle () const
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE
 
void setAdaptiveSampling (bool enabled)
 
void setChannelFillGraph (QCPGraph *targetGraph)
 
void setData (QSharedPointer< QCPGraphDataContainer > data)
 
void setData (const QVector< double > &keys, const QVector< double > &values, bool alreadySorted=false)
 
void setLineStyle (LineStyle ls)
 
void setScatterSkip (int skip)
 
void setScatterStyle (const QCPScatterStyle &style)
 
virtual ~QCPGraph ()
 
- Public Member Functions inherited from QCPAbstractPlottable1D< QCPGraphData >
virtual int dataCount () const Q_DECL_OVERRIDE
 
virtual double dataMainKey (int index) const Q_DECL_OVERRIDE
 
virtual double dataMainValue (int index) const Q_DECL_OVERRIDE
 
virtual QPointF dataPixelPosition (int index) const Q_DECL_OVERRIDE
 
virtual double dataSortKey (int index) const Q_DECL_OVERRIDE
 
virtual QCPRange dataValueRange (int index) const Q_DECL_OVERRIDE
 
virtual int findBegin (double sortKey, bool expandedRange=true) const Q_DECL_OVERRIDE
 
virtual int findEnd (double sortKey, bool expandedRange=true) const Q_DECL_OVERRIDE
 
virtual QCPPlottableInterface1Dinterface1D () Q_DECL_OVERRIDE
 
 QCPAbstractPlottable1D (QCPAxis *keyAxis, QCPAxis *valueAxis)
 
virtual QCPDataSelection selectTestRect (const QRectF &rect, bool onlySelectable) const Q_DECL_OVERRIDE
 
virtual bool sortKeyIsMainKey () const Q_DECL_OVERRIDE
 
virtual ~QCPAbstractPlottable1D ()
 
- Public Member Functions inherited from QCPAbstractPlottable
bool addToLegend (QCPLegend *legend)
 
bool addToLegend ()
 
bool antialiasedFill () const
 
bool antialiasedScatters () const
 
QBrush brush () const
 
void coordsToPixels (double key, double value, double &x, double &y) const
 
const QPointF coordsToPixels (double key, double value) const
 
QCPAxiskeyAxis () const
 
QString name () const
 
QPen pen () const
 
void pixelsToCoords (double x, double y, double &key, double &value) const
 
void pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const
 
 QCPAbstractPlottable (QCPAxis *keyAxis, QCPAxis *valueAxis)
 
bool removeFromLegend (QCPLegend *legend) const
 
bool removeFromLegend () const
 
void rescaleAxes (bool onlyEnlarge=false) const
 
void rescaleKeyAxis (bool onlyEnlarge=false) const
 
void rescaleValueAxis (bool onlyEnlarge=false, bool inKeyRange=false) const
 
QCP::SelectionType selectable () const
 
bool selected () const
 
QCPDataSelection selection () const
 
QCPSelectionDecoratorselectionDecorator () const
 
void setAntialiasedFill (bool enabled)
 
void setAntialiasedScatters (bool enabled)
 
void setBrush (const QBrush &brush)
 
void setKeyAxis (QCPAxis *axis)
 
void setName (const QString &name)
 
void setPen (const QPen &pen)
 
Q_SLOT void setSelectable (QCP::SelectionType selectable)
 
Q_SLOT void setSelection (QCPDataSelection selection)
 
void setSelectionDecorator (QCPSelectionDecorator *decorator)
 
void setValueAxis (QCPAxis *axis)
 
QCPAxisvalueAxis () const
 
virtual ~QCPAbstractPlottable ()
 
- Public Member Functions inherited from QCPLayerable
bool antialiased () const
 
QCPLayerlayer () const
 
QCPLayerableparentLayerable () const
 
QCustomPlotparentPlot () const
 
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 
bool realVisibility () const
 
void setAntialiased (bool enabled)
 
Q_SLOT bool setLayer (QCPLayer *layer)
 
bool setLayer (const QString &layerName)
 
void setVisible (bool on)
 
bool visible () const
 
virtual ~QCPLayerable ()
 
- Public Member Functions inherited from QCPPlottableInterface1D
virtual ~QCPPlottableInterface1D ()
 

Protected Member Functions

QVector< QPointF > dataToImpulseLines (const QVector< QCPGraphData > &data) const
 
QVector< QPointF > dataToLines (const QVector< QCPGraphData > &data) const
 
QVector< QPointF > dataToStepCenterLines (const QVector< QCPGraphData > &data) const
 
QVector< QPointF > dataToStepLeftLines (const QVector< QCPGraphData > &data) const
 
QVector< QPointF > dataToStepRightLines (const QVector< QCPGraphData > &data) const
 
virtual void draw (QCPPainter *painter) Q_DECL_OVERRIDE
 
virtual void drawFill (QCPPainter *painter, QVector< QPointF > *lines) const
 
virtual void drawImpulsePlot (QCPPainter *painter, const QVector< QPointF > &lines) const
 
virtual void drawLegendIcon (QCPPainter *painter, const QRectF &rect) const Q_DECL_OVERRIDE
 
virtual void drawLinePlot (QCPPainter *painter, const QVector< QPointF > &lines) const
 
virtual void drawScatterPlot (QCPPainter *painter, const QVector< QPointF > &scatters, const QCPScatterStyle &style) const
 
int findIndexAboveX (const QVector< QPointF > *data, double x) const
 
int findIndexAboveY (const QVector< QPointF > *data, double y) const
 
int findIndexBelowX (const QVector< QPointF > *data, double x) const
 
int findIndexBelowY (const QVector< QPointF > *data, double y) const
 
const QPolygonF getChannelFillPolygon (const QVector< QPointF > *lineData, QCPDataRange thisSegment, const QVector< QPointF > *otherData, QCPDataRange otherSegment) const
 
QPointF getFillBasePoint (QPointF matchingDataPoint) const
 
const QPolygonF getFillPolygon (const QVector< QPointF > *lineData, QCPDataRange segment) const
 
void getLines (QVector< QPointF > *lines, const QCPDataRange &dataRange) const
 
QVector< QCPDataRangegetNonNanSegments (const QVector< QPointF > *lineData, Qt::Orientation keyOrientation) const
 
virtual void getOptimizedLineData (QVector< QCPGraphData > *lineData, const QCPGraphDataContainer::const_iterator &begin, const QCPGraphDataContainer::const_iterator &end) const
 
virtual void getOptimizedScatterData (QVector< QCPGraphData > *scatterData, QCPGraphDataContainer::const_iterator begin, QCPGraphDataContainer::const_iterator end) const
 
QVector< QPair< QCPDataRange, QCPDataRange > > getOverlappingSegments (QVector< QCPDataRange > thisSegments, const QVector< QPointF > *thisData, QVector< QCPDataRange > otherSegments, const QVector< QPointF > *otherData) const
 
void getScatters (QVector< QPointF > *scatters, const QCPDataRange &dataRange) const
 
void getVisibleDataBounds (QCPGraphDataContainer::const_iterator &begin, QCPGraphDataContainer::const_iterator &end, const QCPDataRange &rangeRestriction) const
 
double pointDistance (const QPointF &pixelPoint, QCPGraphDataContainer::const_iterator &closestData) const
 
bool segmentsIntersect (double aLower, double aUpper, double bLower, double bUpper, int &bPrecedence) const
 
- Protected Member Functions inherited from QCPAbstractPlottable1D< QCPGraphData >
void drawPolyline (QCPPainter *painter, const QVector< QPointF > &lineData) const
 
void getDataSegments (QList< QCPDataRange > &selectedSegments, QList< QCPDataRange > &unselectedSegments) const
 
- Protected Member Functions inherited from QCPAbstractPlottable
void applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE
 
void applyFillAntialiasingHint (QCPPainter *painter) const
 
void applyScattersAntialiasingHint (QCPPainter *painter) const
 
virtual QRect clipRect () const Q_DECL_OVERRIDE
 
virtual void deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) Q_DECL_OVERRIDE
 
virtual QCP::Interaction selectionCategory () const Q_DECL_OVERRIDE
 
- Protected Member Functions inherited from QCPLayerable
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
 
void initializeParentPlot (QCustomPlot *parentPlot)
 
virtual void mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)
 
virtual void mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)
 
virtual void mousePressEvent (QMouseEvent *event, const QVariant &details)
 
virtual void mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)
 
bool moveToLayer (QCPLayer *layer, bool prepend)
 
virtual void parentPlotInitialized (QCustomPlot *parentPlot)
 
void setParentLayerable (QCPLayerable *parentLayerable)
 
virtual void wheelEvent (QWheelEvent *event)
 

Protected Attributes

bool mAdaptiveSampling
 
QPointer< QCPGraphmChannelFillGraph
 
LineStyle mLineStyle
 
int mScatterSkip
 
QCPScatterStyle mScatterStyle
 
- Protected Attributes inherited from QCPAbstractPlottable1D< QCPGraphData >
QSharedPointer< QCPDataContainer< QCPGraphData > > mDataContainer
 
- Protected Attributes inherited from QCPAbstractPlottable
bool mAntialiasedFill
 
bool mAntialiasedScatters
 
QBrush mBrush
 
QPointer< QCPAxismKeyAxis
 
QString mName
 
QPen mPen
 
QCP::SelectionType mSelectable
 
QCPDataSelection mSelection
 
QCPSelectionDecoratormSelectionDecorator
 
QPointer< QCPAxismValueAxis
 
- Protected Attributes inherited from QCPLayerable
bool mAntialiased
 
QCPLayermLayer
 
QPointer< QCPLayerablemParentLayerable
 
QCustomPlotmParentPlot
 
bool mVisible
 

Friends

class QCPLegend
 
class QCustomPlot
 

Additional Inherited Members

- Signals inherited from QCPAbstractPlottable
void selectableChanged (QCP::SelectionType selectable)
 
void selectionChanged (bool selected)
 
void selectionChanged (const QCPDataSelection &selection)
 
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 

Detailed Description

A plottable representing a graph in a plot.

QCPGraph.png

Usually you create new graphs by calling QCustomPlot::addGraph. The resulting instance can be accessed via QCustomPlot::graph.

To plot data, assign it with the setData or addData functions. Alternatively, you can also access and modify the data via the data method, which returns a pointer to the internal QCPGraphDataContainer.

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.

Gaps in the graph line can be created by adding data points with NaN as value (qQNaN() or std::numeric_limits<double>::quiet_NaN()) in between the two data points that shall be separated.

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

Definition at line 5163 of file qcustomplot.h.

Member Enumeration Documentation

◆ 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

Definition at line 5179 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPGraph()

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 created QCPGraph is automatically registered with the QCustomPlot instance inferred from keyAxis. This QCustomPlot instance takes ownership of the QCPGraph, so do not delete it manually but use QCustomPlot::removePlottable() instead.

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

Definition at line 20108 of file qcustomplot.cpp.

◆ ~QCPGraph()

QCPGraph::~QCPGraph ( )
virtual

Definition at line 20123 of file qcustomplot.cpp.

Member Function Documentation

◆ adaptiveSampling()

bool QCPGraph::adaptiveSampling ( ) const
inline

Definition at line 5198 of file qcustomplot.h.

◆ addData() [1/2]

void QCPGraph::addData ( const QVector< double > &  keys,
const QVector< double > &  values,
bool  alreadySorted = false 
)

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 points in keys and values to the current data. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

If you can guarantee that the passed data points are sorted by keys in ascending order, you can set alreadySorted to true, to improve performance by saving a sorting run.

Alternatively, you can also access and modify the data directly via the data method, which returns a pointer to the internal data container.

Definition at line 20279 of file qcustomplot.cpp.

◆ addData() [2/2]

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 data point as key and value to the current data.

Alternatively, you can also access and modify the data directly via the data method, which returns a pointer to the internal data container.

Definition at line 20305 of file qcustomplot.cpp.

◆ channelFillGraph()

QCPGraph* QCPGraph::channelFillGraph ( ) const
inline

Definition at line 5197 of file qcustomplot.h.

◆ data()

QSharedPointer< QCPGraphDataContainer > QCPGraph::data ( ) const
inline

Returns a shared pointer to the internal data storage of type QCPGraphDataContainer. You may use it to directly manipulate the data, which may be more convenient and faster than using the regular setData or addData methods.

Definition at line 5193 of file qcustomplot.h.

◆ dataToImpulseLines()

QVector< QPointF > QCPGraph::dataToImpulseLines ( const QVector< QCPGraphData > &  data) const
protected

Definition at line 20764 of file qcustomplot.cpp.

◆ dataToLines()

QVector< QPointF > QCPGraph::dataToLines ( const QVector< QCPGraphData > &  data) const
protected

Definition at line 20570 of file qcustomplot.cpp.

◆ dataToStepCenterLines()

QVector< QPointF > QCPGraph::dataToStepCenterLines ( const QVector< QCPGraphData > &  data) const
protected

Definition at line 20704 of file qcustomplot.cpp.

◆ dataToStepLeftLines()

QVector< QPointF > QCPGraph::dataToStepLeftLines ( const QVector< QCPGraphData > &  data) const
protected

Definition at line 20608 of file qcustomplot.cpp.

◆ dataToStepRightLines()

QVector< QPointF > QCPGraph::dataToStepRightLines ( const QVector< QCPGraphData > &  data) const
protected

Definition at line 20656 of file qcustomplot.cpp.

◆ draw()

void QCPGraph::draw ( QCPPainter painter)
protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 20352 of file qcustomplot.cpp.

◆ drawFill()

void QCPGraph::drawFill ( QCPPainter painter,
QVector< QPointF > *  lines 
) const
protectedvirtual

Definition at line 20815 of file qcustomplot.cpp.

◆ drawImpulsePlot()

void QCPGraph::drawImpulsePlot ( QCPPainter painter,
const QVector< QPointF > &  lines 
) const
protectedvirtual

Definition at line 20880 of file qcustomplot.cpp.

◆ drawLegendIcon()

void QCPGraph::drawLegendIcon ( QCPPainter painter,
const QRectF &  rect 
) const
protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 20420 of file qcustomplot.cpp.

◆ drawLinePlot()

void QCPGraph::drawLinePlot ( QCPPainter painter,
const QVector< QPointF > &  lines 
) const
protectedvirtual

Definition at line 20863 of file qcustomplot.cpp.

◆ drawScatterPlot()

void QCPGraph::drawScatterPlot ( QCPPainter painter,
const QVector< QPointF > &  scatters,
const QCPScatterStyle style 
) const
protectedvirtual

Definition at line 20849 of file qcustomplot.cpp.

◆ findIndexAboveX()

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

Definition at line 21560 of file qcustomplot.cpp.

◆ findIndexAboveY()

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

Definition at line 21606 of file qcustomplot.cpp.

◆ findIndexBelowX()

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

Definition at line 21583 of file qcustomplot.cpp.

◆ findIndexBelowY()

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

Definition at line 21688 of file qcustomplot.cpp.

◆ getChannelFillPolygon()

const QPolygonF QCPGraph::getChannelFillPolygon ( const QVector< QPointF > *  lineData,
QCPDataRange  thisSegment,
const QVector< QPointF > *  otherData,
QCPDataRange  otherSegment 
) const
protected

Definition at line 21453 of file qcustomplot.cpp.

◆ getFillBasePoint()

QPointF QCPGraph::getFillBasePoint ( QPointF  matchingDataPoint) const
protected

Definition at line 21363 of file qcustomplot.cpp.

◆ getFillPolygon()

const QPolygonF QCPGraph::getFillPolygon ( const QVector< QPointF > *  lineData,
QCPDataRange  segment 
) const
protected

Definition at line 21422 of file qcustomplot.cpp.

◆ getKeyRange()

QCPRange QCPGraph::getKeyRange ( bool &  foundRange,
QCP::SignDomain  inSignDomain = QCP::sdBoth 
) const
virtual

Returns the coordinate range that all data in this plottable span in the key axis dimension. For logarithmic plots, one can set inSignDomain to either QCP::sdNegative or QCP::sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to QCP::sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to QCP::sdBoth (default). foundRange is an output parameter that indicates whether a range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

Note that foundRange is not the same as QCPRange::validRange, since the range returned by this function may have size zero (e.g. when there is only one data point). In this case foundRange would return true, but the returned range is not a valid range in terms of QCPRange::validRange.

See also
rescaleAxes, getValueRange

Implements QCPAbstractPlottable.

Definition at line 20340 of file qcustomplot.cpp.

◆ getLines()

void QCPGraph::getLines ( QVector< QPointF > *  lines,
const QCPDataRange dataRange 
) const
protected

Definition at line 20474 of file qcustomplot.cpp.

◆ getNonNanSegments()

QVector< QCPDataRange > QCPGraph::getNonNanSegments ( const QVector< QPointF > *  lineData,
Qt::Orientation  keyOrientation 
) const
protected

Definition at line 21209 of file qcustomplot.cpp.

◆ getOptimizedLineData()

void QCPGraph::getOptimizedLineData ( QVector< QCPGraphData > *  lineData,
const QCPGraphDataContainer::const_iterator begin,
const QCPGraphDataContainer::const_iterator end 
) const
protectedvirtual

Definition at line 20906 of file qcustomplot.cpp.

◆ getOptimizedScatterData()

void QCPGraph::getOptimizedScatterData ( QVector< QCPGraphData > *  scatterData,
QCPGraphDataContainer::const_iterator  begin,
QCPGraphDataContainer::const_iterator  end 
) const
protectedvirtual

Definition at line 20998 of file qcustomplot.cpp.

◆ getOverlappingSegments()

QVector< QPair< QCPDataRange, QCPDataRange > > QCPGraph::getOverlappingSegments ( QVector< QCPDataRange thisSegments,
const QVector< QPointF > *  thisData,
QVector< QCPDataRange otherSegments,
const QVector< QPointF > *  otherData 
) const
protected

Definition at line 21267 of file qcustomplot.cpp.

◆ getScatters()

void QCPGraph::getScatters ( QVector< QPointF > *  scatters,
const QCPDataRange dataRange 
) const
protected

Definition at line 20515 of file qcustomplot.cpp.

◆ getValueRange()

QCPRange QCPGraph::getValueRange ( bool &  foundRange,
QCP::SignDomain  inSignDomain = QCP::sdBoth,
const QCPRange inKeyRange = QCPRange() 
) const
virtual

Returns the coordinate range that the data points in the specified key range (inKeyRange) span in the value axis dimension. For logarithmic plots, one can set inSignDomain to either QCP::sdNegative or QCP::sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to QCP::sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to QCP::sdBoth (default). foundRange is an output parameter that indicates whether a range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

If inKeyRange has both lower and upper bound set to zero (is equal to QCPRange()), all data points are considered, without any restriction on the keys.

Note that foundRange is not the same as QCPRange::validRange, since the range returned by this function may have size zero (e.g. when there is only one data point). In this case foundRange would return true, but the returned range is not a valid range in terms of QCPRange::validRange.

See also
rescaleAxes, getKeyRange

Implements QCPAbstractPlottable.

Definition at line 20346 of file qcustomplot.cpp.

◆ getVisibleDataBounds()

void QCPGraph::getVisibleDataBounds ( QCPGraphDataContainer::const_iterator begin,
QCPGraphDataContainer::const_iterator end,
const QCPDataRange rangeRestriction 
) const
protected

This method outputs the currently visible data range via begin and end. The returned range will also never exceed rangeRestriction.

This method takes into account that the drawing of data lines at the axis rect border always requires the points just outside the visible axis range. So begin and end may actually indicate a range that contains one additional data point to the left and right of the visible axis range.

Definition at line 21179 of file qcustomplot.cpp.

◆ lineStyle()

LineStyle QCPGraph::lineStyle ( ) const
inline

Definition at line 5194 of file qcustomplot.h.

◆ pointDistance()

double QCPGraph::pointDistance ( const QPointF &  pixelPoint,
QCPGraphDataContainer::const_iterator closestData 
) const
protected

Definition at line 21632 of file qcustomplot.cpp.

◆ scatterSkip()

int QCPGraph::scatterSkip ( ) const
inline

Definition at line 5196 of file qcustomplot.h.

◆ scatterStyle()

QCPScatterStyle QCPGraph::scatterStyle ( ) const
inline

Definition at line 5195 of file qcustomplot.h.

◆ segmentsIntersect()

bool QCPGraph::segmentsIntersect ( double  aLower,
double  aUpper,
double  bLower,
double  bUpper,
int bPrecedence 
) const
protected

Definition at line 21330 of file qcustomplot.cpp.

◆ selectTest()

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

Implements a selectTest specific to this plottable's point geometry.

If details is not 0, it will be set to a QCPDataSelection, describing the closest data point to pos.

QCPAbstractPlottable::selectTest

Reimplemented from QCPAbstractPlottable1D< QCPGraphData >.

Definition at line 20318 of file qcustomplot.cpp.

◆ setAdaptiveSampling()

void QCPGraph::setAdaptiveSampling ( bool  enabled)

Sets whether adaptive sampling shall be used when plotting this graph. QCustomPlot's adaptive sampling technique can drastically improve the replot performance for graphs with a larger number of points (e.g. above 10,000), without notably changing the appearance of the graph.

By default, adaptive sampling is enabled. Even if enabled, QCustomPlot decides whether adaptive sampling shall actually be used on a per-graph basis. So leaving adaptive sampling enabled has no disadvantage in almost all cases.

adaptive-sampling-line.png
A line plot of 500,000 points without and with adaptive sampling

As can be seen, line plots experience no visual degradation from adaptive sampling. Outliers are reproduced reliably, as well as the overall shape of the data set. The replot time reduces dramatically though. This allows QCustomPlot to display large amounts of data in realtime.

adaptive-sampling-scatter.png
A scatter plot of 100,000 points without and with adaptive sampling

Care must be taken when using high-density scatter plots in combination with adaptive sampling. The adaptive sampling algorithm treats scatter plots more carefully than line plots which still gives a significant reduction of replot times, but not quite as much as for line plots. This is because scatter plots inherently need more data points to be preserved in order to still resemble the original, non-adaptive-sampling plot. As shown above, the results still aren't quite identical, as banding occurs for the outer data points. This is in fact intentional, such that the boundaries of the data cloud stay visible to the viewer. How strong the banding appears, depends on the point density, i.e. the number of points in the plot.

For some situations with scatter plots it might thus be desirable to manually turn adaptive sampling off. For example, when saving the plot to disk. This can be achieved by setting enabled to false before issuing a command like QCustomPlot::savePng, and setting enabled back to true afterwards.

Definition at line 20262 of file qcustomplot.cpp.

◆ setChannelFillGraph()

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

Definition at line 20211 of file qcustomplot.cpp.

◆ setData() [1/2]

void QCPGraph::setData ( QSharedPointer< QCPGraphDataContainer data)

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 container with the provided data container.

Since a QSharedPointer is used, multiple QCPGraphs may share the same data container safely. Modifying the data in the container will then affect all graphs that share the container. Sharing can be achieved by simply exchanging the data containers wrapped in shared pointers:

If you do not wish to share containers, but create a copy from an existing container, rather use the QCPDataContainer<DataType>::set method on the graph's data container directly:

See also
addData

Definition at line 20142 of file qcustomplot.cpp.

◆ setData() [2/2]

void QCPGraph::setData ( const QVector< double > &  keys,
const QVector< double > &  values,
bool  alreadySorted = false 
)

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 keys and values. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

If you can guarantee that the passed data points are sorted by keys in ascending order, you can set alreadySorted to true, to improve performance by saving a sorting run.

See also
addData

Definition at line 20158 of file qcustomplot.cpp.

◆ setLineStyle()

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

Definition at line 20170 of file qcustomplot.cpp.

◆ setScatterSkip()

void QCPGraph::setScatterSkip ( int  skip)

If scatters are displayed (scatter style not QCPScatterStyle::ssNone), skip number of scatter points are skipped/not drawn after every drawn scatter point.

This can be used to make the data appear sparser while for example still having a smooth line, and to improve performance for very high density plots.

If skip is set to 0 (default), all scatter points are drawn.

See also
setScatterStyle

Definition at line 20197 of file qcustomplot.cpp.

◆ 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

Definition at line 20181 of file qcustomplot.cpp.

Friends And Related Function Documentation

◆ QCPLegend

friend class QCPLegend
friend

Definition at line 5261 of file qcustomplot.h.

◆ QCustomPlot

friend class QCustomPlot
friend

Definition at line 5260 of file qcustomplot.h.

Member Data Documentation

◆ mAdaptiveSampling

bool QCPGraph::mAdaptiveSampling
protected

Definition at line 5224 of file qcustomplot.h.

◆ mChannelFillGraph

QPointer<QCPGraph> QCPGraph::mChannelFillGraph
protected

Definition at line 5223 of file qcustomplot.h.

◆ mLineStyle

LineStyle QCPGraph::mLineStyle
protected

Definition at line 5220 of file qcustomplot.h.

◆ mScatterSkip

int QCPGraph::mScatterSkip
protected

Definition at line 5222 of file qcustomplot.h.

◆ mScatterStyle

QCPScatterStyle QCPGraph::mScatterStyle
protected

Definition at line 5221 of file qcustomplot.h.


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


control_box_rst
Author(s): Christoph Rösmann
autogenerated on Mon Feb 28 2022 22:08:01