sciplot  0.3.1
A modern C++ plotting library powered by gnuplot
TicsSpecsMajor Class Reference

The class used to specify options for major tics of a specific axis. More...

#include <TicsSpecsMajor.hpp>

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

Public Member Functions

 TicsSpecsMajor (std::string axis)
 Construct a default TicsSpecsMajor instance.
 
auto automatic () -> TicsSpecsMajor &
 Set the values of the tics to be identified automatically.
 
auto start (double value) -> TicsSpecsMajor &
 Set the start value for the tics (you must also call method increment).
 
auto increment (double value) -> TicsSpecsMajor &
 Set the increment for the tics (start and end values determined automatically).
 
auto end (double value) -> TicsSpecsMajor &
 Set the end value for the tics (you must also call methods start and increment).
 
auto interval (double start, double increment, double end) -> TicsSpecsMajor &
 Set the start, increment and end values of the tics.
 
auto at (const std::vector< double > &values) -> TicsSpecsMajor &
 Set the values of the tics that should be displayed.
 
auto at (const std::vector< double > &values, const std::vector< std::string > &labels) -> TicsSpecsMajor &
 Set the labels that should be displayed on given tic values.
 
auto add (const std::vector< double > &values) -> TicsSpecsMajor &
 Add more tics to be displayed with given tic values.
 
auto add (const std::vector< double > &values, const std::vector< std::string > &labels) -> TicsSpecsMajor &
 Add more tics to be displayed with given tic values and corresponding labels.
 
auto repr () const -> std::string
 Convert this TicsSpecsMajor object into a gnuplot formatted string.
 
- Public Member Functions inherited from TicsSpecsBaseOf< TicsSpecsMajor >
 TicsSpecsBaseOf ()
 Construct a default TicsSpecsBaseOf instance.
 
auto alongAxis () -> TicsSpecsMajor &
 Set the tics to be displayed along the axis.
 
auto alongBorder () -> TicsSpecsMajor &
 Set the tics to be displayed along the border.
 
auto mirror (bool value=true) -> TicsSpecsMajor &
 Set the tics to be mirrored on the opposite border if true.
 
auto insideGraph () -> TicsSpecsMajor &
 Set the tics to be displayed inside the graph.
 
auto outsideGraph () -> TicsSpecsMajor &
 Set the tics to be displayed outside the graph.
 
auto rotate (bool value=true) -> TicsSpecsMajor &
 Set the tics to be rotated by 90 degrees if true.
 
auto rotateBy (double degrees) -> TicsSpecsMajor &
 Set the tics to be rotated by given degrees.
 
auto scaleBy (double value) -> TicsSpecsMajor &
 Set the scale for the major tics (identical to method scaleMajorBy).
 
auto scaleMajorBy (double value) -> TicsSpecsMajor &
 Set the scale for the major tics.
 
auto scaleMinorBy (double value) -> TicsSpecsMajor &
 Set the scale for the minor tics.
 
auto format (std::string fmt) -> TicsSpecsMajor &
 Set the format of the tics using a format expression ("%.2f")
 
auto logscale (int base=10) -> TicsSpecsMajor &
 Set logarithmic scale with base for an axis.
 
auto repr () const -> std::string
 Convert this TicsSpecsBaseOf object into a gnuplot formatted string.
 
auto repr (std::string axis) const -> std::string
 Convert this TicsSpecsBaseOf object into a gnuplot formatted string.
 
- Public Member Functions inherited from TextSpecsOf< TicsSpecsMajor >
 TextSpecsOf ()
 Construct a default TextSpecsOf instance.
 
auto textColor (std::string color) -> TicsSpecsMajor &
 Set the color of the text (e.g., "blue", "#404040")
 
auto enhanced (bool value=true) -> TicsSpecsMajor &
 Set the enhanced mode of the text. More...
 
- Public Member Functions inherited from FontSpecsOf< TicsSpecsMajor >
 FontSpecsOf ()
 Construct a default FontSpecsOf instance.
 
auto fontName (std::string name) -> TicsSpecsMajor &
 Set the name of the font (e.g., Helvetica, Georgia, Times).
 
auto fontSize (std::size_t size) -> TicsSpecsMajor &
 Set the point size of the font (e.g., 10, 12, 16).
 
- Public Member Functions inherited from Specs< TicsSpecsMajor >
virtual ~Specs ()=default
 Pure virtual destructor (this class is an abstract base class).
 
 operator std::string () const
 Return a string representation of this object of some class that derives from specs.
 
auto derived () -> TicsSpecsMajor &
 Return a reference to the specs object of class derived from this.
 
auto derived () const -> const TicsSpecsMajor &
 Return a const reference to the specs object of class derived from this.
 
- Public Member Functions inherited from OffsetSpecsOf< TicsSpecsMajor >
 OffsetSpecsOf ()
 Construct a default OffsetSpecsOf instance.
 
auto shiftAlongX (double chars) -> TicsSpecsMajor &
 Shift the underlying plot element along the x direction by given number of characters (can be fraction).
 
auto shiftAlongY (double chars) -> TicsSpecsMajor &
 Shift the underlying plot element along the y direction by given number of characters (can be fraction).
 
auto shiftAlongGraphX (double val) -> TicsSpecsMajor &
 Shift the underlying plot element along the x direction within the graph coordinate system.
 
auto shiftAlongGraphY (double val) -> TicsSpecsMajor &
 Shift the underlying plot element along the y direction within the graph coordinate system.
 
auto shiftAlongScreenX (double val) -> TicsSpecsMajor &
 Shift the underlying plot element along the x direction within the screen coordinate system.
 
auto shiftAlongScreenY (double val) -> TicsSpecsMajor &
 Shift the underlying plot element along the y direction within the screen coordinate system.
 
- Public Member Functions inherited from ShowSpecsOf< TicsSpecsMajor >
 ShowSpecsOf ()
 Construct a default ShowSpecsOf instance.
 
auto show (bool value=true) -> TicsSpecsMajor &
 Set the visibility status of the plot element.
 
auto hide () -> TicsSpecsMajor &
 Set the visibility status of the plot element as hidden.
 
auto isHidden () const -> bool
 Return true if the underlying plot element is hidden.
 

Detailed Description

The class used to specify options for major tics of a specific axis.


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