Class Figure¶
- Defined in File cpplot.h
Class Documentation¶
-
class
Figure
¶ Public Functions
-
Figure
()¶
-
template <class T>
voidadd
(T &plot)¶ Add plot data to the figure.
- Template Parameters
T
: type of the plot data to add
- Parameters
plot
:
-
void
write
(std::string file_name, bool append_extension = true, bool print_to_stdout = false)¶ Write the figure to a file.
CAUTION: Overwrites any existing file contents.
- Parameters
file_name
: The file name to write to, including any absolute or relative pathappend_extension
: If true, a .json extension will be appended to file_name (if not already present)print_to_stdout
: Default false. If true, the json will also be printed to std::cout (useful for debugging)
Public Members
Optional metadata - Short_caption used in report contents tables.
Optional metadata - Long caption used beside the figure (e.g. in a report)
-