JKQTPXYGraph Class Reference

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 Slots
void	setDataSortOrder (DataSortOrder __value)
	if !=Unsorted, the data is sorted before plotting
void	setDataSortOrder (int __value)
	if !=Unsorted, the data is sorted before plotting
virtual void	setKeyColumn (int __value)
	sets the column used as "key" for the current graph (typically this call setXColumn(), but for horizontal graphs like filled curves or barcharts it may call setYColumn() )
virtual void	setValueColumn (int __value)
	sets the column used as "value" for the current graph (typically this call setXColumn(), but for horizontal graphs like filled curves or barcharts it may call setYColumn() )
void	setXColumn (int __value)
	the column that contains the x-component of the datapoints
void	setXColumn (size_t __value)
	the column that contains the x-component of the datapoints
void	setXYColumns (int xCol, int yCol)
	sets xColumn and yColumn at the same time
void	setXYColumns (QPair< int, int > xyColPair)
	sets xColumn and yColumn at the same time
void	setXYColumns (QPair< size_t, size_t > xyColPair)
	sets xColumn and yColumn at the same time
void	setXYColumns (size_t xCol, size_t yCol)
	sets xColumn and yColumn at the same time
void	setYColumn (int __value)
	the column that contains the y-component of the datapoints
void	setYColumn (size_t __value)
	the column that contains the y-component of the datapoints
Public Slots inherited from JKQTPPlotElement
void	setHighlighted (bool __value)
	sets whether the graph is drawn in a highlighted style in the plot
virtual void	setTitle (const QString &__value)
	sets the title of the plot (for display in key!).
void	setVisible (bool __value)
	sets whether the graph is visible in the plot

Public Member Functions
	JKQTPXYGraph (JKQTBasePlotter *parent=nullptr)
	class constructor
DataSortOrder	getDataSortOrder () const
	if !=Unsorted, the data is sorted before plotting
virtual int	getKeyColumn () const
	returns the column used as "key" for the current graph (typically this call getXColumn(), but for horizontal graphs like filled curves or barcharts it may call getYColumn() )
virtual int	getValueColumn () const
	returns the column used as "value" for the current graph (typically this call getXColumn(), but for horizontal graphs like filled curves or barcharts it may call getYColumn() )
int	getXColumn () const
	the column that contains the x-component of the datapoints
virtual bool	getXMinMax (double &minx, double &maxx, double &smallestGreaterZero) override
	get the maximum and minimum x-value of the graph
int	getYColumn () const
	the column that contains the y-component of the datapoints
virtual bool	getYMinMax (double &miny, double &maxy, double &smallestGreaterZero) override
	get the maximum and minimum y-value of the graph
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.
virtual bool	usesColumn (int column) const override
	returns true if the given column is used by the graph
Public Member Functions inherited from JKQTPGraph
	JKQTPGraph (JKQTBasePlotter *parent=nullptr)
	class constructor
virtual	~JKQTPGraph ()=default
	default wirtual destructor
Public Member Functions inherited from JKQTPPlotElement
	JKQTPPlotElement (JKQTBasePlotter *parent=nullptr)
	class constructor
virtual	~JKQTPPlotElement ()=default
	default wirtual destructor
QPointF	backTransform (const QPointF &x) const
	tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
QPointF	backTransform (double x, double y) const
	tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
double	backtransformX (double x) const
	tool routine that backtransforms an x-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in xAxisRef
double	backtransformY (double y) const
	tool routine that backtransforms a y-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in yAxisRef
virtual void	draw (JKQTPEnhancedPainter &painter)=0
	plots the graph to the plotter object specified as parent
virtual void	drawKeyMarker (JKQTPEnhancedPainter &painter, const QRectF &rect)=0
	plots a key marker inside the specified rectangle rect
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, ...)
QImage	generateKeyMarker (QSize size=QSize(16, 16))
	returns an image with a key marker inside
virtual QColor	getKeyLabelColor () const =0
	returns the color to be used for the key label
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, ...)
JKQTBasePlotter *	getParent ()
	returns the parent painter class
