BorderSpecs Class Reference

The class used to specify options for plot border. More...

#include <BorderSpecs.hpp>

Inheritance diagram for BorderSpecs:

Collaboration diagram for BorderSpecs:

Public Member Functions
	BorderSpecs ()
	Construct a default border instance.
auto	clear () -> BorderSpecs &
	Remove all border edges from a 2d or 3d plot.
auto	none () -> BorderSpecs &
	Set all border edges to inactive. Methods none and clear have identical effect.
auto	bottom () -> BorderSpecs &
	Activate the bottom border edge on the xy plane for a 2d plot.
auto	left () -> BorderSpecs &
	Activate the left border edge on the xy plane for a 2d plot.
auto	top () -> BorderSpecs &
	Activate the top border edge on the xy plane for a 2d plot.
auto	right () -> BorderSpecs &
	Activate the right border edge on the xy plane for a 2d plot.
auto	bottomLeftFront () -> BorderSpecs &
	Activate the border edge on the bottom xy plane going from the left corner to front corner in a 3d perspective.
auto	bottomLeftBack () -> BorderSpecs &
	Activate the border edge on the bottom xy plane going from the left corder to back corner in a 3d perspective.
auto	bottomRightFront () -> BorderSpecs &
	Activate the border edge on the bottom xy plane going from the right corner to front corner in a 3d perspective.
auto	bottomRightBack () -> BorderSpecs &
	Activate the border edge on the bottom xy plane going from the right corder to back corner in a 3d perspective.
auto	leftVertical () -> BorderSpecs &
	Activate the left vertical border edge in a 3d perspective.
auto	backVertical () -> BorderSpecs &
	Activate the back vertical border edge in a 3d perspective.
auto	rightVertical () -> BorderSpecs &
	Activate the right vertical border edge in a 3d perspective.
auto	frontVertical () -> BorderSpecs &
	Activate the front vertical border edge in a 3d perspective.
auto	topLeftBack () -> BorderSpecs &
	Activate the border edge on the top xy plane going from the left corner to back corner in a 3d perspective.
auto	topRightBack () -> BorderSpecs &
	Activate the border edge on the top xy plane going from the right corder to back corner in a 3d perspective.
auto	topLeftFront () -> BorderSpecs &
	Activate the border edge on the top xy plane going from the left corner to front corner in a 3d perspective.
auto	topRightFront () -> BorderSpecs &
	Activate the border edge on the top xy plane going from the right corder to front corner in a 3d perspective.
auto	polar () -> BorderSpecs &
	Set the border for polar plot.
auto	repr () const -> std::string
	Convert this BorderSpecs object into a gnuplot formatted string.
Public Member Functions inherited from LineSpecsOf< BorderSpecs >
	LineSpecsOf ()
	Construct a default LineSpecsOf instance.
auto	lineStyle (int value) -> BorderSpecs &
	Set the line style of the underlying line object.
auto	lineType (int value) -> BorderSpecs &
	Set the line type of the underlying line object.
auto	lineWidth (int value) -> BorderSpecs &
	Set the line width of the underlying line object.
auto	lineColor (std::string value) -> BorderSpecs &
	Set the line color of the underlying line object.
auto	dashType (int value) -> BorderSpecs &
	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< BorderSpecs >
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 () -> BorderSpecs &
	Return a reference to the specs object of class derived from this.
auto	derived () const -> const BorderSpecs &
	Return a const reference to the specs object of class derived from this.
Public Member Functions inherited from DepthSpecsOf< BorderSpecs >
	DepthSpecsOf ()
	Construct a default DepthSpecsOf instance.
auto	front () -> BorderSpecs &
	Set the underlying plot element to be displayed on the front of all plot elements.
auto	back () -> BorderSpecs &
	Set the underlying plot element to be displayed on the back of all plot elements.
auto	behind () -> BorderSpecs &
	Set the underlying plot element to be displayed behind of all plot elements. More...
auto	repr () const -> std::string
	Convert this DepthSpecsOf object into a gnuplot formatted string.

Detailed Description

The class used to specify options for plot border.

---

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

• sciplot/specs/BorderSpecs.hpp