Developer Guide

Features provided by MakieMaestro are:

• Exporting: uses Theming and Sizing
• Documenter plugin: uses Exporting
• Pluto.jl (with_backend): decoupled from anything else
• Ensemble plots: decoupled from anything else

Exporting Figures

Top user facing interface is the savefig function. The only other user facing functions that should be used by an average user are ones that are used to set the defaults for the savefig arguments. These are:

• figure_dir!,
• Themes.width!/Themes.hwratio! and
• export_format!.

savefig

The root implementation is in src/export/savefig.jl which calls the appropriate exporting functions based on the preprocessed arguments. The preprocessed arguments consist of:

• FunctionSpec
  • Implemented in src/export/function_spec.jl
  • Stores the arguments (and key-word arguments) that are passed to the figure function upon the figure creation,
  • Used to determine the name of the figure if the name is not provided
• SizeSpec
  • Implemented in src/export/size_spec.jl
  • Used to determine the actual physical dimensions from the passed combination of arguments (width, height, height-width ratio)
  • Takes care of converting the physical size to the Makie units (See Themes.to_units)
  • Uses the functions Themes.get_hwratio and Themes.get_width to use either the default or the set values from Themes.width! and Themes.hwratio!
• PathSpec
  • implemented in src/export/path_spec.jl and src/export/utils.jl to determine the formats
  • Does not represent only one path but can represent multiple with different formats
  • Uses get_figure_dir to get the figure directory set by figure_dir!

FigureLoggers

Loggers are types that can be used to monitor when a figure got exported and all of the associated metadata for the figure creation. Currently, there the two concrete types implemented:

• NullLogger
  • does nothing when adding an entry and stores no keys
• TOMLLogger
  • stores the entries in a TOML file