this virtual base class of every element, which is part of a JKQTPlotter plot and may appear in its key (basically any type of graph, except overlay elements!) More...

#include <jkqtpgraphsbase.h>

Inheritance diagram for JKQTPPlotElement:

[legend]

Collaboration diagram for JKQTPPlotElement:

[legend]

Classes
struct	HitTestLocation
	Dataset for a single point on the graph, associated with its data-column index and a label that can be used by a basic implementation of hitTest() More...

Public Types
enum	HitTestMode { HitTestXY , HitTestXOnly , HitTestYOnly }
	modes of operation for the function hitTest() More...

Public Slots
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
	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
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< 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
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 every element, which is part of a JKQTPlotter plot and may appear in its key (basically any type of graph, except overlay elements!)

Each possible graph is represented by a child of this class. So additional plots may be created by deriving new JKQTPGraph classes. To do so implement/overwrite these functions:

Optionally you may also overwrite these functions to draw elements outside the actual plot area (like e.g. colorbars):

In addition this class provudes protected functions that do coordinate transforms based on the current coordinate system, of the paren JKQTPlotter (i.e. using the axes JKQTPLott:xAxis and JKQTPlotter::yAxis as basis for the plotting).

See also: Graphs

Member Enumeration Documentation

◆ HitTestMode

enum JKQTPPlotElement::HitTestMode

modes of operation for the function hitTest()

Enumerator
HitTestXY	find closest point in x- and y-direction simulatneously (i.e. measure direct distance)
HitTestXOnly	find closest point in x-direction only
HitTestYOnly	find closest point in y-direction only

Constructor & Destructor Documentation

◆ JKQTPPlotElement()

JKQTPPlotElement::JKQTPPlotElement ( JKQTBasePlotter * parent = nullptr )

explicit

class constructor

◆ ~JKQTPPlotElement()

virtual JKQTPPlotElement::~JKQTPPlotElement ( )

virtualdefault

default wirtual destructor

Member Function Documentation

◆ addHitTestData() [1/7]

void JKQTPPlotElement::addHitTestData ( const HitTestLocation & loc )

inlineprotected

clear the internal datastore for hitTest()

Note: This function has to be called at the start of draw()

See also: hitTest(), clearHitTestData(), m_hitTestData, HitTestLocation, reserveHitTestData()

◆ addHitTestData() [2/7]

void JKQTPPlotElement::addHitTestData	(	const QPointF &	pos_,
		const QString &	label_
	)

inlineprotected

clear the internal datastore for hitTest()

Parameters

pos_	position of the graph point in system coordinates
label_	a label for this datapoint, that can e.g. be displayed in a tooltip for this point

See also: hitTest(), clearHitTestData(), m_hitTestData, HitTestLocation, reserveHitTestData()

◆ addHitTestData() [3/7]

void JKQTPPlotElement::addHitTestData	(	const QPointF &	pos_,
		int	index_,
		const QString &	label_
	)

inlineprotected

clear the internal datastore for hitTest()

Parameters

pos_	position of the graph point in system coordinates
index_	index of the graph point in the internal data columns
label_	a label for this datapoint, that can e.g. be displayed in a tooltip for this point

See also: hitTest(), clearHitTestData(), m_hitTestData, HitTestLocation, reserveHitTestData()

◆ addHitTestData() [4/7]

void JKQTPPlotElement::addHitTestData	(	const QPointF &	pos_,
		int	index_ = `-1`,
		const JKQTPDatastore *	datastore = `nullptr`
	)

inlineprotected

clear the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label

Parameters

pos_	position of the graph point in system coordinates
index_	index of the graph point in the internal data columns, or -1
datastore	datastore for formatHitTestDefaultLabel()

See also: hitTest(), clearHitTestData(), m_hitTestData, HitTestLocation, reserveHitTestData()

◆ addHitTestData() [5/7]

void JKQTPPlotElement::addHitTestData	(	double	x_,
		double	y_,
		const QString &	label_
	)

inlineprotected

add a new point on the graph to the internal datastore for hitTest()

Parameters

x_	x-position of the graph point in system coordinates
y_	y-position of the graph point in system coordinates
label_	a label for this datapoint, that can e.g. be displayed in a tooltip for this point

See also: hitTest(), clearHitTestData(), m_hitTestData, HitTestLocation, reserveHitTestData()

◆ addHitTestData() [6/7]

