@spec html(Visualize.Board.Snapshot.t(), keyword()) :: String.t()

The printed pages in one HTML document (spec/15 §12.4): an @page rule of the paper's size and no margin, and each page of pages/2 filling one sheet. A browser prints it as a multi-page PDF. The options are pages/2's.

@spec literal(String.t()) :: String.t()

An SVG with every CSS custom-property reference replaced by the fallback it carries (spec/15 §12.1): var(--vis-axis, #666666) becomes #666666. A theme writes each slot's literal as the fallback of its reference (spec/08 §7.3), so this is the document in :literal mode, for a reader that knows no custom property — resvg among them. A reference with no fallback is left as it is.

iex> Visualize.Board.Export.literal(~s[<rect fill="var(--vis-good, rgb(1, 2, 3))"/>])
~s[<rect fill="rgb(1, 2, 3)"/>]

@spec pages(Visualize.Board.Snapshot.t(), keyword()) :: [String.t()]

The board printed (spec/15 §12.4): one SVG document per page of paginate/2, each the page's size in its own unit (210mm by 297mm for A4 portrait), with the header — the board's name, and its window and the page's number — and the page's cells drawn as svg/2 draws them, a band scaled down where paginate/2 scaled it. The cells are drawn at the page's width in :theme, the print theme by default, from the snapshot's data.

The options are paginate/2's, svg/2's :system, :generators, :assigns, :title and :resolve.

@spec paginate(Visualize.Board.t(), keyword()) :: %{
  size: {number(), number()},
  width: number(),
  pages: [%{required(atom()) => box()}]
}

The board laid out on paper (spec/15 §12.4), purely: %{size: {w, h}, width: width, pages: [%{name => box}, …]}, the page's size in pixels, the width the cells are drawn at, and each page's cells at their boxes on that page.

The board is arranged at the page's width less its margins, so a page narrower than the board's breakpoint stacks the cells as a phone does (spec/15 §1.6). Cells are taken in bands: a band is the cells whose rows overlap, joined until no cell of the band shares a row with one outside it, so a band is the least that can be moved without cutting a cell. Bands are placed down the page, a gap apart, and a band that does not fit below the last starts the next page. A band taller than a whole page is scaled down to fit one, its width with it, and centered. No cell is ever split, and every box is inside the page's margins, below the header.

Options

• :paper - :a4 (default) or :letter
• :orientation - :portrait (default) or :landscape
• :margin - the page's margin in pixels (default 48, half an inch)
• :theme - the theme whose sizes set the header's height (default Visualize.Theme.print/0)

@spec png(Visualize.Board.Snapshot.t(), keyword()) ::
  {:ok, binary(), [Visualize.Render.png_warning()]}
  | {:error, Visualize.Render.png_error()}

The board as a PNG (spec/15 §12.1): svg/2 with resolve: :literal, rasterized by Visualize.Render.to_png/2. {:ok, png, warnings} or {:error, reason}, as to_png/2 answers. The options are svg/2's, :generators and :assigns among them, and to_png/2's :scale, :background, :timeout and font options.

@spec svg(Visualize.Board.Snapshot.t(), keyword()) :: String.t()

The board as one SVG document (spec/15 §12.1).

The document is the grid's width and twice the board's gap wider, a gap of margin each side; the header, when there is a name or a window, stands above the grid. Each cell is a group data-vis-cell at its box, translated by the margin and the header, holding its title, its banner, and its chart or its state's panel, each in its own viewport so the cell's own SVG is placed unchanged.

Options

• :width - the grid's width, the container width the cells are drawn at (default the snapshot's)
• :theme - the theme the cells and the page are drawn in (default the snapshot's)
• :system - the unit system the cells' measures are shown in (default :as_posted, spec/14 §4.4, D-156)
• :generators, :assigns - the generator modules the cells' frames call and the host's assigns, as Visualize.Board.Snapshot.views/2 takes them (default none and %{}): the board's own, so the export draws what the board draws for its viewer (D-181). Visualize.Board.Server.export/3 passes a running board's
• :id - the board's id, each cell's chart root <id>-<cell>-chart, as Visualize.Board.Snapshot.views/2 takes it (D-188); Visualize.Board.Server.export/3 passes a running board's
• :title - the header's name (default the board's meta.name)
• :resolve - :css (default), every theme value a custom-property reference with its literal as fallback, as the cells draw it; or :literal, each reference replaced by its literal, for a reader of no CSS (literal/1)