JKQTPlotter trunk/v5.0.0
an extensive Qt5+Qt6 Plotter framework (including a feature-richt plotter widget, a speed-optimized, but limited variant and a LaTeX equation renderer!), written fully in C/C++ and without external dependencies
Loading...
Searching...
No Matches

simply marks a range (and possibly a centerline) in a plot. This may be used to display e.g. mean +/- stddev or a range of interest, or the range of good values, ... More...

#include <jkqtprange.h>

Inheritance diagram for JKQTPHorizontalRange:
[legend]
Collaboration diagram for JKQTPHorizontalRange:
[legend]

Public Member Functions

 JKQTPHorizontalRange (JKQTBasePlotter *parent=nullptr)
 class constructor
 JKQTPHorizontalRange (JKQTPlotter *parent)
 class constructor
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
bool getXMinMax (double &minx, double &maxx, double &smallestGreaterZero) override
 get the maximum and minimum x-value of the graph
bool getYMinMax (double &miny, double &maxy, double &smallestGreaterZero) override
 get the maximum and minimum y-value of the graph
Public Member Functions inherited from JKQTPRangeBase
 JKQTPRangeBase (JKQTBasePlotter *parent=nullptr)
 class constructor
QColor getCenterColor () const
 color of the center line graph
double getCenterLineWidth () const
 width (pt) of the center line graph, given in pt
Qt::PenStyle getCenterStyle () const
 linestyle of the center line graph lines
bool getFillRange () const
 if true, this fills the range with fillColor
bool getInvertedRange () const
 if true, fills the parts outside the given range
virtual QColor getKeyLabelColor () const override
 returns the color to be used for the key label
bool getPlotCenterLine () const
 indicates whether to plot a center line
bool getPlotRange () const
 if true, the range is plotted, if false, only the center line is plotted (if plotCenterLine is true )
bool getPlotRangeLines () const
 if true, draws lines at the range borders color
double getRangeCenter () const
 where to plot the center line
double getRangeMax () const
 max-value of range
double getRangeMin () const
 min-value of range
double getSizeMax () const
 if unlimitedSizeMax==false, then the range rectangle only extends to this value on the axis perpendicular to the range axis (towards larger numbers)
double getSizeMin () const
 if unlimitedSizeMin==false, then the range rectangle only extends to this value on the axis perpendicular to the range axis (towards smaller numbers)
bool getUnlimitedSizeMax () const
 if true, the range elongates infinitely in the direction perpendicular to the range axis and towards larger numbers, otherwise the range rectangle stops at rangeMin
bool getUnlimitedSizeMin () const
 if true, the range elongates infinitely in the direction perpendicular to the range axis and towards smaller numbers, otherwise the range rectangle stops at rangeMin
void setCenterLineWidth (double __value)
 width (pt) of the center line graph, given in pt
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, ...)
JKQTBasePlottergetParent ()
 returns the parent painter class
const JKQTBasePlottergetParent () const
 returns the parent painter class
QString getTitle () const
 returns the the title of the plot
const JKQTPCoordinateAxisgetXAxis () 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 JKQTPCoordinateAxisgetYAxis () 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 JKQTPGraphLineStyleMixin
 JKQTPGraphLineStyleMixin ()
 class constructor
virtual ~JKQTPGraphLineStyleMixin ()
QColor getHighlightingLineColor () const
 get the color of the graph line when highlighted
