DrawSpecs Class Reference

The class where options for the plotted element can be specified. More...

#include <DrawSpecs.hpp>

Inheritance diagram for DrawSpecs:

Collaboration diagram for DrawSpecs:

Public Member Functions
	DrawSpecs (std::string what, std::string use, std::string with)
	Construct a DrawSpecs instance. More...
auto	label (std::string text) -> DrawSpecs &
	Set the legend label of the plotted element.
auto	labelFromColumnHeader () -> DrawSpecs &
	Set the legend label of the plotted element to be retrieved from the header of column.
auto	labelFromColumnHeader (int icolumn) -> DrawSpecs &
	Set the legend label of the plotted element to be retrieved from the header of a column with given index.
auto	labelNone () -> DrawSpecs &
	Set the legend label of the plotted element to be ignored.
auto	labelDefault () -> DrawSpecs &
	Set the legend label to be determined automatically from the plot expression.
auto	xtics (ColumnIndex icol) -> DrawSpecs &
	Set the column in the data file containing the tic labels for x axis.
auto	ytics (ColumnIndex icol) -> DrawSpecs &
	Set the column in the data file containing the tic labels for y axis.
auto	repr () const -> std::string
	Convert this DrawSpecs object into a gnuplot formatted string.
Public Member Functions inherited from LineSpecsOf< DrawSpecs >
	LineSpecsOf ()
	Construct a default LineSpecsOf instance.
auto	lineStyle (int value) -> DrawSpecs &
	Set the line style of the underlying line object.
auto	lineType (int value) -> DrawSpecs &
	Set the line type of the underlying line object.
auto	lineWidth (int value) -> DrawSpecs &
	Set the line width of the underlying line object.
auto	lineColor (std::string value) -> DrawSpecs &
	Set the line color of the underlying line object.
auto	dashType (int value) -> DrawSpecs &
	Set the dash type of the underlying line object.
auto	repr () const -> std::string
	Convert this LineSpecsOf object into a gnuplot formatted string.
Public Member Functions inherited from Specs< DrawSpecs >
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 () -> DrawSpecs &
	Return a reference to the specs object of class derived from this.
auto	derived () const -> const DrawSpecs &
	Return a const reference to the specs object of class derived from this.
Public Member Functions inherited from PointSpecsOf< DrawSpecs >
	PointSpecsOf ()
	Construct a default PointSpecsOf instance.
auto	pointType (int value) -> DrawSpecs &
	Set the point type of the underlying plot object.
auto	pointSize (int value) -> DrawSpecs &
	Set the point size of the underlying plot object.
auto	repr () const -> std::string
	Convert this PointSpecsOf object into a gnuplot formatted string.
Public Member Functions inherited from FillSpecsOf< DrawSpecs >
	FillSpecsOf ()
	Construct a default FillSpecsOf instance.
auto	fillEmpty () -> DrawSpecs &
	Set an empty fill style for the underlying object.
auto	fillSolid () -> DrawSpecs &
	Set a solid fill style for the underlying object.
auto	fillPattern (int number) -> DrawSpecs &
	Set a pattern fill style for the underlying object.
auto	fillColor (std::string value) -> DrawSpecs &
	Set the color for the solid or pattern fill of the underlying object.
auto	fillIntensity (double value) -> DrawSpecs &
	Set the fill color intensity of the underlying object with respect to its border color (a value between 0.0 and 1.0).
auto	fillTransparent (bool active=true) -> DrawSpecs &
	Set the fill of the underlying object to be transparent or not.
auto	borderLineColor (std::string color) -> DrawSpecs &
	Set the border line color of the underlying object.
auto	borderLineWidth (int value) -> DrawSpecs &
	Set the border line width of the underlying object.
auto	borderShow (bool value=true) -> DrawSpecs &
	Set the border of the underlying object to be shown or not.
auto	borderHide () -> DrawSpecs &
	Set the border of the underlying object to be hidden.
auto	repr () const -> std::string
	Convert this FillSpecsOf object into a gnuplot formatted string.
Public Member Functions inherited from FilledCurvesSpecsOf< DrawSpecs >
	FilledCurvesSpecsOf ()
	Construct a default FilledCurveSpecs instance.
auto	above () -> DrawSpecs &
	Limit filled area to above curves.
auto	below () -> DrawSpecs &
	Limit filled area to below curves.
auto	repr () const -> std::string
	Convert this FillSpecsOf object into a gnuplot formatted string.

Detailed Description

The class where options for the plotted element can be specified.

Constructor & Destructor Documentation

DrawSpecs()

DrawSpecs ( std::string  what, std::string  use, std::string  with  )

inline

Construct a DrawSpecs instance.

Parameters

what	The string representing what to be plot (e.g., "'filename'", "sin(x)")
use	The string representing the using expression (e.g., "using 1:2", "using 4:6:8:9")
with	The string representing the with plotstyle expression (e.g., "lines", "linespoints", "dots")

---

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

• sciplot/specs/DrawSpecs.hpp