Support Class for JKQTBasePlotter, which summarizes all properties that define the visual styling of a JKQTBasePlotter. More...

#include <jkqtpbaseplotterstyle.h>

Collaboration diagram for JKQTBasePlotterStyle:

[legend]

Public Member Functions
	JKQTBasePlotterStyle ()

void	loadSettings (const QSettings &settings, const QString &group=QString("plots/"), const JKQTBasePlotterStyle &defaultStyle=JKQTBasePlotterStyle())
	loads the plot properties from a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings object

void	saveSettings (QSettings &settings, const QString &group=QString("plots/")) const
	saves the plot properties into a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings object.

Public Attributes
QString	CSVcommentInitializer
	this string is used to introduce comments in text output when exporting data

QString	CSVdecimalSeparator
	the decimal separator used when exporting data to text files

double	debugRegionLineWidth
	width of the lines that are drawn, when debugShowRegionBoxes `==true` [in pixels]

bool	debugShowRegionBoxes
	if set `true` (default: `false` ) the JKQTBasePlotter draws colored rectangles to indicate the different regions in the plot (border, axes, ...)

bool	debugShowTextBoxes
	if set `true` (default: `false` ) the JKQTBasePlotter draws colored rectangles to indicate the outline etc. of text inside the plot

double	debugTextBoxLineWidth
	width of the lines that are drawn, when debugShowTextBoxes `==true` [in pixels]

QString	defaultFontName
	default font name in the plot

double	defaultFontSize
	default font size in the plot [pt]

QColor	defaultTextColor
	default text color in the plot

QBrush	exportBackgroundBrush
	color of the background of the plot (widget area) when exporting

JKQTGraphsBaseStyle	graphsStyle
	style of the graphs

JKQTPKeyStyle	keyStyle
	style of the plot key/legend

QBrush	plotBackgroundBrush
	color of the plot's background (i.e. of the area within the coordinate axes rectangle)

int	plotBorderBottom
	free space between widget bottom border and plot bottom border, this property may be set by the user and is possibly altered by the key positioning algorithm. The altered value is written to internalPlotBorderBottom

int	plotBorderLeft
	free space between widget left border and plot left border, this property may be set by the user and is possibly altered by the key positioning algorithm. The altered value is written to internalPlotBorderLeft

int	plotBorderRight
	free space between widget right border and plot right border, this property may be set by the user and is possibly altered by the key positioning algorithm. The altered value is written to internalPlotBorderRight

int	plotBorderTop
	free space between widget top border and plot top border, this property may be set by the user and is possibly altered by the key positioning algorithm. The altered value is written to internalPlotBorderTop

QColor	plotFrameColor
	if `plotFrameVisible==true`, JKQTBasePlotter will draw a rectangle/frame around the plot in this color

double	plotFrameRounding
	if `plotFrameVisible==true`, JKQTBasePlotter will draw a rectangle/frame around the plot, rounding the corners with this redius (<=0 -> no rounded rectangle) [pt]

bool	plotFrameVisible
	if `true`, JKQTBasePlotter will draw a rectangle/frame around the plot

double	plotFrameWidth
	if `plotFrameVisible==true`, JKQTBasePlotter will draw a rectangle/frame around the plot in this width [pt]

QColor	plotLabelColor
	the plot label color

QString	plotLabelFontName
	the plot label font name

double	plotLabelFontSize
	the plot label font size [pt]

double	plotLabelOffset
	offset of the plot label from the next element of the graph, i.e. below the label [pt].

double	plotLabelTopBorder
	offset of the plot label from the top [pt].

JKQTPColorbarCoordinateAxisStyle	rightColorbarAxisStyle
	style of the coordinate axes used to display colorbars in the right

double	secondaryAxisSeparation
	separation between two seondary axes in pt

JKQTPColorbarCoordinateAxisStyle	topColorbarAxisStyle
	style of the coordinate axes used to display colorbars at the top

bool	useAntiAliasingForSystem
	specifies whether to use antialiasing for plotting the coordinate system

