JKQTPlotter
an extensive Qt4/Qt5 Plotter framework (including a fast variant and a LaTeX equation renderer!), written fully in C/C++ and without external dependencies

This virtual JKQTPGraph descendent may be used as base for all graphs that use at least two columns that specify x and y coordinates for the single plot points. More...

#include <jkqtpgraphsbase.h>

Inheritance diagram for JKQTPXYGraph:
Collaboration diagram for JKQTPXYGraph:

Public Types

enum  DataSortOrder {
  Unsorted =0,
  SortedX =1,
  SortedY =2
}
 specifies how to sort the data in a JKQTPXYGraph before drawing More...
 
- Public Types inherited from JKQTPPlotElement
enum  HitTestMode {
  HitTestXY,
  HitTestXOnly,
  HitTestYOnly
}
 modes of operation for the function hitTest() More...
 

Public Member Functions

 JKQTPXYGraph (JKQTBasePlotter *parent=nullptr)
 class constructor More...
 
 JKQTPXYGraph (JKQTPlotter *parent)
 class constructor More...
 
DataSortOrder getDataSortOrder () const
 if !=Unsorted, the data is sorted before plotting More...
 
int getXColumn () const
 the column that contains the x-component of the datapoints More...
 
virtual bool getXMinMax (double &minx, double &maxx, double &smallestGreaterZero) override
 get the maximum and minimum x-value of the graph More...
 
int getYColumn () const
 the column that contains the y-component of the datapoints More...
 
virtual bool getYMinMax (double &miny, double &maxy, double &smallestGreaterZero) override
 get the maximum and minimum y-value of the graph More...
 
virtual double hitTest (const QPointF &posSystem, QPointF *closestSpotSystem=nullptr, QString *label=nullptr, HitTestMode mode=HitTestXY) const override
 Implmentation of JKQTPPlotElement::hitTest(), which searches through all graph points defined by xColumn and yColumn and returns a general x/y-label, also taking into account possibly known errors to the graphs (if it is derived from JKQTPXGraphErrorData and/or JKQTPYGraphErrorData. More...
 
void setDataSortOrder (DataSortOrder __value)
 if !=Unsorted, the data is sorted before plotting More...
 
void setDataSortOrder (int __value)
 if !=Unsorted, the data is sorted before plotting More...
 
void setXColumn (int __value)
 the column that contains the x-component of the datapoints More...
 
void setXColumn (size_t __value)
 the column that contains the x-component of the datapoints More...
 
void setXYColumns (int xCol, int yCol)
 sets xColumn and yColumn at the same time More...
 
void setXYColumns (QPair< int, int > xyColPair)
 sets xColumn and yColumn at the same time More...
 
void setXYColumns (QPair< size_t, size_t > xyColPair)
 sets xColumn and yColumn at the same time More...
 
void setXYColumns (size_t xCol, size_t yCol)
 sets xColumn and yColumn at the same time More...
 
void setXYColumns (std::pair< int, int > xyColPair)
 sets xColumn and yColumn at the same time More...
 
void setXYColumns (std::pair< size_t, size_t > xyColPair)
 sets xColumn and yColumn at the same time More...
 
void setYColumn (int __value)
 the column that contains the y-component of the datapoints More...
 
void setYColumn (size_t __value)
 the column that contains the y-component of the datapoints More...
 
virtual bool usesColumn (int column) const override
 returns true if the given column is used by the graph More...
 
- Public Member Functions inherited from JKQTPGraph
 JKQTPGraph (JKQTBasePlotter *parent=nullptr)
 class constructor More...
 
 JKQTPGraph (JKQTPlotter *parent)
 class constructor More...
 
virtual ~JKQTPGraph ()=default
 default wirtual destructor More...
 
- Public Member Functions inherited from JKQTPPlotElement
 JKQTPPlotElement (JKQTBasePlotter *parent=nullptr)
 class constructor More...
 
 JKQTPPlotElement (JKQTPlotter *parent)
 class constructor More...
 
virtual ~JKQTPPlotElement ()=default
 default wirtual destructor More...
 
virtual void draw (JKQTPEnhancedPainter &painter)=0
 plots the graph to the plotter object specified as parent More...
 
virtual void drawKeyMarker (JKQTPEnhancedPainter &painter, QRectF &rect)=0
 plots a key marker inside the specified rectangle rect More...
 
virtual void drawOutside (JKQTPEnhancedPainter &painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace)
 plots outside the actual plot field of view (e.g. color bars, scale bars, ...) More...
 
QImage generateKeyMarker (QSize size=QSize(16, 16))
 returns an image with a key marker inside
More...
 
virtual QColor getKeyLabelColor () const =0
 returns the color to be used for the key label More...
 
virtual void getOutsideSize (JKQTPEnhancedPainter &painter, int &leftSpace, int &rightSpace, int &topSpace, int &bottomSpace)
 if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...) More...
 
