scatter::Figure Class Reference

[brief description] More...

#include <scatter/Figure.hpp>

Public Member Functions
	Figure (const FigureOptions &options=FigureOptions(), const unsigned &n_rows=1, const unsigned &n_cols=1)
	constructor
virtual	~Figure ()
	destructor
void	add (const std::shared_ptr< Plot > &plot, const unsigned &row=0, const unsigned &col=0)
	add a Plot to this Figure
void	save (const std::string &file)
	save the Figure to the given file

Detailed Description

[brief description]

[long description]

Constructor & Destructor Documentation

Figure()

scatter::Figure::Figure	(	const FigureOptions &	options = FigureOptions(),
		const unsigned &	n_rows = 1,
		const unsigned &	n_cols = 1 )

constructor

[long description]

Parameters

options	FigureOptions
n_rows	number of rows for Plot
n_cols	number of columns for Plot

~Figure()

virtual scatter::Figure::~Figure ( )

virtual

destructor

[long description]

Member Function Documentation

add()

void scatter::Figure::add	(	const std::shared_ptr< Plot > &	plot,
		const unsigned &	row = 0,
		const unsigned &	col = 0 )

add a Plot to this Figure

will override the Plot that is currently at the given position!

Parameters

plot	Plot
row	assign a row to the given Plot
col	assign a column to the given Plot

save()

void scatter::Figure::save

(

const std::string &

file

)

save the Figure to the given file

[long description]

Parameters

file

filepath

---

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

• Figure.hpp