this virtual base class of the (data-column based) graphs, which are part of a JKQTPlotter plot and which use the coordinate system of the JKQTPlotter (i.e. the two coordinate axes getXAxis() and getYAxis()) as basis for the graphs More...

#include <jkqtpgraphsbase.h>

Inheritance diagram for JKQTPGraph:

[legend]

Collaboration diagram for JKQTPGraph:

[legend]

Public Member Functions
	JKQTPGraph (JKQTBasePlotter *parent=nullptr)
	class constructor

virtual	~JKQTPGraph ()=default
	default wirtual destructor

virtual bool	usesColumn (int column) const
	returns `true` if the given column is used by the graph

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

virtual bool	getXMinMax (double &minx, double &maxx, double &smallestGreaterZero)=0
	get the maximum and minimum x-value of the graph

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

virtual bool	getYMinMax (double &miny, double &maxy, double &smallestGreaterZero)=0
	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
	returns the closest distance of the plot element to the (screen pixel) position pos, or `NAN`

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

Friends
class	JKQTPGraphErrorStyleMixin

Additional Inherited Members
Public Types inherited from JKQTPPlotElement
enum	HitTestMode { HitTestXY , HitTestXOnly , HitTestYOnly }
	modes of operation for the function hitTest() More...

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

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 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 base class of the (data-column based) graphs, which are part of a JKQTPlotter plot and which use the coordinate system of the JKQTPlotter (i.e. the two coordinate axes getXAxis() and getYAxis()) as basis for the graphs

This class adds features to work with data columns.

There are two properties datarange_start and datarange_end. By default they are -1 and therefore ignored. if they are != -1 the plotter only displays the datapoints with the indexes [datarange_start .. datarange_end] although there might be more data points available (range [0 .. maxDataPoints]). The datarange is cut at the full range, i.e. if datarange_end>maxDataPoints the plotter displays [datarange_start .. maxDataPoints].
Also there is a virtual function usesColumn() which checks 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.

See also: Graphs

Constructor & Destructor Documentation

◆ JKQTPGraph()

JKQTPGraph::JKQTPGraph ( JKQTBasePlotter * parent = nullptr )

explicit

class constructor

◆ ~JKQTPGraph()

virtual JKQTPGraph::~JKQTPGraph ( )

virtualdefault

default wirtual destructor

Member Function Documentation

◆ drawErrorsAfter()

virtual void JKQTPGraph::drawErrorsAfter ( JKQTPEnhancedPainter & )

protectedvirtual

this function is used to plot error inidcators after plotting the graphs.

By default this function does nothing. But children of this class may overwrite it to implement drawing error indicators.

Reimplemented in JKQTPBarVerticalErrorGraph, JKQTPBarHorizontalErrorGraph, JKQTPFilledCurveXErrorGraph, JKQTPFilledCurveYErrorGraph, JKQTPImpulsesHorizontalErrorGraph, and JKQTPImpulsesVerticalErrorGraph.

◆ drawErrorsBefore()

virtual void JKQTPGraph::drawErrorsBefore ( JKQTPEnhancedPainter & )

protectedvirtual

this function is used to plot error inidcators before plotting the graphs.

By default this function does nothing. But children of this class may overwrite it to implement drawing error indicators.

Reimplemented in JKQTPXYLineErrorGraph, JKQTPXYScatterErrorGraph, and JKQTPXYParametrizedErrorScatterGraph.

◆ getDataMinMax()

bool JKQTPGraph::getDataMinMax	(	int	column,
		double &	minx,
		double &	maxx,
		double &	smallestGreaterZero
	)

protected

get the maximum and minimum value of the given column

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

◆ usesColumn()

virtual bool JKQTPGraph::usesColumn ( int column ) const

virtual

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 in JKQTPBarVerticalErrorGraph, JKQTPBarHorizontalErrorGraph, JKQTPBoxplotGraphBase, JKQTPColumnContourPlot, JKQTPEvaluatedFunctionGraphBase, JKQTPEvaluatedFunctionWithErrorsGraphBase, JKQTPFilledCurveXErrorGraph, JKQTPFilledCurveYErrorGraph, JKQTPColumnMathImage, JKQTPColumnOverlayImageEnhanced, JKQTPColumnRGBMathImage, JKQTPImpulsesHorizontalErrorGraph, JKQTPImpulsesVerticalErrorGraph, JKQTPXYLineErrorGraph, JKQTPXYScatterErrorGraph, JKQTPXYParametrizedScatterGraph, JKQTPXYParametrizedErrorScatterGraph, JKQTPParametrizedVectorFieldGraph, JKQTPSingleColumnGraph, JKQTPFinancialGraph, JKQTPXYGraph, JKQTPXYYGraph, JKQTPXXYGraph, JKQTPXYAndVectorGraph, and JKQTPXGraph.

Friends And Related Symbol Documentation

◆ JKQTPGraphErrorStyleMixin

friend class JKQTPGraphErrorStyleMixin

friend

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

jkqtpgraphsbase.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members