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

The class used to specify options for tics. More...

#include <TicsSpecs.hpp>

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

Public Member Functions

 TicsSpecs ()
 Construct a default TicsSpecs instance.
 
auto stackFront () -> TicsSpecs &
 Set the tics to be displayed on the front of all plot elements.
 
auto stackBack () -> TicsSpecs &
 Set the tics to be displayed on the back of all plot elements.
 
auto repr () const -> std::string
 Convert this TicsSpecs object into a gnuplot formatted string.
 
- Public Member Functions inherited from TicsSpecsBaseOf< TicsSpecs >
 TicsSpecsBaseOf ()
 Construct a default TicsSpecsBaseOf instance.
 
auto alongAxis () -> TicsSpecs &
 Set the tics to be displayed along the axis.
 
auto alongBorder () -> TicsSpecs &
 Set the tics to be displayed along the border.
 
auto mirror (bool value=true) -> TicsSpecs &
 Set the tics to be mirrored on the opposite border if true.
 
auto insideGraph () -> TicsSpecs &
 Set the tics to be displayed inside the graph.
 
auto outsideGraph () -> TicsSpecs &
 Set the tics to be displayed outside the graph.
 
auto rotate (bool value=true) -> TicsSpecs &
 Set the tics to be rotated by 90 degrees if true.
 
auto rotateBy (double degrees) -> TicsSpecs &
 Set the tics to be rotated by given degrees.
 
auto scaleBy (double value) -> TicsSpecs &
 Set the scale for the major tics (identical to method scaleMajorBy).
 
auto scaleMajorBy (double value) -> TicsSpecs &
 Set the scale for the major tics.
 
auto scaleMinorBy (double value) -> TicsSpecs &
 Set the scale for the minor tics.
 
auto format (std::string fmt) -> TicsSpecs &
 Set the format of the tics using a format expression ("%.2f")
 
auto logscale (int base=10) -> TicsSpecs &
 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< TicsSpecs >
 TextSpecsOf ()
 Construct a default TextSpecsOf instance.
 
auto textColor (std::string color) -> TicsSpecs &
 Set the color of the text (e.g., "blue", "#404040")
 
auto enhanced (bool value=true) -> TicsSpecs &
 Set the enhanced mode of the text. More...
 
- Public Member Functions inherited from FontSpecsOf< TicsSpecs >
 FontSpecsOf ()
 Construct a default FontSpecsOf instance.
 
auto fontName (std::string name) -> TicsSpecs &
 Set the name of the font (e.g., Helvetica, Georgia, Times).
 
auto fontSize (std::size_t size) -> TicsSpecs &
 Set the point size of the font (e.g., 10, 12, 16).
 
- Public Member Functions inherited from Specs< TicsSpecs >
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 () -> TicsSpecs &
 Return a reference to the specs object of class derived from this.
 
auto derived () const -> const TicsSpecs &
 Return a const reference to the specs object of class derived from this.
 
- Public Member Functions inherited from OffsetSpecsOf< TicsSpecs >
 OffsetSpecsOf ()
 Construct a default OffsetSpecsOf instance.
 
auto shiftAlongX (double chars) -> TicsSpecs &
 Shift the underlying plot element along the x direction by given number of characters (can be fraction).
 
auto shiftAlongY (double chars) -> TicsSpecs &
 Shift the underlying plot element along the y direction by given number of characters (can be fraction).
 
auto shiftAlongGraphX (double val) -> TicsSpecs &
 Shift the underlying plot element along the x direction within the graph coordinate system.
 
auto shiftAlongGraphY (double val) -> TicsSpecs &
 Shift the underlying plot element along the y direction within the graph coordinate system.
 
auto shiftAlongScreenX (double val) -> TicsSpecs &
 Shift the underlying plot element along the x direction within the screen coordinate system.
 
auto shiftAlongScreenY (double val) -> TicsSpecs &
 Shift the underlying plot element along the y direction within the screen coordinate system.
 
- Public Member Functions inherited from ShowSpecsOf< TicsSpecs >
 ShowSpecsOf ()
 Construct a default ShowSpecsOf instance.
 
auto show (bool value=true) -> TicsSpecs &
 Set the visibility status of the plot element.
 
auto hide () -> TicsSpecs &
 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 tics.


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