MakieMaestro.isvectorgraphic(x::Format)

Return true if x is a vector graphic format, false otherwise.

Examples

julia> MakieMaestro.isvectorgraphic(MakieMaestro.Pdf)
true

julia> MakieMaestro.isvectorgraphic(MakieMaestro.Png)
false

MakieMaestro.skip(skips::Vararg{Union{Symbol,Format}})

Return a Set{Format} of allowed formats by excluding specified formats or format groups.

Useful for customizing the output formats when saving figures, allowing you to easily exclude certain format types or groups of formats.

Arguments

• skips: Variable number of arguments specifying formats or format groups to exclude. Can be individual Format types or symbols :raster or :vector.

Examples

julia> @assert MakieMaestro.skip(:raster) == Set([MakieMaestro.PdfTex, MakieMaestro.Eps, MakieMaestro.Svg, MakieMaestro.Pdf])

julia> @assert MakieMaestro.skip(:vector) == Set([MakieMaestro.Png])

julia> @assert MakieMaestro.skip(MakieMaestro.Pdf, MakieMaestro.Svg) == Set([MakieMaestro.PdfTex, MakieMaestro.Png, MakieMaestro.Eps])

MakieMaestro.extension(format::Format)

Return the string of the extension from the given format.

Examples

julia> MakieMaestro.extension(MakieMaestro.Png)
".png"

julia> MakieMaestro.extension(MakieMaestro.PdfTex)
".pdf"

MakieMaestro.choose_backend(backends::Vector{Module}, f::Format)

Select the best backend from backends to export a figure in the format f.

Prefers CairoMakie for most formats unless the format is Png and GLMakie is available.

Examples

julia> MakieMaestro.choose_backend([CairoMakie, GLMakie], MakieMaestro.Svg)
CairoMakie

julia> MakieMaestro.choose_backend([WGLMakie], MakieMaestro.Eps)
ERROR: None of the backends support the format Eps
[...]

MakieMaestro.backend_formats(backend::Module,...)

Return the set of compatible formats for given backends.

Examples

julia> @assert Set([ MakieMaestro.Png, MakieMaestro.Eps, MakieMaestro.Svg, MakieMaestro.Pdf ]) ⊆ MakieMaestro.backend_formats(CairoMakie) 

julia> @assert MakieMaestro.backend_formats(GLMakie) == Set([MakieMaestro.Png])

MakieMaestro.get_figure_dir()

Get the figure directory

Examples

julia> figure_dir!("/tmp")
"/tmp"

julia> MakieMaestro.get_figure_dir()
"/tmp"

MakieMaestro.get_themes(backend::Module, format::Format)

Get the modification themes associated with the backend and format.

Examples

julia> MakieMaestro.get_themes(CairoMakie, MakieMaestro.PdfTex)
2-element Vector{Symbol}:
 :cairomakie
 :vector

julia> MakieMaestro.get_themes(GLMakie, MakieMaestro.Png)
2-element Vector{Symbol}:
 :glmakie
 :raster

MakieMaestro.get_export_theme(backend, format, width, hwratio, override_theme...)

Create the final export theme applied when generating the figure.

Examples

julia> MakieMaestro.get_export_theme(CairoMakie, MakieMaestro.Png, 10u"cm", 0.8,
           Theme(;
               CairoMakie=(;pdf_version=1.1)
           ),
           Theme(;
               Scatter=(;markersize=8)
           )
       )
Attributes with 12 entries:
  Axis => Attributes with 8 entries:
    xgridvisible => false
    xticklabelsize => 10
    xticksize => 4
    xtickwidth => 0.7
    ygridvisible => false
    yticklabelsize => 10
    yticksize => 4
    ytickwidth => 0.7
  backgroundcolor => transparent
  CairoMakie => Attributes with 1 entry:
    pdf_version => 1.1
  Colorbar => Attributes with 9 entries:
    bottomspinevisible => false
    labelsize => 10
    leftspinevisible => false
    rightspinevisible => false
    ticklabelsize => 10
    ticksize => 4
    tickwidth => 0.7
    topspinevisible => false
    width => 5
  figure_padding => 2
  fonts => Attributes with 4 entries:
    bold => FTFont (family = NewComputerModern, style = 10 Bold)
    bolditalic => FTFont (family = NewComputerModern, style = 10 Bold Italic)
    italic => FTFont (family = NewComputerModern, style = 10 Italic)
    regular => FTFont (family = NewComputerModern Math, style = Regular)
  Heatmap => Attributes with 1 entry:
    colormap => Spectral
  Image => Attributes with 1 entry:
    interpolate => false
  Legend => Attributes with 5 entries:
    framevisible => false
    labelsize => 10
    nbanks => 1
    tellheight => false
    tellwidth => false
  Lines => Attributes with 1 entry:
    cycle => Cycle([[:color]=>:color, [:marker]=>:marker], true)
  Scatter => Attributes with 3 entries:
    cycle => Cycle([[:color]=>:color, [:marker]=>:marker], true)
    markersize => 8
    strokewidth => 0
  size => (283, 226)