JKQTBasePlottergetParent ()
 returns the parent painter class More...
 
virtual QString getTitle () const
 returns the the title of the plot More...
 
virtual bool isHighlighted () const
 returns whether the graph is shown in a highlighted style in the plot More...
 
virtual bool isVisible () const
 returns whether the graph is visible in the plot More...
 
virtual void setHighlighted (bool __value)
 sets whether the graph is drawn in a highlighted style in the plot More...
 
virtual void setParent (JKQTBasePlotter *parent)
 sets the parent painter class More...
 
virtual void setParent (JKQTPlotter *parent)
 sets the parent painter class More...
 
virtual void setTitle (const QString &__value)
 sets the title of the plot (for display in key!). More...
 
virtual void setVisible (bool __value)
 sets whether the graph is visible in the plot More...
 

Protected Member Functions

int getDataIndex (int i)
 returns the index of the i-th datapoint (where i is an index into the SORTED datapoints) More...
 
virtual bool getIndexRange (int &imin, int &imax) const
 determines the range of row indexes available in the data columns of this graph More...
 
virtual void intSortData ()
 
- Protected Member Functions inherited from JKQTPGraph
virtual void drawErrorsAfter (JKQTPEnhancedPainter &)
 this function is used to plot error inidcators after plotting the graphs. More...
 
virtual void drawErrorsBefore (JKQTPEnhancedPainter &)
 this function is used to plot error inidcators before plotting the graphs. More...
 
bool getDataMinMax (int column, double &minx, double &maxx, double &smallestGreaterZero)
 get the maximum and minimum value of the given column More...
 
- Protected Member Functions inherited from JKQTPPlotElement
void addHitTestData (const HitTestLocation &loc)
 clear the internal datastore for hitTest() More...
 
void addHitTestData (const QPointF &pos_, const QString &label_)
 clear the internal datastore for hitTest() More...
 
void addHitTestData (const QPointF &pos_, int index_, const QString &label_)
 clear the internal datastore for hitTest() More...
 
void addHitTestData (const QPointF &pos_, int index_=-1, JKQTPDatastore *datastore=nullptr)
 clear the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label More...
 
void addHitTestData (double x_, double y_, const QString &label_)
 add a new point on the graph to the internal datastore for hitTest() More...
 
void addHitTestData (double x_, double y_, int index_, const QString &label_)
 clear the internal datastore for hitTest() More...
 
void addHitTestData (double x_, double y_, int index_=-1, JKQTPDatastore *datastore=nullptr)
 add a new point on the graph to the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label More...
 
QPointF backTransform (const QPointF &x) const
 tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate) More...
 
QPointF backTransform (double x, double y) const
 tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate) More...
 
virtual double backtransformX (double x) const
 tool routine that backtransforms an x-coordinate (pixels --> plot coordinate) for this plot element More...
 
virtual double backtransformY (double y) const
 tool routine that backtransforms a y-coordinate (pixels --> plot coordinate) for this plot element More...
 
void clearHitTestData ()
 clear the internal datastore for hitTest() More...
 
virtual QString formatHitTestDefaultLabel (double x, double y, int index=-1, JKQTPDatastore *datastore=nullptr) const
 tool-function for hitTest(), which formats a default label, taking into account the x- and y-position (both provided) and optionally the errors of these positions. More...
 
void reserveHitTestData (int points)
 reserve list entries for up to points graph points in the internal datastore for hitTest() More...
 
QPointF transform (const QPointF &x) const
 tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels) More...
 
QVector< QPointF > transform (const QVector< QPointF > &x) const
 tool routine that transforms a QVector<QPointF> according to the parent's transformation rules (plot coordinate --> pixels) More...
 
QPointF transform (double x, double y) const
 tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels) More...
 
QPainterPath transformToLinePath (const QVector< QPointF > &x) const
 tool routine that transforms a QVector<QPointF> according to the parent's transformation rules and returns a (non-closed) path consisting of lines (plot coordinate --> pixels) More...
 
QPolygonF transformToPolygon (const QVector< QPointF > &x) const
 tool routine that transforms a QVector<QPointF> according to the parent's transformation rules and returns a polygon (plot coordinate --> pixels) More...
 
QVector< double > transformX (const QVector< double > &x) const
 transform all x-coordinates in a vector x More...
 
virtual double transformX (double x) const
 tool routine that transforms an x-coordinate (plot coordinate --> pixels) for this plot element More...
 