void JKQTPPlotElement::addHitTestData	(	double	x_,
		double	y_,
		int	index_,
		const QString &	label_
	)

inlineprotected

clear the internal datastore for hitTest()

Parameters

x_	x-position of the graph point in system coordinates
y_	y-position of the graph point in system coordinates
index_	index of the graph point in the internal data columns
label_	a label for this datapoint, that can e.g. be displayed in a tooltip for this point

See also: hitTest(), clearHitTestData(), m_hitTestData, HitTestLocation, reserveHitTestData()

◆ addHitTestData() [7/7]

void JKQTPPlotElement::addHitTestData	(	double	x_,
		double	y_,
		int	index_ = `-1`,
		const JKQTPDatastore *	datastore = `nullptr`
	)

inlineprotected

add a new point on the graph to the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label

Parameters

x_	x-position of the graph point in system coordinates
y_	y-position of the graph point in system coordinates
index_	index of the graph point in the internal data columns, or -1
datastore	datastore for formatHitTestDefaultLabel()

See also: hitTest(), clearHitTestData(), m_hitTestData, HitTestLocation, reserveHitTestData()

◆ backTransform() [1/2]

QPointF JKQTPPlotElement::backTransform ( const QPointF & x ) const

inline

tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)

◆ backTransform() [2/2]

QPointF JKQTPPlotElement::backTransform	(	double	x,
		double	y
	)		const

inline

tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)

◆ backtransformX()

double JKQTPPlotElement::backtransformX ( double x ) const

tool routine that backtransforms an x-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in xAxisRef

◆ backtransformY()

double JKQTPPlotElement::backtransformY ( double y ) const

tool routine that backtransforms a y-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in yAxisRef

◆ clearHitTestData()

void JKQTPPlotElement::clearHitTestData ( )

inlineprotected

clear the internal datastore for hitTest()

Note: This function has to be called at the start of draw()

See also: hitTest(), addHitTestData(), m_hitTestData, HitTestLocation

◆ draw()

virtual void JKQTPPlotElement::draw ( JKQTPEnhancedPainter & painter )

pure virtual

plots the graph to the plotter object specified as parent

Implemented in JKQTPBarVerticalGraph, JKQTPBarHorizontalGraph, JKQTPBoxplotVerticalGraph, JKQTPBoxplotHorizontalGraph, JKQTPBoxplotVerticalElement, JKQTPBoxplotHorizontalElement, JKQTPContourPlot, JKQTPXFunctionLineGraph, JKQTPYFunctionLineGraph, JKQTPXYFunctionLineGraphBase, JKQTPFilledCurveXGraph, JKQTPFilledCurveYGraph, JKQTPFilledVerticalRangeGraph, JKQTPFilledHorizontalRangeGraph, JKQTPFinancialGraph, JKQTPGeoSymbol, JKQTPGeoText, JKQTPGeoLine, JKQTPGeoInfiniteLine, JKQTPGeoPolyLines, JKQTPGeoBezierCurve, JKQTPGeoArc, JKQTPGeoRectangle, JKQTPGeoPolygon, JKQTPGeoEllipse, JKQTPGeoPie, JKQTPGeoChord, JKQTPXYGraphLabels, JKQTPImage, JKQTPMathImage, JKQTPOverlayImage, JKQTPOverlayImageEnhanced, JKQTPColumnOverlayImageEnhanced, JKQTPRGBMathImage, JKQTPImpulsesHorizontalGraph, JKQTPImpulsesVerticalGraph, JKQTPXYLineGraph, JKQTPXParsedFunctionLineGraph, JKQTPYParsedFunctionLineGraph, JKQTPPeakStreamGraph, JKQTPHorizontalRange, JKQTPVerticalRange, JKQTPXYScatterGraph, JKQTPXYParametrizedScatterGraph, JKQTPSingleColumnSymbolsGraph, JKQTPSpecialLineHorizontalGraph, JKQTPSpecialLineVerticalGraph, JKQTPVectorFieldGraph, JKQTPParametrizedVectorFieldGraph, JKQTPViolinplotVerticalElement, and JKQTPViolinplotHorizontalElement.

◆ drawKeyMarker()

virtual void JKQTPPlotElement::drawKeyMarker	(	JKQTPEnhancedPainter &	painter,
		const QRectF &	rect
	)

pure virtual

plots a key marker inside the specified rectangle rect

