mirrors/JKQtPlotter
1
0
Fork 0
mirror of https://github.com/jkriege2/JKQtPlotter.git synced 2024-12-25 10:01:38 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc improvements

Browse Source
This commit is contained in:
jkriege2 2024-02-04 22:06:09 +01:00
parent f606327469
commit 26cb23e3ab
17 changed files with 78 additions and 185 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
lib/jkqtplotter/graphs/jkqtpbarchart.h
View File

@ -104,15 +104,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarVerticalGraph: public JKQTPBarGraphBase {
/** \brief plots the graph to the plotter object specified as parent */ /** \brief plots the graph to the plotter object specified as parent */
virtual void draw(JKQTPEnhancedPainter& painter) override; virtual void draw(JKQTPEnhancedPainter& painter) override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
public Q_SLOTS: public Q_SLOTS:
@ -242,15 +236,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarHorizontalGraph: public JKQTPBarGraphBase {
/** \brief plots the graph to the plotter object specified as parent */ /** \brief plots the graph to the plotter object specified as parent */
virtual void draw(JKQTPEnhancedPainter& painter) override; virtual void draw(JKQTPEnhancedPainter& painter) override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief returns the column used as "key" for the current graph (typically this call getXColumn(), but for horizontal graphs like filled curves or barcharts it may call getYColumn() ) */ /** \brief returns the column used as "key" for the current graph (typically this call getXColumn(), but for horizontal graphs like filled curves or barcharts it may call getYColumn() ) */
virtual int getKeyColumn() const override; virtual int getKeyColumn() const override;
@ -290,10 +278,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarHorizontalErrorGraph: public JKQTPBarHorizo
/** \copydoc JKQTPGraph::usesColumn() */ /** \copydoc JKQTPGraph::usesColumn() */
virtual bool usesColumn(int c) const override; virtual bool usesColumn(int c) const override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;

40
lib/jkqtplotter/graphs/jkqtpboxplot.h
View File

@ -114,15 +114,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotVerticalGraph: public JKQTPBoxplotGraph
/** \brief plots a key marker inside the specified rectangle \a rect */ /** \brief plots a key marker inside the specified rectangle \a rect */
virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
protected: protected:
@ -156,15 +150,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotHorizontalGraph: public JKQTPBoxplotGra
virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
}; };
@ -211,15 +199,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotVerticalElement: public JKQTPBoxplotEle
virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
@ -258,15 +240,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotHorizontalElement: public JKQTPBoxplotE
virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
}; };

17
lib/jkqtplotter/graphs/jkqtpevaluatedfunction.h
View File

@ -323,14 +323,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXFunctionLineGraph: public JKQTPFunctorLineGra
/** \copydoc JKQTPEvaluatedFunctionWithErrorsGraphBase::buildPlotFunctorSpec() */ /** \copydoc JKQTPEvaluatedFunctionWithErrorsGraphBase::buildPlotFunctorSpec() */
virtual std::function<QPointF(double)> buildErrorFunctorSpec() override; virtual std::function<QPointF(double)> buildErrorFunctorSpec() override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* This functions returns 0 for both parameters, so that the plotter uses the predefined
* min and max values.
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
@ -379,11 +374,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPYFunctionLineGraph: public JKQTPFunctorLineGra
virtual std::function<QPointF(double)> buildErrorFunctorSpec() override; virtual std::function<QPointF(double)> buildErrorFunctorSpec() override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*/ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
virtual bool getXMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \copydoc JKQTPPlotElement::getYMinMax() */
/** \brief get the maximum and minimum y-value of the graph
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;

9
lib/jkqtplotter/graphs/jkqtpevaluatedfunctionbase.h
View File

@ -84,14 +84,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPEvaluatedFunctionGraphBase: public JKQTPGraph
/** \brief class destructor */ /** \brief class destructor */
virtual ~JKQTPEvaluatedFunctionGraphBase() ; virtual ~JKQTPEvaluatedFunctionGraphBase() ;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* This functions returns 0 for both parameters, so that the plotter uses the predefined
* min and max values.
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief sets the params as a pointer to an internal COPY of the given vector (not the data of the vector, as then the size would be unknown!!!) */ /** \brief sets the params as a pointer to an internal COPY of the given vector (not the data of the vector, as then the size would be unknown!!!) */