MakieMaestro.get_formats(backends::Vector{Module}, formats::Set{Format})

Return the list (Vector) of formats to generate based on the given backends required formats. Output is in the correct order for export.

Examples

julia> (Sys.which("inkscape") === nothing) || MakieMaestro.Svg ∈ MakieMaestro.get_formats([CairoMakie], Set([MakieMaestro.PdfTex])) # Added Svg so the PdfTex is possible to create
true

julia> MakieMaestro.get_formats([GLMakie], Set([MakieMaestro.Pdf]))
ERROR: ArgumentError: None of the backends Module[GLMakie] support the formats Set(MakieMaestro.Format[MakieMaestro.Pdf])
[...]

julia> MakieMaestro.get_formats([CairoMakie, GLMakie], Set([MakieMaestro.Png, MakieMaestro.Svg]))
2-element Vector{MakieMaestro.Format}:
 Svg::Format = 1
 Png::Format = 0

FunctionSpec(fig, args)

Specification of the function generating the figure with its arguments.

Can be called with additional keyword arguments. The arguments are passed from the args field.

PathSpec(basename, [formats], [dirname])
PathSpec(fullpath, [formats])

Specification of where and which format to use for exporting a figure.

• basename is internally a function that takes an index integer and returns the name of the figure. The function is created either by a suffix or by parsing the supplied string (see examples below).
• formats is a set or collection of formats wanted for the export.
• dirname is the directory where the figure will be saved (checked for existence upon creation).

Examples

```jldoctest; setup=:(using MakieMaestro: PathSpec) julia> PathSpec("somefile.pdf", ".") ./somefile.pdf

julia> PathSpec("somefile.{svg,eps}", "..") ../somefile.{eps,svg}

julia> PathSpec("somefile.png", "nonexistentdir") ERROR: ArgumentError: `nonexistent_dir` is not a valid directory [...]

julia> PathSpec("somefile",["pdf", :svg], "..") ../somefile.{pdf,svg}```

MakieMaestro.get_export_format()

Get the default export formats

Examples

julia> export_format!(:pdf)
Set{MakieMaestro.Format} with 1 element:
  MakieMaestro.Pdf

julia> MakieMaestro.get_export_format()
Set{MakieMaestro.Format} with 1 element:
  MakieMaestro.Pdf

julia> export_format!(missing);

MakieMaestro.SizeSpec(width::Length, hwratio::Real)

Specification of the physical size of the exported image.

The primary way to represent the size of a figure is it's width and the height to width ratio hwratio. However, any set of two values from {width, hwratio, height} fully determine the size. width and height may be either fixed values of the type Length or relative sizes to their default values by the type Real (RelativeSize). None, one or two of the values may be supplied and the size is determined from these values and the defaults. These defaults may be set with width! and hwratio!.

See also Themes.width!, Themes.get_width, Themes.hwratio!, Themes.get_hwratio

Examples

julia> Themes.width!(Themes.A4_WIDTH), Themes.hwratio!(2/(√(5) + 1));

julia> SizeSpec(0.5, 2)
w×h: 105.0 mm × 210.0 mm [h/w: 2.0]

julia> SizeSpec(10u"cm")
w×h: 10.0 cm × 6.18 cm [h/w: 2/(√5 + 1)]

julia> SizeSpec((15u"cm", 10u"cm"))
w×h: 10.0 cm × 15.0 cm [h/w: 1.5]