QPen getHighlightingLinePen (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties
QPen getHighlightingLinePenForRects (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties, suitable for drawing rectangle with sharp corners
QPen getKeyLinePen (JKQTPEnhancedPainter &painter, const QRectF &rect, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties, but uses getKeyLineWidthPx() for the width, i.e. constructs a pen for drawing lines in key-symbols
double getKeyLineWidthPx (JKQTPEnhancedPainter &painter, const QRectF &keyRect, const JKQTBasePlotter *parent) const
 returns the linewidth for drawing lines in a key entry with keyRect for the symbol, using painter and parent .
QBrush getLineBrush () const
 gets the brush used to fill the line area
Qt::PenCapStyle getLineCapStyle () const
 gets the cap style
QColor getLineColor () const
 get the color of the graph line
qreal getLineDashOffset () const
 returns the dash offset for a custom dash style
QVector< qreal > getLineDashPattern () const
 gets the dash pattern for a custom dash style
Qt::PenJoinStyle getLineJoinStyle () const
 returns the join style
QPen getLinePen (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties
QPen getLinePenForRects (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties, suitable for drawing rectangles with sharp edges
Qt::PenStyle getLineStyle () const
 get the style of the graph line
double getLineWidth () const
 get the line width of the graph line (in pt)
void initLineStyle (JKQTBasePlotter *parent, int &parentPlotStyle, JKQTPPlotStyleType styletype=JKQTPPlotStyleType::Default)
 initiaize the line style (from the parent plotter)
void setHighlightingLineColor (const QColor &__value)
 set the color of the graph line when highlighted
void setHighlightingLineColor (const QColor &__value, double alpha)
 set the color of the graph line when highlighted
void setLineBrush (const QBrush &style)
 sets the brush used to fill the line area
void setLineCapStyle (Qt::PenCapStyle style)
 sets the cap style
void setLineColor (const QColor &__value)
 set the color of the graph line
void setLineColor (const QColor &__value, double alpha)
 set the color of the graph line
void setLineColorInvertedFrom (QColor __noninvertedColor)
 sets the line-color as an inverted version of the given color
void setLineDashOffset (qreal offset)
 sets the dash offset for a custom dash style
void setLineDashPattern (const QVector< qreal > &pattern)
 sets the dash pattern for a custom dash style
void setLineJoinStyle (Qt::PenJoinStyle style)
 sets the join style
void setLineStyle (Qt::PenStyle __value)
 set the style of the graph line
void setLineWidth (double __value)
 set the line width of the graph line (in pt)
Public Member Functions inherited from JKQTPGraphFillStyleMixin
 JKQTPGraphFillStyleMixin ()
 class constructor
virtual ~JKQTPGraphFillStyleMixin ()
QBrush getFillBrush (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QBrush from the graph fill styling properties
QColor getFillColor () const
 set the color of the graph filling
const QGradient * getFillGradient () const
 get the gradient object of the graph filling
Qt::BrushStyle getFillStyle () const
 get the fill style of the graph
QPixmap getFillTexture () const
 set the color of the graph filling
QImage getFillTextureImage () const
 set the color of the graph filling
void initFillStyle (JKQTBasePlotter *parent, int &parentPlotStyle, JKQTPPlotStyleType styletype=JKQTPPlotStyleType::Default)
 initiaize the fill style (from the parent plotter)
void initFillStyleInvertedColor (JKQTPGraphFillStyleMixin *other)
 initiaize the fill style from another JKQTPGraphFillStyleMixin other by inverting its fill color
void setFillBrush (const QBrush &b)
 sets a fill brush (overwrites all internal properties!)
void setFillColor (const QColor &__value)
 set the color of the graph filling
void setFillColor (const QColor &__value, double alpha)
 set the color of the graph filling
void setFillGradient (const QGradient &__value)
 set the filling of the graph to a gradient and sets fill style to a gradient setting
void setFillStyle (Qt::BrushStyle __value)
 set the fill style of the graph
void setFillTexture (const QImage &__value)
 set the color of the graph filling and sets fill style to Qt::TexturePattern
void setFillTexture (const QPixmap &__value)
 set the color of the graph filling and sets fill style to Qt::TexturePattern
void setFillTransform (const QTransform &b)
 sets a fill transformation

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 JKQTPRangeBase
void setCenterColor (const QColor &__value)
 color of the center line graph
void setCenterStyle (Qt::PenStyle __value)
 linestyle of the center line graph lines
virtual void setColor (QColor c)
 set the color of the graph (all lines and filling)
void setDrawCenterLineOnly ()
 disables all drawing features except the centerline
void setFillRange (bool __value)
 if true, this fills the range with fillColor
void setInvertedRange (bool __value)
 if true, fills the parts outside the given range
void setPlotCenterLine (bool __value)
 indicates whether to plot a center line
void setPlotRange (bool __value)
 if true, the range is plotted, if false, only the center line is plotted (if plotCenterLine is true )
void setPlotRangeLines (bool __value)
 if true, draws lines at the range borders color
void setRangeCenter (double __value)
 where to plot the center line
void setRangeMax (double __value)
 max-value of range
void setRangeMin (double __value)
 min-value of range
void setSizeMax (double __value)
 if unlimitedSizeMax==false, then the range rectangle only extends to this value on the axis perpendicular to the range axis (towards larger numbers)
void setSizeMin (double __value)
 if unlimitedSizeMin==false, then the range rectangle only extends to this value on the axis perpendicular to the range axis (towards smaller numbers)
void setUnlimitedSizeMax (bool __value)
 if true, the range elongates infinitely in the direction perpendicular to the range axis and towards larger numbers, otherwise the range rectangle stops at rangeMin
void setUnlimitedSizeMin (bool __value)
 if true, the range elongates infinitely in the direction perpendicular to the range axis and towards smaller numbers, otherwise the range rectangle stops at rangeMin
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 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 Attributes inherited from JKQTPRangeBase
QColor centerColor
 color of the center line graph
double centerLineWidth
 width (pt) of the center line graph, given in pt
Qt::PenStyle centerStyle
 linestyle of the center line graph lines
bool fillRange
 if true, this fills the range with fillColor
bool invertedRange
 if true, fills the parts outside the given range
bool plotCenterLine
 indicates whether to plot a center line
bool plotRange
 if true, the range is plotted, if false, only the center line is plotted (if plotCenterLine is true )
bool plotRangeLines
 if true, draws lines at the range borders color
double rangeCenter
 where to plot the center line
double rangeMax
 max-value of range
double rangeMin
 min-value of range
double sizeMax
 if unlimitedSizeMax==false, then the range rectangle only extends to this value on the axis perpendicular to the range axis (towards larger numbers)
double sizeMin
 if unlimitedSizeMin==false, then the range rectangle only extends to this value on the axis perpendicular to the range axis (towards smaller numbers)
bool unlimitedSizeMax
 if true, the range elongates infinitely in the direction perpendicular to the range axis and towards larger numbers, otherwise the range rectangle stops at rangeMin
bool unlimitedSizeMin
 if true, the range elongates infinitely in the direction perpendicular to the range axis and towards smaller numbers, otherwise the range rectangle stops at rangeMin
Protected Attributes inherited from JKQTPPlotElement
QVector< HitTestLocationm_hitTestData
 dataset with graph-points and associated data from the function hitTest()
JKQTBasePlotterparent
 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
Properties inherited from JKQTPGraphLineStyleMixin
QColor highlightingLineColor
QColor lineColor
Qt::PenStyle lineStyle
double lineWidth
Properties inherited from JKQTPGraphFillStyleMixin
QColor fillColor
Qt::BrushStyle fillStyle

Detailed Description

simply marks a range (and possibly a centerline) in a plot. This may be used to display e.g. mean +/- stddev or a range of interest, or the range of good values, ...

See also
JKQTPVerticalRange

Explanation of basic features:

Constructor & Destructor Documentation

◆ JKQTPHorizontalRange() [1/2]

JKQTPHorizontalRange::JKQTPHorizontalRange ( JKQTBasePlotter * parent = nullptr)

class constructor

◆ JKQTPHorizontalRange() [2/2]

JKQTPHorizontalRange::JKQTPHorizontalRange ( JKQTPlotter * parent)

class constructor

Member Function Documentation

◆ draw()

virtual void JKQTPHorizontalRange::draw ( JKQTPEnhancedPainter & painter)
overridevirtual

plots the graph to the plotter object specified as parent

Implements JKQTPPlotElement.

◆ drawKeyMarker()

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

plots a key marker inside the specified rectangle rect

Implements JKQTPPlotElement.

◆ getXMinMax()

bool JKQTPHorizontalRange::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!

Implements JKQTPPlotElement.

◆ getYMinMax()

bool JKQTPHorizontalRange::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!

Implements JKQTPPlotElement.


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