VegaLite
v0.1.9

View Source VegaLite.Export (VegaLite v0.1.9)

Various export methods for a VegaLite specification.

All of the export functions depend on the :jason package. Additionally the PNG, SVG and PDF exports rely on npm packages, so you will need Node.js, npm, and the following dependencies:

$ npm install -g vega vega-lite canvas

Alternatively you can install the dependencies in a local directory:

$ npm install vega vega-lite canvas

Summary

Functions

run_cmd(script_path, args)
save!(vl, path, opts \\ [])

Saves a VegaLite specification to file 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

Link to this function

run_cmd(script_path, args)

View Source
Link to this function

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

View Source 
@spec save!(VegaLite.t(), binary(), keyword()) :: :ok

Saves a VegaLite specification to file 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. For instance, in Phoenix projects you may want to pass local_npm_prefix: "assets". By default the npm packages are searched for in the current directory and globally.

Link to this function

to_html(vl)

View Source 
@spec to_html(VegaLite.t()) :: binary()

Builds an HTML page that renders the given graphic.

The HTML page loads necessary JavaScript dependencies from a CDN and then renders the graphic in a root element.

Link to this function

to_json(vl)

View Source 
@spec to_json(VegaLite.t()) :: String.t()

Returns the underlying Vega-Lite specification as JSON.

Link to this function

to_pdf(vl, opts \\ [])

View Source 
@spec to_pdf(
  VegaLite.t(),
  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. For instance, in Phoenix projects you may want to pass local_npm_prefix: "assets". By default the npm packages are searched for in the current directory and globally.
Link to this function

to_png(vl, opts \\ [])

View Source 
@spec to_png(
  VegaLite.t(),
  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. For instance, in Phoenix projects you may want to pass local_npm_prefix: "assets". By default the npm packages are searched for in the current directory and globally.
Link to this function

to_svg(vl, opts \\ [])

View Source 
@spec to_svg(
  VegaLite.t(),
  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. For instance, in Phoenix projects you may want to pass local_npm_prefix: "assets". By default the npm packages are searched for in the current directory and globally.