signalsmith::plot::Axis Class Reference

#include <plot.h>

Detailed Description

A map from values to screen-space.

Individual grid/ticks can be added with .major()/.minor()/.tick().

axis.major(4); // default label
axis.major(5, "five"); // explicit label

Multiple grids/ticks can be added using .majors()/.minors()/.ticks(), which accept a variable number of values:

axis.majors(0, 10).minors(2, 4, 6, 8);

Methods
double	drawMin () const
double	drawMax () const
double	drawSize () const
	Axis (double drawLow, double drawHigh)
	Axis (const Axis &other)=default
void	autoValue (double v)
	Register a value for the auto-scale. More...
void	autoSetup ()
Axis &	blank (bool includeLinked=false)
	Prevent auto-labelling. More...
Axis &	blankLabels (bool includeLinked=false)
	Clear the names from any existing labels. More...
Axis &	copyFrom (Axis &other, bool clearLabels=false)
	Copy ticks/label from another axis, optionally removing their text. More...
Axis &	linkFrom (Axis &other)
	Link this axis to another, copying any ticks/labels set later as well. More...
Axis &	flip (bool flip=true)
Axis &	label (std::string l, PlotStyle::Counter index=-1)
	Sets the label, and optionally style to match a particular line. More...
const std::string &	label () const
Axis &	range (std::function< double(double)> valueToUnit)
Axis &	range (double map(double))
Axis &	range (std::function< double(double)> map, double lowValue, double highValue)
Axis &	range (double map(double), double lowValue, double highValue)
Axis &	linear (double low, double high)
double	map (double v)
template<class ... Args>
Axis &	major (Args &&...args)
template<class ... Args>
Axis &	minor (Args &&...args)
template<class ... Args>
Axis &	tick (Args &&...args)
Axis &	majors ()
template<class ... Args>
Axis &	majors (Tick tick, Args ...args)
Axis &	minors ()
template<class ... Args>
Axis &	minors (Tick tick, Args ...args)
Axis &	ticks ()
template<class ... Args>
Axis &	ticks (Tick t, Args ...args)

Attributes
double	drawLow
double	drawHigh
PlotStyle::Counter	styleIndex = -1
	Not associated with a particular line by default, but can be. More...
bool	flipped = false
	Whether the axis should draw on the non-default side (e.g. right/top) More...
std::vector< Tick >	tickList

Method Details

autoValue()

void signalsmith::plot::Axis::autoValue ( double  v )

inline

Register a value for the auto-scale.

blank()

Axis& signalsmith::plot::Axis::blank ( bool  includeLinked = false )

inline

Prevent auto-labelling.

blankLabels()

Axis& signalsmith::plot::Axis::blankLabels ( bool  includeLinked = false )

inline

Clear the names from any existing labels.

copyFrom()

Axis& signalsmith::plot::Axis::copyFrom ( Axis &  other, bool  clearLabels = false  )

inline

Copy ticks/label from another axis, optionally removing their text.

label()

Axis& signalsmith::plot::Axis::label ( std::string  l, PlotStyle::Counter  index = -1  )

inline

Sets the label, and optionally style to match a particular line.

linkFrom()

Axis& signalsmith::plot::Axis::linkFrom ( Axis &  other )

inline

Link this axis to another, copying any ticks/labels set later as well.

Member Data Documentation

flipped

bool signalsmith::plot::Axis::flipped = false

Whether the axis should draw on the non-default side (e.g. right/top)

styleIndex

PlotStyle::Counter signalsmith::plot::Axis::styleIndex = -1

Not associated with a particular line by default, but can be.