plots a 1-column set of data-values with symbols onto a JKQtPlotter/JKQtBasePlotter. the data from the single column is either interpreted as x- or y-values and the missing coordinate is taken from a fixed value position. More...

#include <jkqtpsinglecolumnsymbols.h>

Inheritance diagram for JKQTPSingleColumnSymbolsGraph:

[legend]

Collaboration diagram for JKQTPSingleColumnSymbolsGraph:

[legend]

Public Types
enum	ScatterStyle { NoScatter , RugPlot , RandomScatter , BeeSwarmScatter }
	describes how data from dataColumn of a JKQTPSingleColumnSymbolsGraph positioned at position More...

Public Types inherited from JKQTPSingleColumnGraph
enum class	DataDirection { X , Y }
	specifies whether the data for a JKQTPSingleColumnGraph represent x-axis or y-axis values More...

enum	DataSortOrder { Unsorted =0 , Sorted =1 }
	specifies how to sort the data for a JKQTPSingleColumnGraph before drawing More...

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

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

	JKQTPSingleColumnSymbolsGraph (JKQTPlotter *parent)

virtual void	draw (JKQTPEnhancedPainter &painter) override
	plots the graph to the plotter object specified as parent

virtual void	drawKeyMarker (JKQTPEnhancedPainter &painter, const QRectF &rect) override
	plots a key marker inside the specified rectangle rect

virtual QColor	getKeyLabelColor () const override
	returns the color to be used for the key label

double	getPosition () const
	missing coordinate, i.e. if the data from dataColumn is interpreted as x-values, this is the y-position and vice versa (see DataDirection )

ScatterStyle	getPositionScatterStyle () const
	how to distribute the datapoints from dataColumn at the location position

unsigned int	getSeedValue () const
	seed value for the pseudo-random number generator used for drawing.

double	getWidth () const
	width of data distribution around position for the missing coordinate (see positionScatterStyle and position)

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

virtual bool	getYMinMax (double &miny, double &maxy, double &smallestGreaterZero) override
	get the maximum and minimum y-value of the graph

void	setColor (QColor col)
	set symbol color and fill color at the same time

void	setPosition (double __value)
	missing coordinate, i.e. if the data from dataColumn is interpreted as x-values, this is the y-position and vice versa (see DataDirection )

void	setPositionScatterStyle (ScatterStyle __value)
	how to distribute the datapoints from dataColumn at the location position

void	setSeedValue (unsigned int val)
	seed value for the pseudo-random number generator used for drawing.

void	setWidth (double __value)
	width of data distribution around position for the missing coordinate (see positionScatterStyle and position)

Public Member Functions inherited from JKQTPSingleColumnGraph
	JKQTPSingleColumnGraph (JKQTBasePlotter *parent=nullptr)
	class constructor

int	getDataColumn () const
	the column that contains the datapoints

DataDirection	getDataDirection () const
	interpret the data from dataColumn either as X- or Y-data

DataSortOrder	getDataSortOrder () const
	if `!=Unsorted`, the data is sorted before plotting

virtual bool	usesColumn (int c) 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	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 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

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

Public Member Functions inherited from JKQTPGraphSymbolStyleMixin
	JKQTPGraphSymbolStyleMixin ()
	class constructor

virtual	~JKQTPGraphSymbolStyleMixin ()

QColor	getSymbolColor () const
	set the color of the graph symbols

QColor	getSymbolFillColor () const
	set the color of filling of the graph symbols

QString	getSymbolFontName () const
	get the font to be used for character symbols `JKQTPCharacterSymbol+QChar`('').unicode()

double	getSymbolLineWidth () const
	get the line width of the graph symbol outline (in pt)

double	getSymbolSize () const
	get the size (=diameter in pt) of the graph symbol (in pt)

JKQTPGraphSymbols	getSymbolType () const
	get the type of the graph symbol

void	initSymbolStyle (JKQTBasePlotter *parent, int &parentPlotStyle, JKQTPPlotStyleType styletype=JKQTPPlotStyleType::Default)
	initiaize the symbol style (from the parent plotter)

void	setSymbolAlpha (double alpha)
	set alpha-value of symbol outline and filling

void	setSymbolColor (const QColor &__value)
	set the color of the graph symbols

void	setSymbolColor (const QColor &__value, double alpha)
	set the color of the graph symbols

void	setSymbolFillColor (const QColor &__value)
	set the color of filling of the graph symbols

void	setSymbolFillColor (const QColor &__value, double alpha)
	set the color of filling of the graph symbols

void	setSymbolFontName (const QString &__value)
	set the font to be used for character symbols `JKQTPCharacterSymbol+QChar`('').unicode()

void	setSymbolLineWidth (double __value)
	set the line width of the graph symbol outline (in pt)

void	setSymbolSize (double __value)
	set the size (=diameter in pt) of the graph symbol (in pt)

void	setSymbolType (JKQTPGraphSymbols __value)
	set the type of the graph symbol

Protected Attributes
double	position
	missing coordinate, i.e. if the data from dataColumn is interpreted as x-values, this is the y-position and vice versa (see DataDirection )