const JKQTBasePlotter *	getParent () const
	returns the parent painter class
QString	getTitle () const
	returns the the title of the plot
const JKQTPCoordinateAxis *	getXAxis () const
	returns the actual x-Axis-object from the parent plotter, referenced in xAxisRef
JKQTPCoordinateAxisRef	getXAxisRef () const
	indicates which coordinate axis to use for coordinate transforms in x-direction
const JKQTPCoordinateAxis *	getYAxis () const
	returns the actual y-Axis-object from the parent plotter, referenced in yAxisRef
JKQTPCoordinateAxisRef	getYAxisRef () const
	indicates which coordinate axis to use for coordinate transforms in y-direction
bool	isHighlighted () const
	returns whether the graph is shown in a highlighted style in the plot
bool	isVisible () const
	returns whether the graph is visible in the plot
void	setAxes (JKQTPCoordinateAxisRef ref)
	set the coordinate axes to use for this plot element
virtual void	setParent (JKQTBasePlotter *parent)
	sets the parent painter class
virtual void	setParent (JKQTPlotter *parent)
	sets the parent painter class
void	setXAxis (JKQTPCoordinateAxisRef ref)
	indicates which coordinate axis to use for coordinate transforms in x-direction
void	setYAxis (JKQTPCoordinateAxisRef ref)
	indicates which coordinate axis to use for coordinate transforms in y-direction
QPointF	transform (const QPointF &x) const
	tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)
QPolygonF	transform (const QPolygonF &x) const
	tool routine that transforms a QPolygonF according to the parent's transformation rules (plot coordinate --> pixels)
QPointF	transform (double x, double y) const
	tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)
QPainterPath	transformToLinePath (const QPolygonF &x) const
	tool routine that transforms a QPolygonF according to the parent's transformation rules and returns a (non-closed) path consisting of lines (plot coordinate --> pixels)
QVector< double >	transformX (const QVector< double > &x) const
	transform all x-coordinates in a vector x
double	transformX (double x) const
	tool routine that transforms an x-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in xAxisRef
QVector< double >	transformY (const QVector< double > &x) const
	transform all y-coordinates in a vector x
double	transformY (double y) const
	tool routine that transforms a y-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in yAxisRef

Protected Member Functions
int	getDataIndex (int i) const
	returns the index of the i-th datapoint (where i is an index into the SORTED datapoints)
virtual bool	getIndexRange (int &imin, int &imax) const
	determines the range of row indexes available in the data columns of this graph
virtual void	intSortData ()
	sorts data according to the specified criterion in sortData ... The result is stored as a index-map in sorted Indices
Protected Member Functions inherited from JKQTPGraph
virtual void	drawErrorsAfter (JKQTPEnhancedPainter &)
	this function is used to plot error inidcators after plotting the graphs.
virtual void	drawErrorsBefore (JKQTPEnhancedPainter &)
	this function is used to plot error inidcators before plotting the graphs.
bool	getDataMinMax (int column, double &minx, double &maxx, double &smallestGreaterZero)
	get the maximum and minimum value of the given column
Protected Member Functions inherited from JKQTPPlotElement
void	addHitTestData (const HitTestLocation &loc)
	clear the internal datastore for hitTest()
void	addHitTestData (const QPointF &pos_, const QString &label_)
	clear the internal datastore for hitTest()
void	addHitTestData (const QPointF &pos_, int index_, const QString &label_)
	clear the internal datastore for hitTest()
void	addHitTestData (const QPointF &pos_, int index_=-1, const JKQTPDatastore *datastore=nullptr)
	clear the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label
void	addHitTestData (double x_, double y_, const QString &label_)
	add a new point on the graph to the internal datastore for hitTest()
void	addHitTestData (double x_, double y_, int index_, const QString &label_)
	clear the internal datastore for hitTest()