10
lib/jkqtplotter/graphs/jkqtpfilledcurve.h
View File

@ -215,10 +215,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPFilledCurveYGraph: public JKQTPFilledCurveGrap
/** \brief class constructor */ /** \brief class constructor */
JKQTPFilledCurveYGraph(JKQTPlotter* parent); JKQTPFilledCurveYGraph(JKQTPlotter* parent);
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief plots the graph to the plotter object specified as parent */ /** \brief plots the graph to the plotter object specified as parent */
@ -253,10 +250,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPFilledCurveYErrorGraph: public JKQTPFilledCurv
/** \copydoc JKQTPGraph::usesColumn() */ /** \copydoc JKQTPGraph::usesColumn() */
virtual bool usesColumn(int c) const override; virtual bool usesColumn(int c) const override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;

4
lib/jkqtplotter/graphs/jkqtpgeoannotations.h
View File

@ -144,9 +144,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoSymbol: public JKQTPPlotAnnotationElement,
/** \brief returns x and y at the same time \see x, y */ /** \brief returns x and y at the same time \see x, y */
QPointF getP() const; QPointF getP() const;
/** \copydoc JKQTPPlotAnnotationElement::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPPlotAnnotationElement::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief plots the graph to the plotter object specified as parent */ /** \brief plots the graph to the plotter object specified as parent */

16
lib/jkqtplotter/graphs/jkqtpgeolines.h
View File

@ -120,9 +120,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoLine: public JKQTPGeoBaseDecoratedLine {
/** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief plots the graph to the plotter object specified as parent /** \brief plots the graph to the plotter object specified as parent
@ -299,9 +299,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoInfiniteLine: public JKQTPGeoBaseDecoratedH
JKQTPGeoInfiniteLine(JKQTPlotter* parent, double x, double y, double dx, double dy); JKQTPGeoInfiniteLine(JKQTPlotter* parent, double x, double y, double dx, double dy);
/** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief plots the graph to the plotter object specified as parent /** \brief plots the graph to the plotter object specified as parent
@ -402,9 +402,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPolyLines: public JKQTPGeoBaseDecoratedLine
JKQTPGeoPolyLines(JKQTPlotter* parent); JKQTPGeoPolyLines(JKQTPlotter* parent);
/** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief plots the graph to the plotter object specified as parent /** \brief plots the graph to the plotter object specified as parent
@ -494,9 +494,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoArc: public JKQTPGeoBaseLine {
*/ */
JKQTPGeoArc(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop); JKQTPGeoArc(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop);
/** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;

16
lib/jkqtplotter/graphs/jkqtpgeoshapes.h
View File

@ -115,9 +115,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoRectangle: public JKQTPGeoBaseFilled {
/** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief plots the graph to the plotter object specified as parent /** \brief plots the graph to the plotter object specified as parent
@ -231,9 +231,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPolygon: public JKQTPGeoBaseFilled {
JKQTPGeoPolygon(JKQTPlotter* parent, DrawMode drawMode=DrawAsGraphicElement); JKQTPGeoPolygon(JKQTPlotter* parent, DrawMode drawMode=DrawAsGraphicElement);
/** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief plots the graph to the plotter object specified as parent /** \brief plots the graph to the plotter object specified as parent
@ -430,9 +430,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPie: public JKQTPGeoEllipse {
JKQTPGeoPie(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop, DrawMode drawMode=DrawAsGraphicElement); JKQTPGeoPie(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop, DrawMode drawMode=DrawAsGraphicElement);
/** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
@ -502,9 +502,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoChord: public JKQTPGeoPie {
*/ */
JKQTPGeoChord(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop, DrawMode drawMode=DrawAsGraphicElement); JKQTPGeoChord(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop, DrawMode drawMode=DrawAsGraphicElement);
/** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief plots the graph to the plotter object specified as parent /** \brief plots the graph to the plotter object specified as parent

10
lib/jkqtplotter/graphs/jkqtpimage.h
View File

@ -73,15 +73,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImageBase: public JKQTPGraph {
/** \brief plots a key marker inside the specified rectangle \a rect */ /** \brief plots a key marker inside the specified rectangle \a rect */
virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief returns the color to be used for the key label */ /** \brief returns the color to be used for the key label */
virtual QColor getKeyLabelColor() const override; virtual QColor getKeyLabelColor() const override;

10
lib/jkqtplotter/graphs/jkqtpimpulses.h
View File

@ -126,9 +126,9 @@ public:
virtual int getValueColumn() const override; virtual int getValueColumn() const override;
/** \copydoc JKQTPXYGraph::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPXYGraph::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
public Q_SLOTS: public Q_SLOTS:
@ -158,7 +158,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesHorizontalErrorGraph: public JKQTPImpu
/** \copydoc JKQTPGraph::usesColumn() */ /** \copydoc JKQTPGraph::usesColumn() */
virtual bool usesColumn(int c) const override; virtual bool usesColumn(int c) const override;
/** \copydoc JKQTPXYGraph::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief returns the column that contains the bar height errors */ /** \brief returns the column that contains the bar height errors */
@ -214,9 +214,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesVerticalGraph: public JKQTPImpulsesGra
virtual void draw(JKQTPEnhancedPainter& painter) override; virtual void draw(JKQTPEnhancedPainter& painter) override;
/** \brief plots a key marker inside the specified rectangle \a rect */ /** \brief plots a key marker inside the specified rectangle \a rect */
virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override;
/** \copydoc JKQTPXYGraph::getXMinMax() */ /** \copydoc JKQTPPlotElement::getXMinMax() */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPXYGraph::getYMinMax() */ /** \copydoc JKQTPPlotElement::getYMinMax() */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
}; };