Implemented in JKQTPBarGraphBase, JKQTPBoxplotVerticalGraph, JKQTPBoxplotHorizontalGraph, JKQTPBoxplotVerticalElement, JKQTPBoxplotHorizontalElement, JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase, JKQTPXYFunctionLineGraphBase, JKQTPFilledCurveGraphBase, JKQTPFilledVerticalRangeGraph, JKQTPFilledHorizontalRangeGraph, JKQTPFinancialGraph, JKQTPGeoSymbol, JKQTPGeoText, JKQTPGeoBaseLine, JKQTPGeoBaseDecoratedHeadLine, JKQTPGeoBaseDecoratedLine, JKQTPGeoBaseFilled, JKQTPXYGraphLabels, JKQTPImageBase, JKQTPMathImageBase, JKQTPImage, JKQTPMathImage, JKQTPOverlayImage, JKQTPOverlayImageEnhanced, JKQTPRGBMathImage, JKQTPImpulsesHorizontalGraph, JKQTPImpulsesVerticalGraph, JKQTPXYLineGraph, JKQTPPeakStreamGraph, JKQTPHorizontalRange, JKQTPVerticalRange, JKQTPXYScatterGraph, JKQTPXYParametrizedScatterGraph, JKQTPSingleColumnSymbolsGraph, JKQTPSpecialLineGraphBase, JKQTPVectorFieldGraph, JKQTPParametrizedVectorFieldGraph, JKQTPViolinplotVerticalElement, and JKQTPViolinplotHorizontalElement.

◆ drawOutside()

virtual void JKQTPPlotElement::drawOutside	(	JKQTPEnhancedPainter &	painter,
		QRect	leftSpace,
		QRect	rightSpace,
		QRect	topSpace,
		QRect	bottomSpace
	)

virtual

plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

Note: If you want to draw outside, then you'll also have to implement getOutsideSize(), so enough space is reserved

The four value supplied tell the method where to draw (inside one of the rectangles).

Reimplemented in JKQTPMathImage, JKQTPRGBMathImage, JKQTPXYParametrizedScatterGraph, and JKQTPParametrizedVectorFieldGraph.

◆ formatHitTestDefaultLabel()

virtual QString JKQTPPlotElement::formatHitTestDefaultLabel	(	double	x,
		double	y,
		int	index = `-1`,
		const JKQTPDatastore *	datastore = `nullptr`
	)		const

protectedvirtual

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.

Parameters

x	x-position of the datapoint in system coordinates
y	y-position of the datapoint in system coordinates
index	the index of the data point in the associated data column(s), or -1 (optional!)
datastore	The datastore to read error data from (optional!)

Returns: a LaTeX formatted label

Reimplemented in JKQTPXYAndVectorGraph.

◆ generateKeyMarker()

QImage JKQTPPlotElement::generateKeyMarker ( QSize size = QSize(16, 16) )

returns an image with a key marker inside

◆ getKeyLabelColor()

virtual QColor JKQTPPlotElement::getKeyLabelColor ( ) const

pure virtual

◆ getOutsideSize()

virtual void JKQTPPlotElement::getOutsideSize	(	JKQTPEnhancedPainter &	painter,
		int &	leftSpace,
		int &	rightSpace,
		int &	topSpace,
		int &	bottomSpace
	)

virtual

if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

Note: If you want to draw outside, then you'll also have to implement drawOutside()

Reimplemented in JKQTPMathImage, JKQTPRGBMathImage, JKQTPXYParametrizedScatterGraph, and JKQTPParametrizedVectorFieldGraph.

◆ getParent() [1/2]

JKQTBasePlotter * JKQTPPlotElement::getParent ( )

inline

returns the parent painter class

◆ getParent() [2/2]

const JKQTBasePlotter * JKQTPPlotElement::getParent ( ) const

inline

returns the parent painter class

◆ getTitle()

QString JKQTPPlotElement::getTitle ( ) const

returns the the title of the plot

◆ getXAxis()

const JKQTPCoordinateAxis * JKQTPPlotElement::getXAxis ( ) const

inline

returns the actual x-Axis-object from the parent plotter, referenced in xAxisRef

◆ getXAxisRef()

JKQTPCoordinateAxisRef JKQTPPlotElement::getXAxisRef ( ) const

indicates which coordinate axis to use for coordinate transforms in x-direction

◆ getXMinMax()

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

pure virtual

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)