void	addHitTestData (double x_, double y_, int index_=-1, const 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
void	clearHitTestData ()
	clear the internal datastore for hitTest()
virtual QString	formatHitTestDefaultLabel (double x, double y, int index=-1, const 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.
void	reserveHitTestData (int points)
	reserve list entries for up to points graph points in the internal datastore for hitTest()
QString	xFloatToString (double v, int past_comma=-1) const
	converts a x-value v into a string, taking into account the type of x-axis
QString	yFloatToString (double v, int past_comma=-1) const
	converts a x-value v into a string, taking into account the type of x-axis

Protected Attributes
QVector< int >	sortedIndices
	this array contains the order of indices, in which to access the data in the data columns
Protected Attributes inherited from JKQTPPlotElement
QVector< HitTestLocation >	m_hitTestData
	dataset with graph-points and associated data from the function hitTest()
JKQTBasePlotter *	parent
	the plotter object this object belongs to
int	parentPlotStyle
	internal storage for the used parent plot style

Properties
DataSortOrder	sortData
	if !=Unsorted, the data is sorted before plotting
int	xColumn
	the column that contains the x-component of the datapoints
int	yColumn
	the column that contains the y-component of the datapoints
Properties inherited from JKQTPPlotElement
bool	highlighted
	indicates whether the graph is shown in a "highlghted" in the plot
QString	title
	title of the plot (for display in key!). If no title is supplied, no key entry is drawn.
bool	visible
	indicates whether the graph is visible in the plot
JKQTPCoordinateAxisRef	xAxisRef
	indicates which coordinate axis to use for coordinate transforms in x-direction
JKQTPCoordinateAxisRef	yAxisRef
	indicates which coordinate axis to use for coordinate transforms in y-direction

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:

• getXMinMax()
• getYMinMax()
• usesColumn()

Member Enumeration Documentation

DataSortOrder

enum JKQTPXYGraph::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()

JKQTPXYGraph::JKQTPXYGraph

(

JKQTBasePlotter *

parent = nullptr

)

class constructor

Member Function Documentation

getDataIndex()

int JKQTPXYGraph::getDataIndex ( int i ) const

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]	imin	first usable row-index
[out]	imax	last usable row-index

Returns

true on success and false if the information is not available

Reimplemented in JKQTPXXYGraph, JKQTPXYAndVectorGraph, and JKQTPXYYGraph.

getKeyColumn()

virtual int JKQTPXYGraph::getKeyColumn ( ) const

virtual

returns the column used as "key" for the current graph (typically this call getXColumn(), but for horizontal graphs like filled curves or barcharts it may call getYColumn() )

Reimplemented in JKQTPBarHorizontalGraph, JKQTPFilledCurveYGraph, JKQTPImpulsesHorizontalGraph, and JKQTPSpecialLineVerticalGraph.

getValueColumn()

virtual int JKQTPXYGraph::getValueColumn ( ) const

virtual

returns the column used as "value" for the current graph (typically this call getXColumn(), but for horizontal graphs like filled curves or barcharts it may call getYColumn() )

Reimplemented in JKQTPBarHorizontalGraph, JKQTPFilledCurveYGraph, JKQTPImpulsesHorizontalGraph, and JKQTPSpecialLineVerticalGraph.

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!

Parameters

[out]	minx	minimal x-value used in the graph
[out]	maxx	maximal x-value used in the graph
[out]	smallestGreaterZero	the smalles x-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)

Returns

true on success, i.e. if there were datapoints in the plot, or false on failure (e.g. when the graph is empty)

Implements JKQTPPlotElement.

Reimplemented in JKQTPBarHorizontalErrorGraph, JKQTPBarHorizontalGraph, JKQTPBarVerticalGraph, JKQTPFilledCurveYErrorGraph, JKQTPFilledCurveYGraph, JKQTPImpulsesHorizontalErrorGraph, JKQTPImpulsesHorizontalGraph, JKQTPImpulsesVerticalGraph, JKQTPXXYGraph, JKQTPXYAndVectorGraph, JKQTPXYGraphLabels, JKQTPXYLineErrorGraph, JKQTPXYParametrizedErrorScatterGraph, and JKQTPXYScatterErrorGraph.

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!

Parameters