ScatterStyle	positionScatterStyle
	how to distribute the datapoints from dataColumn at the location position

unsigned int	seedValue
	seed value for the pseudo-random number generator used for drawing.

double	width
	width of data distribution around position for the missing coordinate (see positionScatterStyle and position)

Protected Attributes inherited from JKQTPSingleColumnGraph
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

Additional Inherited Members
Public Slots inherited from JKQTPSingleColumnGraph
void	setDataColumn (int __value)
	the column that contains the datapoints

void	setDataColumn (size_t __value)
	the column that contains the datapoints

void	setDataDirection (DataDirection __value)
	interpret the data from dataColumn either as X- or Y-data

void	setDataSortOrder (DataSortOrder __value)
	if `!=Unsorted`, the data is sorted before plotting

void	setDataSortOrder (int __value)
	if `!=Unsorted`, the data is sorted before plotting

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 Member Functions inherited from JKQTPSingleColumnGraph
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 ()

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 Member Functions inherited from JKQTPGraphSymbolStyleMixin
double	getKeySymbolLineWidthPx (JKQTPEnhancedPainter &painter, const QRectF &keyRect, const JKQTBasePlotter *parent, double maxSymbolSizeFracton=0.9) const
	returns the symbol linewidth for drawing symbols in a key entry with keyRect for the symbol, using painter and parent . maxSymbolSizeFracton specifies the maximum fraction of keyRect to be used for the symbol.

double	getKeySymbolSizePx (JKQTPEnhancedPainter &painter, const QRectF &keyRect, const JKQTBasePlotter *parent, double maxSymbolSizeFracton=0.9) const
	returns the symbol size for drawing symbols in a key entry with keyRect for the symbol, using painter and parent . maxSymbolSizeFracton specifies the maximum fraction of keyRect to be used for the symbol.