QVector< double > transformY (const QVector< double > &x) const
 transform all y-coordinates in a vector x More...
 
virtual double transformY (double y) const
 tool routine that transforms a y-coordinate (plot coordinate --> pixels) for this plot element More...
 

Protected Attributes

DataSortOrder sortData
 if !=Unsorted, the data is sorted before plotting More...
 
QVector< int > sortedIndices
 this array contains the order of indices, in which to access the data in the data columns More...
 
int xColumn
 the column that contains the x-component of the datapoints More...
 
int yColumn
 the column that contains the y-component of the datapoints More...
 
- Protected Attributes inherited from JKQTPPlotElement
bool highlighted
 indicates whether the graph is shown in a "highlghted" in the plot More...
 
QVector< HitTestLocationm_hitTestData
 dataset with graph-points and associated data fro the function hitTest() More...
 
JKQTBasePlotterparent
 the plotter object this object belongs to More...
 
int parentPlotStyle
 internal storage for the used parent plot style More...
 
QString title
 title of the plot (for display in key!). If no title is supplied, no key entry is drawn. More...
 
bool visible
 indicates whether the graph is visible in the plot More...
 

Detailed Description

This virtual JKQTPGraph descendent may be used as base for all graphs that use at least two columns that specify x and y coordinates for the single plot points.

This class implements basic management facilities for the data columns:

  • setXColumn(), setYColumn() to set the columns to be used for the graph data
  • setDataSortOrder() to specify whether and how the data should be sorted before drawing
    Unsorted Data
    Data sorted along x-axis (DataSortOrder::SortedX)

... and overrides/implements the functions:

Member Enumeration Documentation

◆ DataSortOrder

specifies how to sort the data in a JKQTPXYGraph before drawing

Unsorted Data
Data sorted along x-axis (DataSortOrder::SortedX)
Enumerator
Unsorted 

the data for a JKQTPXYGraph is not sorted before drawing

SortedX 

the data for a JKQTPXYGraph is sorted so the x-values appear in ascending before drawing

SortedY 

the data for a JKQTPXYGraph is sorted so the y-values appear in ascending before drawing

Constructor & Destructor Documentation

◆ JKQTPXYGraph() [1/2]

JKQTPXYGraph::JKQTPXYGraph ( JKQTBasePlotter parent = nullptr)

class constructor

◆ JKQTPXYGraph() [2/2]

JKQTPXYGraph::JKQTPXYGraph ( JKQTPlotter parent)

class constructor

Member Function Documentation

◆ getDataIndex()

int JKQTPXYGraph::getDataIndex ( int  i)
inlineprotected

returns the index of the i-th datapoint (where i is an index into the SORTED datapoints)

This function can beu used to get the correct datapoint after sorting the datapoints, As sorting is done by sorting an index and not reordering the data in the columns themselves.

See also
setDataSortOrder(), getDataSortOrder()

◆ getDataSortOrder()

DataSortOrder JKQTPXYGraph::getDataSortOrder ( ) const

if !=Unsorted, the data is sorted before plotting

◆ getIndexRange()

virtual bool JKQTPXYGraph::getIndexRange ( int &  imin,
int &  imax 
) const
protectedvirtual

determines the range of row indexes available in the data columns of this graph

Parameters
[out]iminfirst usable row-index
[out]imaxlast usable row-index
Returns
true on success and false if the information is not available

◆ getXColumn()

int JKQTPXYGraph::getXColumn ( ) const

the column that contains the x-component of the datapoints

◆ getXMinMax()

virtual bool JKQTPXYGraph::getXMinMax ( double &  minx,
double &  maxx,
double &  smallestGreaterZero 
)
overridevirtual

get the maximum and minimum x-value of the graph

The result is given in the two parameters which are call-by-reference parameters!

Implements JKQTPPlotElement.

Reimplemented in JKQTPXYParametrizedErrorScatterGraph, JKQTPXYLineErrorGraph, JKQTPBarHorizontalErrorGraph, JKQTPBarHorizontalGraph, and JKQTPBarVerticalGraph.

◆ getYColumn()

int JKQTPXYGraph::getYColumn ( ) const

the column that contains the y-component of the datapoints

◆ getYMinMax()

virtual bool JKQTPXYGraph::getYMinMax ( double &  miny,
double &  maxy,
double &  smallestGreaterZero 
)
overridevirtual

get the maximum and minimum y-value of the graph

The result is given in the two parameters which are call-by-reference parameters!

Implements JKQTPPlotElement.