[out]	miny	minimal y-value used in the graph
[out]	maxy	maximal y-value used in the graph
[out]	smallestGreaterZero	the smalles y-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)

Returns

true on success, i.e. if there were datapoints in the plot, or false on failure (e.g. when the graph is empty)

Implements JKQTPPlotElement.

Reimplemented in JKQTPBarHorizontalGraph, JKQTPBarVerticalErrorGraph, JKQTPBarVerticalGraph, JKQTPFilledCurveXErrorGraph, JKQTPFilledCurveXGraph, JKQTPImpulsesHorizontalGraph, JKQTPImpulsesVerticalErrorGraph, JKQTPImpulsesVerticalGraph, JKQTPXYAndVectorGraph, JKQTPXYGraphLabels, JKQTPXYLineErrorGraph, JKQTPXYParametrizedErrorScatterGraph, JKQTPXYScatterErrorGraph, and JKQTPXYYGraph.

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.

Reimplemented in JKQTPXXYGraph, JKQTPXYAndVectorGraph, and JKQTPXYYGraph.

intSortData()

virtual void JKQTPXYGraph::intSortData ( )

protectedvirtual

sorts data according to the specified criterion in sortData ... The result is stored as a index-map in sorted Indices

setDataSortOrder [1/2]

void JKQTPXYGraph::setDataSortOrder ( DataSortOrder __value )

slot

if !=Unsorted, the data is sorted before plotting

setDataSortOrder [2/2]

void JKQTPXYGraph::setDataSortOrder ( int __value )

slot

if !=Unsorted, the data is sorted before plotting

setKeyColumn

virtual void JKQTPXYGraph::setKeyColumn ( int __value )

virtualslot

sets the column used as "key" for the current graph (typically this call setXColumn(), but for horizontal graphs like filled curves or barcharts it may call setYColumn() )

setValueColumn

virtual void JKQTPXYGraph::setValueColumn ( int __value )

virtualslot

sets the column used as "value" for the current graph (typically this call setXColumn(), but for horizontal graphs like filled curves or barcharts it may call setYColumn() )

setXColumn [1/2]

void JKQTPXYGraph::setXColumn ( int __value )

slot

the column that contains the x-component of the datapoints

setXColumn [2/2]

void JKQTPXYGraph::setXColumn ( size_t __value )

slot

the column that contains the x-component of the datapoints

setXYColumns [1/4]

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

slot

sets xColumn and yColumn at the same time

setXYColumns [2/4]

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

slot

sets xColumn and yColumn at the same time

setXYColumns [3/4]

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

slot

sets xColumn and yColumn at the same time

setXYColumns [4/4]

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

slot

sets xColumn and yColumn at the same time

setYColumn [1/2]

void JKQTPXYGraph::setYColumn ( int __value )

slot

the column that contains the y-component of the datapoints

setYColumn [2/2]

void JKQTPXYGraph::setYColumn ( size_t __value )

slot

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 JKQTPBarHorizontalErrorGraph, JKQTPBarVerticalErrorGraph, JKQTPFilledCurveXErrorGraph, JKQTPFilledCurveYErrorGraph, JKQTPImpulsesHorizontalErrorGraph, JKQTPImpulsesVerticalErrorGraph, JKQTPParametrizedVectorFieldGraph, JKQTPXXYGraph, JKQTPXYAndVectorGraph, JKQTPXYLineErrorGraph, JKQTPXYParametrizedErrorScatterGraph, JKQTPXYParametrizedScatterGraph, JKQTPXYScatterErrorGraph, and JKQTPXYYGraph.

Member Data Documentation

sortedIndices

QVector<int> JKQTPXYGraph::sortedIndices

protected

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

Property Documentation

sortData

DataSortOrder JKQTPXYGraph::sortData

readwrite

if !=Unsorted, the data is sorted before plotting

xColumn

int JKQTPXYGraph::xColumn

readwrite

the column that contains the x-component of the datapoints

yColumn

int JKQTPXYGraph::yColumn

readwrite

the column that contains the y-component of the datapoints

---

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

• jkqtpgraphsbase.h