Implemented in JKQTPBarVerticalGraph, JKQTPBarHorizontalGraph, JKQTPBarHorizontalErrorGraph, JKQTPBoxplotVerticalGraph, JKQTPBoxplotHorizontalGraph, JKQTPBoxplotVerticalElement, JKQTPBoxplotHorizontalElement, JKQTPXFunctionLineGraph, JKQTPYFunctionLineGraph, JKQTPEvaluatedFunctionGraphBase, JKQTPFilledCurveYGraph, JKQTPFilledCurveYErrorGraph, JKQTPGeoSymbol, JKQTPGeoText, JKQTPGeoLine, JKQTPGeoInfiniteLine, JKQTPGeoPolyLines, JKQTPGeoBezierCurve, JKQTPGeoArc, JKQTPGeoRectangle, JKQTPGeoPolygon, JKQTPGeoPie, JKQTPGeoChord, JKQTPXYGraphLabels, JKQTPImageBase, JKQTPImpulsesHorizontalGraph, JKQTPImpulsesHorizontalErrorGraph, JKQTPImpulsesVerticalGraph, JKQTPXYLineErrorGraph, JKQTPPeakStreamGraph, JKQTPHorizontalRange, JKQTPVerticalRange, JKQTPXYScatterErrorGraph, JKQTPXYParametrizedErrorScatterGraph, JKQTPSingleColumnSymbolsGraph, JKQTPViolinplotVerticalElement, JKQTPViolinplotHorizontalElement, JKQTPXYGraph, JKQTPXXYGraph, JKQTPXYAndVectorGraph, and JKQTPXGraph.

◆ getYAxis()

const JKQTPCoordinateAxis * JKQTPPlotElement::getYAxis ( ) const

inline

returns the actual y-Axis-object from the parent plotter, referenced in yAxisRef

◆ getYAxisRef()

JKQTPCoordinateAxisRef JKQTPPlotElement::getYAxisRef ( ) const

indicates which coordinate axis to use for coordinate transforms in y-direction

◆ getYMinMax()

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

pure virtual

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)

Implemented in JKQTPBarVerticalGraph, JKQTPBarVerticalErrorGraph, JKQTPBarHorizontalGraph, JKQTPBoxplotVerticalGraph, JKQTPBoxplotHorizontalGraph, JKQTPBoxplotVerticalElement, JKQTPBoxplotHorizontalElement, JKQTPXFunctionLineGraph, JKQTPYFunctionLineGraph, JKQTPEvaluatedFunctionGraphBase, JKQTPFilledCurveXGraph, JKQTPFilledCurveXErrorGraph, JKQTPFinancialGraph, JKQTPGeoSymbol, JKQTPGeoText, JKQTPGeoLine, JKQTPGeoInfiniteLine, JKQTPGeoPolyLines, JKQTPGeoBezierCurve, JKQTPGeoArc, JKQTPGeoRectangle, JKQTPGeoPolygon, JKQTPGeoPie, JKQTPGeoChord, JKQTPXYGraphLabels, JKQTPImageBase, JKQTPImpulsesHorizontalGraph, JKQTPImpulsesVerticalGraph, JKQTPImpulsesVerticalErrorGraph, JKQTPXYLineErrorGraph, JKQTPPeakStreamGraph, JKQTPHorizontalRange, JKQTPVerticalRange, JKQTPXYScatterErrorGraph, JKQTPXYParametrizedErrorScatterGraph, JKQTPSingleColumnSymbolsGraph, JKQTPViolinplotVerticalElement, JKQTPViolinplotHorizontalElement, JKQTPXYGraph, JKQTPXYYGraph, and JKQTPXYAndVectorGraph.

◆ hitTest()

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

virtual

returns the closest distance of the plot element to the (screen pixel) position pos, or NAN

This function is used to implement hit tests, i.e. to test whether a graph is close to a given position posSystem. The function will then return the distance of the closes graph-point and a label for this point. An example of what can be done with this function is the tooltip tool that JKQTPlotter provides via its context-menu/toolbar. This tool uses just the information of the closest point and its label to display a tooltip for that datapoint:

See also: jkqtpmdaToolTipForClosestDataPoint for details.

Parameters

	posSystem	position to test in system coordinates
[out]	closestSpotSystem	optional output of the closest point found on the plot element in system coordinates
[out]	label	optional output of a label for the closest point (that might e.g. be used in a tooltip)
	mode	search mode, i.e. use sqrt(dxdx+dydy) as distance, or just the absoulte values along one of the two coordinate axes. Note that the returned distance depends on this parameter!