bool	useAntiAliasingForText
	specifies whether to use antialiasing when drawing any text

QBrush	widgetBackgroundBrush
	color of the background of the plot (widget area) when drawing (to the screen)

JKQTPCoordinateAxisStyle	xAxisStyle
	style of the x-axis of the main coordinate system

JKQTPCoordinateAxisStyle	yAxisStyle
	style of the y-axis of the main coordinate system

Detailed Description

Support Class for JKQTBasePlotter, which summarizes all properties that define the visual styling of a JKQTBasePlotter.

See also: JKQTBasePlotter, Styling System

Constructor & Destructor Documentation

◆ JKQTBasePlotterStyle()

JKQTBasePlotterStyle::JKQTBasePlotterStyle ( )

Member Function Documentation

◆ loadSettings()

void JKQTBasePlotterStyle::loadSettings	(	const QSettings &	settings,
		const QString &	group = `QString("plots/")`,
		const JKQTBasePlotterStyle &	defaultStyle = `JKQTBasePlotterStyle()`
	)

loads the plot properties from a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings object

Parameters

settings	QSettings-object to read from
group	Group in the QSettings-object to read from
defaultStyle	If a setting cannot be found in settings, default values are taken from this object By default, this is a default-constructed object

◆ saveSettings()

void JKQTBasePlotterStyle::saveSettings	(	QSettings &	settings,
		const QString &	group = `QString("plots/")`
	)		const

saves the plot properties into a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings object.

Parameters

settings	QSettings-object to save to
group	Group in the QSettings-object to save to

Member Data Documentation

◆ CSVcommentInitializer

QString JKQTBasePlotterStyle::CSVcommentInitializer

this string is used to introduce comments in text output when exporting data

◆ CSVdecimalSeparator

QString JKQTBasePlotterStyle::CSVdecimalSeparator

the decimal separator used when exporting data to text files

◆ debugRegionLineWidth

double JKQTBasePlotterStyle::debugRegionLineWidth

width of the lines that are drawn, when debugShowRegionBoxes ==true [in pixels]

◆ debugShowRegionBoxes

bool JKQTBasePlotterStyle::debugShowRegionBoxes

if set true (default: false ) the JKQTBasePlotter draws colored rectangles to indicate the different regions in the plot (border, axes, ...)

◆ debugShowTextBoxes

bool JKQTBasePlotterStyle::debugShowTextBoxes

if set true (default: false ) the JKQTBasePlotter draws colored rectangles to indicate the outline etc. of text inside the plot

◆ debugTextBoxLineWidth

double JKQTBasePlotterStyle::debugTextBoxLineWidth

width of the lines that are drawn, when debugShowTextBoxes ==true [in pixels]

◆ defaultFontName

QString JKQTBasePlotterStyle::defaultFontName

default font name in the plot

◆ defaultFontSize

double JKQTBasePlotterStyle::defaultFontSize

default font size in the plot [pt]

◆ defaultTextColor

QColor JKQTBasePlotterStyle::defaultTextColor

default text color in the plot

◆ exportBackgroundBrush

QBrush JKQTBasePlotterStyle::exportBackgroundBrush

color of the background of the plot (widget area) when exporting

◆ graphsStyle

JKQTGraphsBaseStyle JKQTBasePlotterStyle::graphsStyle

style of the graphs

◆ keyStyle

JKQTPKeyStyle JKQTBasePlotterStyle::keyStyle

style of the plot key/legend

◆ plotBackgroundBrush

QBrush JKQTBasePlotterStyle::plotBackgroundBrush

color of the plot's background (i.e. of the area within the coordinate axes rectangle)

◆ plotBorderBottom

int JKQTBasePlotterStyle::plotBorderBottom

free space between widget bottom border and plot bottom border, this property may be set by the user and is possibly altered by the key positioning algorithm. The altered value is written to internalPlotBorderBottom

See also: JKQTBasePlotter::setBorder(), Plot Sizes & Borders

◆ plotBorderLeft

int JKQTBasePlotterStyle::plotBorderLeft