10
lib/jkqtplotter/graphs/jkqtplines.h
View File

@ -117,15 +117,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYLineErrorGraph: public JKQTPXYLineGraph, pub
/** \brief class constructor */ /** \brief class constructor */
JKQTPXYLineErrorGraph(JKQTPlotter* parent); JKQTPXYLineErrorGraph(JKQTPlotter* parent);
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \copydoc JKQTPGraph::usesColumn() */ /** \copydoc JKQTPGraph::usesColumn() */
virtual bool usesColumn(int c) const override; virtual bool usesColumn(int c) const override;

10
lib/jkqtplotter/graphs/jkqtppeakstream.h
View File

@ -52,15 +52,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPeakStreamGraph: public JKQTPSingleColumnGraph
JKQTPPeakStreamGraph(JKQTBasePlotter* parent=nullptr); JKQTPPeakStreamGraph(JKQTBasePlotter* parent=nullptr);
JKQTPPeakStreamGraph(JKQTPlotter* parent); JKQTPPeakStreamGraph(JKQTPlotter* parent);
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;

20
lib/jkqtplotter/graphs/jkqtpscatter.h
View File

@ -101,15 +101,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYScatterErrorGraph: public JKQTPXYScatterGrap
/** \brief class constructor */ /** \brief class constructor */
JKQTPXYScatterErrorGraph(JKQTPlotter* parent); JKQTPXYScatterErrorGraph(JKQTPlotter* parent);
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \copydoc JKQTPGraph::usesColumn() */ /** \copydoc JKQTPGraph::usesColumn() */
virtual bool usesColumn(int c) const override; virtual bool usesColumn(int c) const override;
@ -441,15 +435,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYParametrizedErrorScatterGraph: public JKQTPX
JKQTPXYParametrizedErrorScatterGraph(JKQTPlotter* parent); JKQTPXYParametrizedErrorScatterGraph(JKQTPlotter* parent);
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \copydoc JKQTPGraph::usesColumn() */ /** \copydoc JKQTPGraph::usesColumn() */
virtual bool usesColumn(int c) const override; virtual bool usesColumn(int c) const override;

10
lib/jkqtplotter/graphs/jkqtpsinglecolumnsymbols.h
View File