julia> SizeSpec((15u"cm", 0.5))
w×h: 105.0 mm × 150.0 mm [h/w: 1.4]

julia> SizeSpec((2, 10u"cm"))
w×h: 10.0 cm × 12.36 cm [h/w: 1.2]

MakieMaestro.RelativeSize(ratio::Real)

Size relative to the default or calculated dimensions.

FigHeight(height::Length)
FigHeight(height::Real) # relative size to the default

Specifies the height of the exported figure.

See also RelativeSize.

_savefig(fig, name, format, backend, dir; update)

Save figure fig with backend and name in dir with format.

Internal function that gets called at the end of the saving stack with all of the arguments already fully determined and the figure created with the theme activated. update should be true if the Axis is created separately from the plot inside in order to set the correct viewing limits for the figure.

_savepdftex(svgpath, outputpath; wait=true)

Run the command for creating a PDFTEX figure using Inkscape.

Internal function to convert SVG figures to PDFTEX (PDF+LaTeX) format assuming that the SVG already exists. If wait then the command in ran as blocking.

ThemeGenerator == Union{Function,Theme}

A struct used for defining new theme “mixins” that can be inferred from some latent parameters.

julia> (() -> nothing) isa MakieMaestro.Themes.ThemeGenerator
true

gen(s::Symbol; dict=THEME[])

Return the function from the key s of dict.

merge_generate(theme::ThemeGenerator,...)::Theme

Generate and merge all the theme arguments.

Later input arguments have precedence similarly as in a merge of dictionaries.

See also get_theme, ThemeGenerator

Examples

julia> MakieMaestro.Themes.merge_generate(Theme(; figure_padding=3), () -> Theme(; figure_padding=6))
Attributes with 1 entry:
  figure_padding => 6

Themes.get_hwratio()

Get the set height-width ratio for saving figures.

Examples

julia> hwratio!(0.5)
0.5

julia> Themes.get_hwratio()
0.5

Themes.get_width()

Get the default figure width

Examples

julia> width!(10u"cm")
10 cm

julia> Themes.get_width()
10 cm

Themes.to_units(val::Length)

Convert val to Makie figure units

Example

julia> Themes.to_units(2u"cm")
7200//127

figsize(width::Length=get_width(), hw_ratio=get_hwratio())

Calculate the figure size in points (1u"pt" == (1//72)u"inch") based on the given width and height-to-width ratio.

Examples

julia> w,h = Themes.figsize(32u"cm", (1 + √(5))/2)
(907, 1467)

MakieMaestro.Themes.ScreenInfo

Fields

• default::Union{Missing,Bool} – X11 default screen
• index::Int – X11 screen index
• size::Tuple{Int,Int} – pixel dimensions of the display
• dimensions::Tuple{Length,Length} – physical dimensions of the display

interactive_size!(size::Tuple{Length,Length})
interactive_size!(ratio::Tuple{Number,Number}; index=nothing)

Set the interactive figure size.

If given a ratio, calculate the size from the screen parameters so that the figure takes up the given width/height ratio of the screen. The optional index specifies the screen to use.

See also screen_parameters, get_interactive_size

get_interactive_size()

Retrieve the current interactive size setting for figures.

This function checks the global INTERACTIVE_SIZE variable and returns its value. If INTERACTIVE_SIZE is not set (i.e., it's missing), it attempts to set a default size of 80% of the screen dimensions using interactive_size!((0.8, 0.8)).

See also interactive_size!

Throws

• ErrorException: If INTERACTIVE_SIZE is not set and the function fails to set a default value.

screen_parameters()

Retrieve information about available screens (Vector{ScreenInfo}) using the xdpyinfo command.

This function parses the output of xdpyinfo to extract details about each screen, including its index, dimensions in pixels and millimeters, and whether it's the default screen.

Examples

screens = screen_parameters()
for screen in screens
    println("Screen $(screen.index): $(screen.size) pixels, $(screen.dimensions) physical size")
end
# Screen 0: (4080, 1920) pixels, (1072 mm, 504 mm) physical size

See also ScreenInfo

Extended help

• This function relies on the xdpyinfo command and is therefore only compatible with systems where this command is available (typically Unix-like systems with X11).
• The function may return an empty vector if no screens are detected or if parsing fails.
• Requires the Unitful.jl package for handling millimeter units.