JKQtPlotter/doc/dox/jkqtplotter_plotelements_classdoc.dox

484 lines
15 KiB
Plaintext

/*!
\defgroup jkqtplotter_elements Plot Element Classes
\ingroup jkqtplotter_classdoc
This group assembles all classes that represent different elements of a plot (managed by JKQTBasePlotter/JKQTPlotter).
There are these major subgroups:
- \ref jkqtpbaseplotter_elements contains all non-graph objects, i.e. things like coordinate axes and so on
- \ref jkqtplotter_concretegraphs contains the actual graph classes
.
\defgroup jkqtpbaseplotter_elements Non-Graph Plot Elements
\ingroup jkqtplotter_elements
This group contains some tool classes that implement basic elements of the plot (coordinate axes, key, ...).
These classes are used by JKQTPlotterBase to output the plot.
\defgroup jkqtplotter_basegraphs Baseclasses for Graphs
\ingroup jkqtplotter_elements
\defgroup jkqtplotter_mixins Mix-in classes for Graphs
\ingroup jkqtplotter_elements
\defgroup jkqtplotter_basegraphserrors Mix-In Classes for Error Indicators
\ingroup jkqtplotter_mixins
\defgroup jkqtplotter_basegraphs_stylemixins Mix-In Classes for Styling General Graphs
\ingroup jkqtplotter_mixins
\defgroup jkqtplotter_specialgraphs_stylemixins Mix-In Classes for Styling Specialized Graphs (Boxplots etz.)
\ingroup jkqtplotter_mixins
\defgroup jkqtplotter_concretegraphs Concrete Graph Classes
\ingroup jkqtplotter_elements
<table>
<tr>
<th>Icon
<th>
<th>Topic/Chapter
<tr>
<td>\link jkqtplotter_linesymbolgraphs &nbsp; \image{inline} html symbols_and_styles_small.png "" \endlink
<td>\link jkqtplotter_linesymbolgraphs &nbsp; \image{inline} html stepplots_small.png "" \endlink
<td>\ref jkqtplotter_linesymbolgraphs
<tr>
<td>\link jkqtplotter_filledgraphs &nbsp; \image{inline} html JKQTPFilledCurveXGraph_small.png "" \endlink
<td>\link jkqtplotter_filledgraphs &nbsp; \image{inline} html JKQTPfilledVerticalRangeGraph_WithLines_small.png "" \endlink
<td>\ref jkqtplotter_filledgraphs
<tr>
<td>&nbsp;
<td>\link jkqtplotter_sticks &nbsp; \image{inline} html JKQTPImpulsesVerticalGraph_Symbols_small.png "" \endlink
<td>\ref jkqtplotter_sticks
<tr>
<td>\link jkqtplotter_barcharts &nbsp; \image{inline} html JKQTPBarVerticalGraph_small.png "" \endlink
<td>\link jkqtplotter_barcharts &nbsp; \image{inline} html JKQTPbarVerticalGraphStacked_small.png "" \endlink
<td>\ref jkqtplotter_barcharts
<tr>
<td>\link jkqtplotter_statgraphs &nbsp; \image{inline} html boxplot_small.png "" \endlink
<td>\link jkqtplotter_statgraphs &nbsp; \image{inline} html JKQTPViolinplotVerticalElement_small.png "" \endlink
<td>\ref jkqtplotter_statgraphs
<tr>
<td>&nbsp;
<td>\link jkqtplotter_eventgraphs &nbsp; \image{inline} html JKQTPPeakStreamGraphY_small.png "" \endlink
<td>\ref jkqtplotter_eventgraphs
<tr>
<td>\link jkqtplotter_imagelots &nbsp; \image{inline} html JKQTPMathImageBaseModifyNone_small.png "" \endlink
<td>\link jkqtplotter_imagelots &nbsp; \image{inline} html overlayimageenhanced_small.png "" \endlink
<td>\ref jkqtplotter_imagelots
<tr>
<td>&nbsp;
<td>\link jkqtplotter_imagelots_contour &nbsp; \image{inline} html JKQTPColumnContourPlot_small.png "" \endlink
<td>\ref jkqtplotter_imagelots_contour
<tr>
<td>&nbsp;
<td>\link jkqtplotter_vectorfieldgraphs &nbsp; \image{inline} html paramvectorfield_small.png "" \endlink
<td>\ref jkqtplotter_vectorfieldgraphs
<tr>
<td>&nbsp;
<td>\link jkqtplotter_financialgraphs &nbsp; \image{inline} html financialgraphs_small.png "" \endlink
<td>\ref jkqtplotter_financialgraphs
<tr>
<td>\link jkqtplotter_geoplots &nbsp; \image{inline} html geo_coordinateaxis0_small.png "" \endlink
<td>\link jkqtplotter_geoplots &nbsp; \image{inline} html geo_text_small.png "" \endlink
<td>\ref jkqtplotter_geoplots
<tr>
<td>&nbsp;
<td>\link jkqtplotter_annotations &nbsp; \image{inline} html JKQTPHorizontalRange_small.png "" \endlink
<td>\ref jkqtplotter_annotations
<tr>
<td>&nbsp;
<td>\link jkqtplotter_graphlabels &nbsp; \image{inline} html JKQTPGLSimpleBoxAndLineONLYLABELS_small.png "" \endlink
<td>\ref jkqtplotter_graphlabels
</table>
\defgroup jkqtplotter_linesymbolgraphs Line/Symbol Graphs
\ingroup jkqtplotter_concretegraphs
This group assembles graphs that show their data with symbols and optionally with connecting lines in diferent styles:
<table>
<tr>
<td>\link jkqtplotter_linesymbolgraphs_scatter &nbsp; \image{inline} html JKQTPXYScatterGraph_small.png "" \endlink
<td>\link jkqtplotter_linesymbolgraphs_scatter &nbsp; \image{inline} html beeswarmplot_small.png "" \endlink
<td>\ref jkqtplotter_linesymbolgraphs_scatter
<tr>
<td>\link jkqtplotter_linesymbolgraphs_line &nbsp; \image{inline} html symbols_and_styles_small.png "" \endlink
<td>\link jkqtplotter_linesymbolgraphs_line &nbsp; \image{inline} html stepplots_small.png "" \endlink
<td>\ref jkqtplotter_linesymbolgraphs_line
<tr>
<td>&nbsp;
<td>\link jkqtplotter_linesymbolgraphs_param &nbsp; \image{inline} html paramscatterplot_small.png "" \endlink\endlink
<td>\ref jkqtplotter_linesymbolgraphs_param
<tr>
<td>\link jkqtplotter_functiongraphs &nbsp; \image{inline} html functionplot_small.png "" \endlink
<td>\link jkqtplotter_functiongraphs &nbsp; \image{inline} html evalcurve_small.png "" \endlink
<td>\ref jkqtplotter_functiongraphs
</table>
\defgroup jkqtplotter_linesymbolgraphs_scatter Scatter Graphs
\ingroup jkqtplotter_linesymbolgraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html beeswarmplot_small.png
<td> JKQTPSingleColumnSymbolsGraph
<tr>
<td>\image html JKQTPXYScatterGraph_small.png
<td> JKQTPXYScatterGraph, JKQTPXYScatterErrorGraph
</table>
\defgroup jkqtplotter_linesymbolgraphs_line Line Graphs
\ingroup jkqtplotter_linesymbolgraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html symbols_and_styles_small.png
<td> JKQTPXYLineGraph, JKQTPXYLineErrorGraph
<tr>
<td>\image html stepplots_small.png
<td> JKQTPSpecialLineHorizontalGraph, JKQTPSpecialLineVerticalGraph
</table>
\defgroup jkqtplotter_linesymbolgraphs_param Bubble Charts / Parametrized Scatter Graphs
\ingroup jkqtplotter_linesymbolgraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html paramscatterplot_small.png
<td> JKQTPXYParametrizedScatterGraph, JKQTPXYParametrizedErrorScatterGraph
</table>
\defgroup jkqtplotter_functiongraphs Function Graphs
\ingroup jkqtplotter_linesymbolgraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html functionplot_small.png
<td> JKQTPXFunctionLineGraph, JKQTPYFunctionLineGraph
<tr>
<td>\image html functionplot_small.png
<td> JKQTPXParsedFunctionLineGraph, JKQTPYParsedFunctionLineGraph
<tr>
<td>\image html evalcurve_small.png
<td> JKQTPXYFunctionLineGraph
</table>
\defgroup jkqtplotter_graphlabels Labeling Datapoints
\ingroup jkqtplotter_concretegraphs
This group assembles graphs that add (textual) labels to the datapoints in a plot:
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html JKQTPGLSimpleBoxAndLineONLYLABELS_small.png
<td> JKQTPXYGraphLabels
</table>
\defgroup jkqtplotter_filledgraphs Filled Polygon/Area Graphs
\ingroup jkqtplotter_concretegraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html JKQTPFilledCurveXGraph_small.png
<td> JKQTPFilledCurveXGraph, JKQTPFilledCurveYGraph
<tr>
<td>\image html JKQTPFilledCurveXErrorGraph_small.png
<td> JKQTPFilledCurveXErrorGraph, JKQTPFilledCurveYErrorGraph
<tr>
<td>\image html JKQTPfilledVerticalRangeGraph_WithLines_small.png
<td> JKQTPFilledVerticalRangeGraph, JKQTPFilledHorizontalRangeGraph
</table>
\defgroup jkqtplotter_barcharts Barcharts
\ingroup jkqtplotter_concretegraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html JKQTPBarVerticalGraph_small.png
<td> JKQTPBarVerticalGraph, JKQTPBarHorizontalGraph
<tr>
<td>\image html JKQTPBarVerticalErrorGraph_small.png
<td> JKQTPBarVerticalErrorGraph, JKQTPBarHorizontalErrorGraph
<tr>
<td>\image html JKQTPbarVerticalGraphStacked_small.png
<td> JKQTPBarVerticalStackableGraph, JKQTPBarHorizontalStackableGraph
</table>
\defgroup jkqtplotter_sticks Impulse-Charts
\ingroup jkqtplotter_concretegraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html JKQTPImpulsesVerticalGraph_Symbols_small.png
<td> JKQTPImpulsesHorizontalGraph, JKQTPImpulsesVerticalGraph
<tr>
<td>\image html JKQTPImpulsesVerticalErrorGraph_small.png
<td> JKQTPImpulsesHorizontalErrorGraph, JKQTPImpulsesVerticalErrorGraph
</table>
\defgroup jkqtplotter_statgraphs Statistical Graphs (e.g. Boxplots ...)
\ingroup jkqtplotter_concretegraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html boxplot_small.png
<td> JKQTPBoxplotVerticalGraph, JKQTPBoxplotHorizontalGraph
<tr>
<td>\image html geo_boxplot_small.png
<td> JKQTPBoxplotVerticalElement, JKQTPBoxplotHorizontalElement
<tr>
<td>\image html JKQTPViolinplotVerticalElement_small.png
<td> JKQTPViolinplotVerticalElement, JKQTPViolinplotHorizontalElement
</table>
\see \ref jkqtptools_math_statistics_adaptors for shortcuts to calculate statistical properties of data and then adding a plot with the results.
\defgroup jkqtplotter_geoplots Geometric Elements (Lines, Rectangles, ...)
\ingroup jkqtplotter_concretegraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html symbol_filled_diamond.png
<td> JKQTPGeoSymbol
<tr>
<td>\image html geo_text_small.png
<td> JKQTPGeoText
<tr>
<td>\image html geo_line_small.png
<td> JKQTPGeoLine, JKQTPGeoInfiniteLine, JKQTPGeoPolyLines
<tr>
<td>\image html geo_arrows_small.png
<td> JKQTPGeoArrow
<tr>
<td>\image html geo_bezier_small.png
<td> JKQTPGeoBezierCurve
<tr>
<td>\image html geo_rect_small.png
<td> JKQTPGeoRectangle
<tr>
<td>\image html geo_polygon_small.png
<td> JKQTPGeoPolygon
<tr>
<td>\image html geo_ellipse_small.png
<td> JKQTPGeoEllipse
<tr>
<td>\image html geo_arc_small.png
<td> JKQTPGeoArc
<tr>
<td>\image html geo_pie_small.png
<td> JKQTPGeoPie
<tr>
<td>\image html geo_chords_small.png
<td> JKQTPGeoChord
</table>
Examples:
- \ref JKQTPlotterGeometricGraphs
.
\defgroup jkqtplotter_annotations Graph Annotations
\ingroup jkqtplotter_concretegraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html symbol_filled_diamond.png
<td> JKQTPGeoSymbol
<tr>
<td>\image html geo_text_small.png
<td> JKQTPGeoText
<tr>
<td>\image html JKQTPGLSimpleBoxAndLineONLYLABELS_small.png
<td> JKQTPXYGraphLabels
<tr>
<td>\image html JKQTPHorizontalRange_small.png
<td> JKQTPHorizontalRange, JKQTPVerticalRange
</table>
Examples:
- \ref JKQTPlotterGeometricGraphs
.
\defgroup jkqtplotter_eventgraphs Event Graphs
\ingroup jkqtplotter_concretegraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html JKQTPPeakStreamGraphY_small.png
<td> JKQTPPeakStreamGraph
</table>
\defgroup jkqtplotter_vectorfieldgraphs Vector Fields
\ingroup jkqtplotter_concretegraphs
This group assembles graphs that represent vector fields (i.e. sets of quadruples (x,y,dx,dy) or (x,y,angle,lengthh) in a plot:
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html vectorfield_small.png
<td> JKQTPVectorFieldGraph
<tr>
<td>\image html paramvectorfield_small.png
<td> JKQTPParametrizedVectorFieldGraph
</table>
\defgroup jkqtplotter_financialgraphs Financial Graphs
\ingroup jkqtplotter_concretegraphs
This group assembles graphs that represent financial data (such as price mmovement of stocks, derivatives, ... and other traded goods) in a plot:
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html financialgraphs_small.png
<td> JKQTPFinancialGraph
</table>
\defgroup jkqtplotter_imagelots Matrix/Image Plotting
\ingroup jkqtplotter_concretegraphs
<table>
<tr>
<td>\link jkqtplotter_imagelots_elements &nbsp; \image{inline} html rgbimageplot_qt_small.png "" \endlink
<td>\link jkqtplotter_imagelots_elements &nbsp; \image{inline} html JKQTPMathImageBaseModifyNone_small.png "" \endlink
<td>\ref jkqtplotter_imagelots_elements
<tr>
<td>&nbsp;
<td>\link jkqtplotter_imagelots_overlays &nbsp; \image{inline} html overlayimageenhanced_small.png "" \endlink\endlink
<td>\ref jkqtplotter_imagelots_overlays
<tr>
<td>&nbsp;
<td>\link jkqtplotter_imagelots_contour &nbsp; \image{inline} html JKQTPColumnContourPlot_small.png "" \endlink\endlink
<td>\ref jkqtplotter_imagelots_contour
<tr>
<td>&nbsp;
<td>\link jkqtplotter_vectorfieldgraphs &nbsp; \image{inline} html paramvectorfield_small.png "" \endlink\endlink
<td>\ref jkqtplotter_vectorfieldgraphs
<tr>
<td>&nbsp;
<td>\link jkqtplotter_imagelots_tools_LUTS &nbsp; \image{inline} html logo_palette_luts.png "" \endlink\endlink
<td>\ref jkqtplotter_imagelots_tools_LUTS
</table>
\defgroup jkqtplotter_imagelots_elements Image Graphs
\ingroup jkqtplotter_imagelots
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html rgbimageplot_qt_small.png
<td> JKQTPImage
<tr>
<td>\image html JKQTPMathImageBaseModifyNone_small.png
<td> JKQTPMathImage, JKQTPColumnMathImage
<tr>
<td>\image html rgbimageplot_cimg_small.png
<td> JKQTPRGBMathImage, JKQTPColumnRGBMathImage
</table>
\defgroup jkqtplotter_imagelots_overlays Image/Matrix Overlay Graphs
\ingroup jkqtplotter_imagelots
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html overlayimage_small.png
<td> JKQTPOverlayImage
<tr>
<td>\image html overlayimageenhanced_small.png
<td> JKQTPOverlayImageEnhanced, JKQTPColumnOverlayImageEnhanced
</table>
\defgroup jkqtplotter_imagelots_tools Tool Functions & Classes for Image Drawing
\ingroup jkqtplotter_imagelots
\defgroup jkqtplotter_imagelots_tools_LUTS Tool Functions to Build Lookup-Tables for Palettes
\ingroup jkqtplotter_imagelots_tools
\defgroup jkqtplotter_imagelots_contour Contour Graphs (based on Image Data)
\ingroup jkqtplotter_concretegraphs
<table>
<tr>
<th> Screenshot
<th> Classes
<tr>
<td>\image html JKQTPColumnContourPlot_small.png
<td> JKQTPContourPlot, JKQTPColumnContourPlot
</table>
*/