JKQTPlotter
an extensive Qt4/Qt5 Plotter framework (including a fast variant and a LaTeX equation renderer!), written fully in C/C++ and without external dependencies

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

#include <jkqtpbaseplotterstyle.h>

Collaboration diagram for JKQTBasePlotterStyle:

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

Public Attributes

QString CSVcommentInitializer
 this string is used to introduce comments in text output when exporting data More...
 
QString CSVdecimalSeparator
 the decimal separator used when exporting data to text files More...
 
double debugRegionLineWidth
 width of the lines that are drawn, when debugShowRegionBoxes ==true [in pixels] More...
 
bool debugShowRegionBoxes
 if set true (default: false ) the JKQTBasePlotter draws colored rectangles to indicate the different regions in the plot (border, axes, ...) More...
 
QString defaultFontName
 default font name in the plot More...
 
double defaultFontSize
 default font size in the plot [pt] More...
 
QVector< QColor > defaultGraphColors
 colors used to automatically collor different graphs differently More...
 
QVector< Qt::BrushStyle > defaultGraphFillStyles
 Qt::BrushStyle used to automatically style different graphs differently. More...
 
QVector< Qt::PenStyle > defaultGraphPenStyles
 Qt::PenStyle used to automatically style different graphs differently. More...
 
double defaultGraphSymbolLineWidth
 with (in pt) of symbol lines used for newly added graphs More...
 
QVector< JKQTPGraphSymbolsdefaultGraphSymbols
 JKQTPGraphSymbols used to automatically assign to different graphs. More...
 
double defaultGraphSymbolSize
 size (in pt) of symbols used for newly added graphs More...
 
double defaultGraphWidth
 width (in pt) of lines used for newly added graphs More...
 
JKQTPMathImageColorPalette defaultPalette
 color palette used by default for new graphs More...
 
QColor defaultTextColor
 default text color in the plot More...
 
QBrush exportBackgroundBrush
 color of the background of the plot (widget area) when exporting More...
 
JKQTPColorDerivationMode graphErrorColorDerivationMode
 defines how to derive an error color for a new graph More...
 
JKQTPColorDerivationMode graphErrorFillColorDerivationMode
 defines how to derive an error fill color from the error color for a new graph More...
 
JKQTPColorDerivationMode graphFillColorDerivationMode
 defines how to derive a fill color for a new graph More...
 
JKQTPKeyStyle keyStyle
 style of the plot key/legend More...
 
QBrush plotBackgroundBrush
 color of the plot's background (i.e. of the area within the coordinate axes rectangle) More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
QColor plotFrameColor
 if plotFrameVisible==true, JKQTBasePlotter will draw a rectangle/frame around the plot in this color More...
 
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] More...
 
bool plotFrameVisible
 if true, JKQTBasePlotter will draw a rectangle/frame around the plot More...
 
double plotFrameWidth
 if plotFrameVisible==true, JKQTBasePlotter will draw a rectangle/frame around the plot in this width [pt] More...
 
QString plotLabelFontName
 the plot label font name More...
 
double plotLabelFontSize
 the plot label font size [pt] More...
 
JKQTPCoordinateAxisStyle rightColorbarAxisStyle
 style of the coordinate axes used to display colorbars in the right More...
 
JKQTPCoordinateAxisStyle topColorbarAxisStyle
 style of the coordinate axes used to display colorbars at the top More...
 
bool useAntiAliasingForGraphs
 specifies whether to use antialiasing for plotting the graphs More...
 
bool useAntiAliasingForSystem
 specifies whether to use antialiasing for plotting the coordinate system More...
 
bool useAntiAliasingForText
 specifies whether to use antialiasing when drawing any text More...
 
QBrush widgetBackgroundBrush
 color of the background of the plot (widget area) when drawing (to the screen) More...
 
JKQTPCoordinateAxisStyle xAxisStyle
 style of the x-axis of the main coordinate system More...
 
JKQTPCoordinateAxisStyle yAxisStyle
 style of the y-axis of the main coordinate system More...
 

Detailed Description

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

See also
JKQTBasePlotter, JKQTPlotter 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
settingsQSettings-object to read from
groupGroup in the QSettings-object to read from
defaultStyleIf 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
settingsQSettings-object to save to
groupGroup 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, ...)

◆ defaultFontName

QString JKQTBasePlotterStyle::defaultFontName

default font name in the plot

◆ defaultFontSize

double JKQTBasePlotterStyle::defaultFontSize

default font size in the plot [pt]

◆ defaultGraphColors

QVector<QColor> JKQTBasePlotterStyle::defaultGraphColors

colors used to automatically collor different graphs differently

◆ defaultGraphFillStyles

QVector<Qt::BrushStyle> JKQTBasePlotterStyle::defaultGraphFillStyles

Qt::BrushStyle used to automatically style different graphs differently.

◆ defaultGraphPenStyles

QVector<Qt::PenStyle> JKQTBasePlotterStyle::defaultGraphPenStyles

Qt::PenStyle used to automatically style different graphs differently.

◆ defaultGraphSymbolLineWidth

double JKQTBasePlotterStyle::defaultGraphSymbolLineWidth

with (in pt) of symbol lines used for newly added graphs

◆ defaultGraphSymbols

QVector<JKQTPGraphSymbols> JKQTBasePlotterStyle::defaultGraphSymbols

JKQTPGraphSymbols used to automatically assign to different graphs.

◆ defaultGraphSymbolSize

double JKQTBasePlotterStyle::defaultGraphSymbolSize

size (in pt) of symbols used for newly added graphs

◆ defaultGraphWidth

double JKQTBasePlotterStyle::defaultGraphWidth

width (in pt) of lines used for newly added graphs

◆ defaultPalette

JKQTPMathImageColorPalette JKQTBasePlotterStyle::defaultPalette

color palette used by default for new graphs

◆ 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

◆ graphErrorColorDerivationMode

JKQTPColorDerivationMode JKQTBasePlotterStyle::graphErrorColorDerivationMode

defines how to derive an error color for a new graph

◆ graphErrorFillColorDerivationMode

JKQTPColorDerivationMode JKQTBasePlotterStyle::graphErrorFillColorDerivationMode

defines how to derive an error fill color from the error color for a new graph

◆ graphFillColorDerivationMode

JKQTPColorDerivationMode JKQTBasePlotterStyle::graphFillColorDerivationMode

defines how to derive a fill color for a new graph

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

◆ plotLabelFontName

QString JKQTBasePlotterStyle::plotLabelFontName

the plot label font name

◆ plotLabelFontSize

double JKQTBasePlotterStyle::plotLabelFontSize

the plot label font size [pt]

◆ rightColorbarAxisStyle

JKQTPCoordinateAxisStyle JKQTBasePlotterStyle::rightColorbarAxisStyle

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

◆ topColorbarAxisStyle

JKQTPCoordinateAxisStyle JKQTBasePlotterStyle::topColorbarAxisStyle

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

◆ useAntiAliasingForGraphs

bool JKQTBasePlotterStyle::useAntiAliasingForGraphs

specifies whether to use antialiasing for plotting the graphs

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!

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