View Source Tucan.Export (tucan v0.4.1)

Various export methods for Tucan plots.

This is a simple wrapper around the VegaLite.Export API. It provides helper utilities for exporting a tucan plot as json, html, png, svg or pdf.

External dependencies
All of the export functions depend on the :jason package. Additionally PNG, SVG and PDF exports rely on npm packages, so you will need Node.js, npm, and the following dependencies installed:
npm install -g vega vega-lite canvas
For more details check VegaLite.Export.

Summary

Functions

save!(vl, path, opts \\ [])

Saves a Tucan specification in one of the supported formats.

to_html(vl)

Builds an HTML page that renders the given graphic.

to_json(vl)

Returns the underlying Vega-Lite specification as JSON.

to_pdf(vl, opts \\ [])

Renders the given graphic into a PDF and returns its binary content.

to_png(vl, opts \\ [])

Renders the given graphic as a PNG image and returns its binary content.

to_svg(vl, opts \\ [])

Renders the given graphic as an SVG image and returns its binary content.

Functions

save!(vl, path, opts \\ [])

@spec save!(vl :: VegaLite.t(), path :: String.t(), opts :: keyword()) :: :ok

Saves a Tucan specification in one of the supported formats.

Options

:format - the format to export the graphic as, must be either of: :json, :html, :png, :svg, :pdf. By default the format is inferred from the file extension.
:local_npm_prefix - a relative path pointing to a local npm project directory where the necessary npm packages are installed.

Examples

Tucan.scatter(:iris, "petal_width", "petal_length")
|> Tucan.Export.save!("iris.png")

to_html(vl)

@spec to_html(vl :: VegaLite.t()) :: String.t()

Builds an HTML page that renders the given graphic.

to_json(vl)

@spec to_json(vl :: VegaLite.t()) :: String.t()

Returns the underlying Vega-Lite specification as JSON.

to_pdf(vl, opts \\ [])

@spec to_pdf(vl :: VegaLite.t(), opts :: keyword()) :: binary()

Renders the given graphic into a PDF and returns its binary content.

Relies on the npm packages mentioned above.

Options

:local_npm_prefix - a relative path pointing to a local npm project directory where the necessary npm packages are installed.

to_png(vl, opts \\ [])

@spec to_png(vl :: VegaLite.t(), opts :: keyword()) :: binary()

Renders the given graphic as a PNG image and returns its binary content.

Relies on the npm packages mentioned above.

Options

:local_npm_prefix - a relative path pointing to a local npm project directory where the necessary npm packages are installed.

to_svg(vl, opts \\ [])

@spec to_svg(vl :: VegaLite.t(), opts :: keyword()) :: binary()

Renders the given graphic as an SVG image and returns its binary content.

Relies on the npm packages mentioned above.

Options

:local_npm_prefix - a relative path pointing to a local npm project directory where the necessary npm packages are installed.