free space between widget left border and plot left border, this property may be set by the user and is possibly altered by the key positioning algorithm. The altered value is written to internalPlotBorderLeft

See also: JKQTBasePlotter::setBorder(), Plot Sizes & Borders

◆ plotBorderRight

int JKQTBasePlotterStyle::plotBorderRight

free space between widget right border and plot right border, this property may be set by the user and is possibly altered by the key positioning algorithm. The altered value is written to internalPlotBorderRight

See also: JKQTBasePlotter::setBorder(), Plot Sizes & Borders

◆ plotBorderTop

int JKQTBasePlotterStyle::plotBorderTop

free space between widget top border and plot top border, this property may be set by the user and is possibly altered by the key positioning algorithm. The altered value is written to internalPlotBorderTop

See also: JKQTBasePlotter::setBorder(), Plot Sizes & Borders

◆ plotFrameColor

QColor JKQTBasePlotterStyle::plotFrameColor

if plotFrameVisible==true, JKQTBasePlotter will draw a rectangle/frame around the plot in this color

◆ plotFrameRounding

double JKQTBasePlotterStyle::plotFrameRounding

if plotFrameVisible==true, JKQTBasePlotter will draw a rectangle/frame around the plot, rounding the corners with this redius (<=0 -> no rounded rectangle) [pt]

◆ plotFrameVisible

bool JKQTBasePlotterStyle::plotFrameVisible

if true, JKQTBasePlotter will draw a rectangle/frame around the plot

◆ plotFrameWidth

double JKQTBasePlotterStyle::plotFrameWidth

if plotFrameVisible==true, JKQTBasePlotter will draw a rectangle/frame around the plot in this width [pt]

◆ plotLabelColor

QColor JKQTBasePlotterStyle::plotLabelColor

the plot label color

◆ plotLabelFontName

QString JKQTBasePlotterStyle::plotLabelFontName

the plot label font name

◆ plotLabelFontSize

double JKQTBasePlotterStyle::plotLabelFontSize

the plot label font size [pt]

◆ plotLabelOffset

double JKQTBasePlotterStyle::plotLabelOffset

offset of the plot label from the next element of the graph, i.e. below the label [pt].

See also: plotLabelTopBorder for spacing above

◆ plotLabelTopBorder

double JKQTBasePlotterStyle::plotLabelTopBorder

offset of the plot label from the top [pt].

See also: plotLabelOffset for spacing between label and graph

◆ rightColorbarAxisStyle

JKQTPColorbarCoordinateAxisStyle JKQTBasePlotterStyle::rightColorbarAxisStyle

style of the coordinate axes used to display colorbars in the right

◆ secondaryAxisSeparation

double JKQTBasePlotterStyle::secondaryAxisSeparation

separation between two seondary axes in pt

◆ topColorbarAxisStyle

JKQTPColorbarCoordinateAxisStyle JKQTBasePlotterStyle::topColorbarAxisStyle

style of the coordinate axes used to display colorbars at the top

◆ useAntiAliasingForSystem

bool JKQTBasePlotterStyle::useAntiAliasingForSystem

specifies whether to use antialiasing for plotting the coordinate system

◆ useAntiAliasingForText

bool JKQTBasePlotterStyle::useAntiAliasingForText

specifies whether to use antialiasing when drawing any text

Note: You can set this property false to increase plotting speed of complex plots (with many graphs inside). You can reach a roughly three-fold speed improvement!

◆ widgetBackgroundBrush

QBrush JKQTBasePlotterStyle::widgetBackgroundBrush

color of the background of the plot (widget area) when drawing (to the screen)

◆ xAxisStyle

JKQTPCoordinateAxisStyle JKQTBasePlotterStyle::xAxisStyle

style of the x-axis of the main coordinate system

◆ yAxisStyle

JKQTPCoordinateAxisStyle JKQTBasePlotterStyle::yAxisStyle

style of the y-axis of the main coordinate system

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

jkqtpbaseplotterstyle.h

Public Member Functions

Public Attributes