Reimplemented in JKQTPXYParametrizedErrorScatterGraph, JKQTPXYLineErrorGraph, JKQTPBarHorizontalGraph, JKQTPBarVerticalErrorGraph, JKQTPFilledVerticalRangeGraph, and JKQTPBarVerticalGraph.

◆ hitTest()

virtual double JKQTPXYGraph::hitTest ( const QPointF &  posSystem,
QPointF *  closestSpotSystem = nullptr,
QString *  label = nullptr,
HitTestMode  mode = HitTestXY 
) const
overridevirtual

Implmentation of JKQTPPlotElement::hitTest(), which searches through all graph points defined by xColumn and yColumn and returns a general x/y-label, also taking into account possibly known errors to the graphs (if it is derived from JKQTPXGraphErrorData and/or JKQTPYGraphErrorData.

Note
This function first checks whether JKQTPPlotElement::hitTest() returns any result, so you can use the basic implementation in JKQTPPlotElement to override the behaviour here, by simply calling addHitTestData() during your draw() implementation
See also
See JKQTPPlotElement::hitTest() for details on the function definition!

Reimplemented from JKQTPPlotElement.

◆ intSortData()

virtual void JKQTPXYGraph::intSortData ( )
protectedvirtual

◆ setDataSortOrder() [1/2]

void JKQTPXYGraph::setDataSortOrder ( DataSortOrder  __value)

if !=Unsorted, the data is sorted before plotting

◆ setDataSortOrder() [2/2]

void JKQTPXYGraph::setDataSortOrder ( int  __value)

if !=Unsorted, the data is sorted before plotting

◆ setXColumn() [1/2]

void JKQTPXYGraph::setXColumn ( int  __value)

the column that contains the x-component of the datapoints

◆ setXColumn() [2/2]

void JKQTPXYGraph::setXColumn ( size_t  __value)

the column that contains the x-component of the datapoints

◆ setXYColumns() [1/6]

void JKQTPXYGraph::setXYColumns ( int  xCol,
int  yCol 
)

sets xColumn and yColumn at the same time

◆ setXYColumns() [2/6]

void JKQTPXYGraph::setXYColumns ( QPair< int, int >  xyColPair)

sets xColumn and yColumn at the same time

◆ setXYColumns() [3/6]

void JKQTPXYGraph::setXYColumns ( QPair< size_t, size_t >  xyColPair)

sets xColumn and yColumn at the same time

◆ setXYColumns() [4/6]

void JKQTPXYGraph::setXYColumns ( size_t  xCol,
size_t  yCol 
)

sets xColumn and yColumn at the same time

◆ setXYColumns() [5/6]

void JKQTPXYGraph::setXYColumns ( std::pair< int, int >  xyColPair)

sets xColumn and yColumn at the same time

◆ setXYColumns() [6/6]

void JKQTPXYGraph::setXYColumns ( std::pair< size_t, size_t >  xyColPair)

sets xColumn and yColumn at the same time

◆ setYColumn() [1/2]

void JKQTPXYGraph::setYColumn ( int  __value)

the column that contains the y-component of the datapoints

◆ setYColumn() [2/2]

void JKQTPXYGraph::setYColumn ( size_t  __value)

the column that contains the y-component of the datapoints

◆ usesColumn()

virtual bool JKQTPXYGraph::usesColumn ( int  column) const
overridevirtual

returns true if the given column is used by the graph

This virtual function indicates whether a given column is used by this graph. Override this function in your derived graphs to indicate to JKQTPlotter / JKQTBasePlotter , which columns from the internal JKQTPDatastore are actually used. This information can be used e.g. for graph-specific data-export.

Reimplemented from JKQTPGraph.

Reimplemented in JKQTPFilledVerticalRangeGraph, JKQTPXYParametrizedErrorScatterGraph, JKQTPXYLineErrorGraph, JKQTPBarHorizontalErrorGraph, JKQTPXYParametrizedScatterGraph, JKQTPBarVerticalErrorGraph, JKQTPImpulsesVerticalErrorGraph, JKQTPFilledCurveYErrorGraph, JKQTPImpulsesHorizontalErrorGraph, and JKQTPFilledCurveXErrorGraph.

Member Data Documentation

◆ sortData

DataSortOrder JKQTPXYGraph::sortData
protected

if !=Unsorted, the data is sorted before plotting

◆ sortedIndices

QVector<int> JKQTPXYGraph::sortedIndices
protected

this array contains the order of indices, in which to access the data in the data columns

◆ xColumn

int JKQTPXYGraph::xColumn
protected

the column that contains the x-component of the datapoints

◆ yColumn

int JKQTPXYGraph::yColumn
protected

the column that contains the y-component of the datapoints


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