@ -65,15 +65,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPSingleColumnSymbolsGraph: public JKQTPSingleCo
JKQTPSingleColumnSymbolsGraph(JKQTBasePlotter* parent=nullptr); JKQTPSingleColumnSymbolsGraph(JKQTBasePlotter* parent=nullptr);
JKQTPSingleColumnSymbolsGraph(JKQTPlotter* parent); JKQTPSingleColumnSymbolsGraph(JKQTPlotter* parent);
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;

20
lib/jkqtplotter/graphs/jkqtpviolinplot.h
View File

@ -178,15 +178,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPViolinplotVerticalElement: public JKQTPViolinp
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
@ -233,15 +227,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPViolinplotHorizontalElement: public JKQTPVioli
virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override;
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
}; };

32
lib/jkqtplotter/jkqtpgraphsbase.h
View File

@ -81,11 +81,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPlotElement: public QObject {
/** \brief get the maximum and minimum x-value of the graph /** \brief get the maximum and minimum x-value of the graph
* *
* The result is given in the two parameters which are call-by-reference parameters! * The result is given in the two parameters which are call-by-reference parameters!
*
* \param[out] minx minimal x-value used in the graph
* \param[out] maxx maximal x-value used in the graph
* \param[out] smallestGreaterZero the smalles x-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)
* \return \c true on success, i.e. if there were datapoints in the plot, or \c false on failure (e.g. when the graph is empty)
*/ */
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero)=0; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero)=0;
/** \brief get the maximum and minimum y-value of the graph /** \brief get the maximum and minimum y-value of the graph
* *
* The result is given in the two parameters which are call-by-reference parameters! * The result is given in the two parameters which are call-by-reference parameters!
*
* \param[out] miny minimal y-value used in the graph
* \param[out] maxy maximal y-value used in the graph
* \param[out] smallestGreaterZero the smalles y-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)
* \return \c true on success, i.e. if there were datapoints in the plot, or \c false on failure (e.g. when the graph is empty)
*/ */
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero)=0; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero)=0;
/** \brief returns the color to be used for the key label */ /** \brief returns the color to be used for the key label */
@ -388,7 +398,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPlotElement: public QObject {
/** \brief dataset with graph-points and associated data fro the function hitTest() /** \brief dataset with graph-points and associated data from the function hitTest()
* \see hitTest(), HitTestLocation * \see hitTest(), HitTestLocation
*/ */
QVector<HitTestLocation> m_hitTestData; QVector<HitTestLocation> m_hitTestData;
@ -590,15 +600,9 @@ public:
/** \brief class constructor */ /** \brief class constructor */
JKQTPXYGraph(JKQTBasePlotter* parent=nullptr); JKQTPXYGraph(JKQTBasePlotter* parent=nullptr);
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \copydoc JKQTPGraph::usesColumn() */ /** \copydoc JKQTPGraph::usesColumn() */
@ -752,10 +756,7 @@ public:
JKQTPXYYGraph(JKQTBasePlotter* parent=nullptr); JKQTPXYYGraph(JKQTBasePlotter* parent=nullptr);
/** \brief get the maximum and minimum y-value of the graph /** \copydoc JKQTPPlotElement::getYMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \copydoc JKQTPGraph::usesColumn() */ /** \copydoc JKQTPGraph::usesColumn() */
@ -813,10 +814,7 @@ public:
JKQTPXXYGraph(JKQTBasePlotter* parent=nullptr); JKQTPXXYGraph(JKQTBasePlotter* parent=nullptr);
/** \brief get the maximum and minimum x-value of the graph /** \copydoc JKQTPPlotElement::getXMinMax() */
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \copydoc JKQTPGraph::usesColumn() */ /** \copydoc JKQTPGraph::usesColumn() */

4
lib/jkqtplotter/jkqtpgraphsbaseerrors.h
View File

@ -161,9 +161,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphErrorStyleMixin {
double m_errorLineWidth; double m_errorLineWidth;
/** \brief fill style of the graph */ /** \brief fill brush for the error indicators */
QBrush m_errorFillBrush; QBrush m_errorFillBrush;
/** \brief last fill color of the graph */ /** \brief fill color for the error indicators */
QColor m_errorFillColor; QColor m_errorFillColor;