QBrush	getSymbolBrush (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
	constructs a QPen from the line styling properties

QFont	getSymbolFont () const
	generate a QFont for darwing symbols

QPen	getSymbolPen (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
	constructs a QPen from the line styling properties

void	plotStyledSymbol (JKQTBasePlotter *parent, JKQTPEnhancedPainter &painter, double x, double y) const
	plot a symbol at location x,y (in painter coordinates), using the current style

void	plotStyledSymbol (JKQTBasePlotter *parent, JKQTPEnhancedPainter &painter, double x, double y, double symbolSize) const
	plot a symbol at location x,y (in painter coordinates), using the current style

void	plotStyledSymbol (JKQTBasePlotter *parent, JKQTPEnhancedPainter &painter, double x, double y, JKQTPGraphSymbols type) const
	plot a symbol at location x,y (in painter coordinates), using the current style

void	plotStyledSymbol (JKQTBasePlotter *parent, JKQTPEnhancedPainter &painter, double x, double y, QColor color, QColor fillColor) const
	plot a symbol at location x,y (in painter coordinates), using the current style

Properties inherited from JKQTPSingleColumnGraph
int	dataColumn
	the column that contains the datapoints

DataDirection	dataDirection
	interpret the data from dataColumn either as X- or Y-data

DataSortOrder	sortData
	if `!=Unsorted`, the data is sorted before plotting

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

Properties inherited from JKQTPGraphSymbolStyleMixin
QColor	symbolColor

QColor	symbolFillColor

QString	symbolFontName

double	symbolLineWidth

double	symbolSize

JKQTPGraphSymbols	symbolType

Detailed Description

plots a 1-column set of data-values with symbols onto a JKQtPlotter/JKQtBasePlotter. the data from the single column is either interpreted as x- or y-values and the missing coordinate is taken from a fixed value position.

The first coordinate of the data is taken from dataColumn i.e.

the x-values if dataDirection==DataDirection::X
the y-values if dataDirection==DataDirection::Y

The second coordinate is:

if positionScatterStyle==NoScatter it is simply the value of position, e.g.
if positionScatterStyle==RugPlot is like a NoScatter-plot, but with lines instead of symbols (see https://en.wikipedia.org/wiki/Rug_plot)
if positionScatterStyle==RandomScatter it scatters around position in the range [position-width/2 ... position+width/2], e.g.
if positionScatterStyle==BeeSwarmScatter it scatters around position with an algorithm that tries to avoid any overlay of the plot symbols (SLOW!), e.g.

All example images above have dataDirection==DataDirection::X !

See also: Example (JKQTPlotter): Plotting a Statistical Distribution of Data, Example (JKQTPlotter): Violin Plots

Member Enumeration Documentation

◆ ScatterStyle

enum JKQTPSingleColumnSymbolsGraph::ScatterStyle

describes how data from dataColumn of a JKQTPSingleColumnSymbolsGraph positioned at position

Enumerator
NoScatter	missing coordinate is exactly position for every datapoint in dataColumn
RugPlot	like NoScatter but draws each data-point as a horzintal/vertical line, centered around position, not as a symbol ("rug plot", see e.g. https://en.wikipedia.org/wiki/Rug_plot).
RandomScatter	missing coordinate scatters around position (with distribution-width width )
BeeSwarmScatter	missing coordinate scatters around position and the algorithm tries to prevent overlay of two symbols ("bee swarm plot", see e.g. https://www.r-statistics.com/2011/03/beeswarm-boxplot-and-plotting-it-with-r/). Note that this algorithm can be rather slow!!!

Constructor & Destructor Documentation

◆ JKQTPSingleColumnSymbolsGraph() [1/2]

JKQTPSingleColumnSymbolsGraph::JKQTPSingleColumnSymbolsGraph ( JKQTBasePlotter * parent = nullptr )

class constructor

◆ JKQTPSingleColumnSymbolsGraph() [2/2]

JKQTPSingleColumnSymbolsGraph::JKQTPSingleColumnSymbolsGraph ( JKQTPlotter * parent )

Member Function Documentation

◆ draw()

virtual void JKQTPSingleColumnSymbolsGraph::draw ( JKQTPEnhancedPainter & painter )

overridevirtual

plots the graph to the plotter object specified as parent

Implements JKQTPPlotElement.

◆ drawKeyMarker()

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

overridevirtual

plots a key marker inside the specified rectangle rect

Implements JKQTPPlotElement.

◆ getKeyLabelColor()

virtual QColor JKQTPSingleColumnSymbolsGraph::getKeyLabelColor ( ) const

overridevirtual

returns the color to be used for the key label

Implements JKQTPPlotElement.

◆ getPosition()

double JKQTPSingleColumnSymbolsGraph::getPosition ( ) const

missing coordinate, i.e. if the data from dataColumn is interpreted as x-values, this is the y-position and vice versa (see DataDirection )

◆ getPositionScatterStyle()

ScatterStyle JKQTPSingleColumnSymbolsGraph::getPositionScatterStyle ( ) const

how to distribute the datapoints from dataColumn at the location position

◆ getSeedValue()

unsigned int JKQTPSingleColumnSymbolsGraph::getSeedValue ( ) const

seed value for the pseudo-random number generator used for drawing.

This seed is used instead of e.g. the system time to ensure that replotting results in the same plot every time. ou can set the seed using setSeedvalue() )

◆ getWidth()

double JKQTPSingleColumnSymbolsGraph::getWidth ( ) const

width of data distribution around position for the missing coordinate (see positionScatterStyle and position)

◆ getXMinMax()

virtual bool JKQTPSingleColumnSymbolsGraph::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.

◆ getYMinMax()

virtual bool JKQTPSingleColumnSymbolsGraph::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.

◆ setColor()

void JKQTPSingleColumnSymbolsGraph::setColor ( QColor col )

set symbol color and fill color at the same time

◆ setPosition()

void JKQTPSingleColumnSymbolsGraph::setPosition ( double __value )

missing coordinate, i.e. if the data from dataColumn is interpreted as x-values, this is the y-position and vice versa (see DataDirection )

◆ setPositionScatterStyle()

void JKQTPSingleColumnSymbolsGraph::setPositionScatterStyle ( ScatterStyle __value )

how to distribute the datapoints from dataColumn at the location position

◆ setSeedValue()

void JKQTPSingleColumnSymbolsGraph::setSeedValue ( unsigned int val )

seed value for the pseudo-random number generator used for drawing.

This seed is used instead of e.g. the system time to ensure that replotting results in the same plot every time. ou can set the seed using setSeedvalue() )

◆ setWidth()

void JKQTPSingleColumnSymbolsGraph::setWidth ( double __value )

width of data distribution around position for the missing coordinate (see positionScatterStyle and position)

Member Data Documentation

◆ position

double JKQTPSingleColumnSymbolsGraph::position

protected

missing coordinate, i.e. if the data from dataColumn is interpreted as x-values, this is the y-position and vice versa (see DataDirection )

◆ positionScatterStyle

ScatterStyle JKQTPSingleColumnSymbolsGraph::positionScatterStyle

protected

how to distribute the datapoints from dataColumn at the location position

◆ seedValue

unsigned int JKQTPSingleColumnSymbolsGraph::seedValue

protected

seed value for the pseudo-random number generator used for drawing.

This seed is used instead of e.g. the system time to ensure that replotting results in the same plot every time. ou can set the seed using setSeedvalue() )

◆ width

double JKQTPSingleColumnSymbolsGraph::width

protected

width of data distribution around position for the missing coordinate (see positionScatterStyle and position)

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

jkqtpsinglecolumnsymbols.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ScatterStyle

Constructor & Destructor Documentation

◆ JKQTPSingleColumnSymbolsGraph() [1/2]

◆ JKQTPSingleColumnSymbolsGraph() [2/2]

Member Function Documentation

◆ draw()

◆ drawKeyMarker()

◆ getKeyLabelColor()

◆ getPosition()

◆ getPositionScatterStyle()

◆ getSeedValue()

◆ getWidth()

◆ getXMinMax()

◆ getYMinMax()

◆ setColor()

◆ setPosition()

◆ setPositionScatterStyle()

◆ setSeedValue()

◆ setWidth()

Member Data Documentation

◆ position

◆ positionScatterStyle

◆ seedValue

◆ width