Returns: NAN if not implemented, or if pos is very far from the plot element, or the closest distance (in screen pixels) of pos from the plot element. Note that the returned distance depends on the choosen mode !!! You can use JKQTPIsOKFloat() to check whether a valid distance was returned!

Since the graph base class does not have any knowledge about how to perform a hit test on you specific graph, there is only a very general implementation in this class, which does not actually search through the graph itself, but searches through extra data that hs to be written during draw() and is stored in m_hitTestData. The implentation this base-class only searches this list of points+metadata to implement a basic hit-test. If the list is empty, of no close-by points are found (default), then hitTest() will simply return NAN.

When writing a new graph, you can therefore implement hitTest() in one of these ways:

You simply fill m_hitTestData with appropriate data and rely on the implementation in JKQTPPlotElement to do the work for you: You then need to call clearHitTestData() at the start of your draw() function and whenever you draw a datapoint, you add its location and metadata to the internal storage with addHitTestData()
You derive from a graph class that already has an implementation. JKQTPXYGraph is an example of this. That class searches through all x-/y-coordinates in the internally known columns and even takes into account possible graph errors in the label, when the graph is also derived from JKQTPXGraphErrorData or JKQTPYGraphErrorData. This implementation therefore covers most graph types pre-packaged with JKQTPlotter
You implement the function from scratch

See also: addHitTestData(), clearHitTestData(), m_hitTestData, HitTestLocation

Reimplemented in JKQTPXYGraph, JKQTPXYYGraph, JKQTPXXYGraph, and JKQTPXYAndVectorGraph.

◆ isHighlighted()

bool JKQTPPlotElement::isHighlighted ( ) const

returns whether the graph is shown in a highlighted style in the plot

◆ isVisible()

bool JKQTPPlotElement::isVisible ( ) const

returns whether the graph is visible in the plot

◆ reserveHitTestData()

void JKQTPPlotElement::reserveHitTestData ( int points )

inlineprotected

reserve list entries for up to points graph points in the internal datastore for hitTest()

Note: Call this after clearHitTestData() for improved speed of subsequent addHitTestData() calls!

See also: hitTest(), addHitTestData(), m_hitTestData, HitTestLocation

◆ setAxes()

void JKQTPPlotElement::setAxes ( JKQTPCoordinateAxisRef ref )

set the coordinate axes to use for this plot element

See also: xAxisRef, yAxisRef, transformX(), transformY()

◆ setHighlighted

void JKQTPPlotElement::setHighlighted ( bool __value )

slot

sets whether the graph is drawn in a highlighted style in the plot

◆ setParent() [1/2]

virtual void JKQTPPlotElement::setParent ( JKQTBasePlotter * parent )

virtual

sets the parent painter class

Reimplemented in JKQTPImage, JKQTPMathImage, JKQTPOverlayImage, JKQTPRGBMathImage, JKQTPXYParametrizedScatterGraph, and JKQTPParametrizedVectorFieldGraph.

◆ setParent() [2/2]

virtual void JKQTPPlotElement::setParent ( JKQTPlotter * parent )

virtual

sets the parent painter class

◆ setTitle

virtual void JKQTPPlotElement::setTitle ( const QString & __value )

virtualslot

sets the title of the plot (for display in key!).

Note: If no title is supplied, no key entry is drawn.

Reimplemented in JKQTPImage, JKQTPMathImage, JKQTPOverlayImage, and JKQTPRGBMathImage.

◆ setVisible

void JKQTPPlotElement::setVisible ( bool __value )

slot

sets whether the graph is visible in the plot

◆ setXAxis()

void JKQTPPlotElement::setXAxis ( JKQTPCoordinateAxisRef ref )

indicates which coordinate axis to use for coordinate transforms in x-direction

◆ setYAxis()

void JKQTPPlotElement::setYAxis ( JKQTPCoordinateAxisRef ref )

indicates which coordinate axis to use for coordinate transforms in y-direction

◆ transform() [1/3]

QPointF JKQTPPlotElement::transform ( const QPointF & x ) const

inline

tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)

◆ transform() [2/3]

QPolygonF JKQTPPlotElement::transform ( const QPolygonF & x ) const

tool routine that transforms a QPolygonF according to the parent's transformation rules (plot coordinate --> pixels)

◆ transform() [3/3]

QPointF JKQTPPlotElement::transform	(	double	x,
		double	y
	)		const

inline

tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)

◆ transformToLinePath()

QPainterPath JKQTPPlotElement::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)

◆ transformX() [1/2]

QVector< double > JKQTPPlotElement::transformX ( const QVector< double > & x ) const

transform all x-coordinates in a vector x

◆ transformX() [2/2]

double JKQTPPlotElement::transformX ( double x ) const

tool routine that transforms an x-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in xAxisRef

◆ transformY() [1/2]

QVector< double > JKQTPPlotElement::transformY ( const QVector< double > & x ) const

transform all y-coordinates in a vector x

◆ transformY() [2/2]

double JKQTPPlotElement::transformY ( double y ) const

tool routine that transforms a y-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in yAxisRef

◆ xFloatToString()

QString JKQTPPlotElement::xFloatToString	(	double	v,
		int	past_comma = `-1`
	)		const

protected

converts a x-value v into a string, taking into account the type of x-axis

◆ yFloatToString()

QString JKQTPPlotElement::yFloatToString	(	double	v,
		int	past_comma = `-1`
	)		const

protected

converts a x-value v into a string, taking into account the type of x-axis

Member Data Documentation

◆ m_hitTestData

QVector<HitTestLocation> JKQTPPlotElement::m_hitTestData

protected

dataset with graph-points and associated data from the function hitTest()

See also: hitTest(), HitTestLocation

◆ parent

JKQTBasePlotter* JKQTPPlotElement::parent

protected

the plotter object this object belongs to

◆ parentPlotStyle

int JKQTPPlotElement::parentPlotStyle

protected

internal storage for the used parent plot style

Property Documentation

◆ highlighted

bool JKQTPPlotElement::highlighted

readwrite

indicates whether the graph is shown in a "highlghted" in the plot

◆ title

QString JKQTPPlotElement::title

readwrite

title of the plot (for display in key!). If no title is supplied, no key entry is drawn.

◆ visible

bool JKQTPPlotElement::visible

readwrite

indicates whether the graph is visible in the plot

◆ xAxisRef

JKQTPCoordinateAxisRef JKQTPPlotElement::xAxisRef

readwrite

indicates which coordinate axis to use for coordinate transforms in x-direction

◆ yAxisRef

JKQTPCoordinateAxisRef JKQTPPlotElement::yAxisRef

readwrite

indicates which coordinate axis to use for coordinate transforms in y-direction

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

jkqtpgraphsbase.h

Classes

Public Types

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

◆ HitTestMode

Constructor & Destructor Documentation

◆ JKQTPPlotElement()

◆ ~JKQTPPlotElement()

Member Function Documentation

◆ addHitTestData() [1/7]

◆ addHitTestData() [2/7]

◆ addHitTestData() [3/7]

◆ addHitTestData() [4/7]

◆ addHitTestData() [5/7]

◆ addHitTestData() [6/7]

◆ addHitTestData() [7/7]

◆ backTransform() [1/2]

◆ backTransform() [2/2]

◆ backtransformX()

◆ backtransformY()

◆ clearHitTestData()

◆ draw()

◆ drawKeyMarker()

◆ drawOutside()

◆ formatHitTestDefaultLabel()

◆ generateKeyMarker()

◆ getKeyLabelColor()

◆ getOutsideSize()

◆ getParent() [1/2]

◆ getParent() [2/2]

◆ getTitle()

◆ getXAxis()

◆ getXAxisRef()

◆ getXMinMax()

◆ getYAxis()

◆ getYAxisRef()

◆ getYMinMax()

◆ hitTest()

◆ isHighlighted()

◆ isVisible()

◆ reserveHitTestData()

◆ setAxes()

◆ setHighlighted

◆ setParent() [1/2]

◆ setParent() [2/2]

◆ setTitle

◆ setVisible

◆ setXAxis()

◆ setYAxis()

◆ transform() [1/3]

◆ transform() [2/3]

◆ transform() [3/3]

◆ transformToLinePath()

◆ transformX() [1/2]

◆ transformX() [2/2]

◆ transformY() [1/2]

◆ transformY() [2/2]

◆ xFloatToString()

◆ yFloatToString()

Member Data Documentation

◆ m_hitTestData

◆ parent

◆ parentPlotStyle

Property Documentation

◆ highlighted

◆ title

◆ visible

◆ xAxisRef

◆ yAxisRef