Skip to content

Commit

Permalink
Update Tucan.Export docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pnezis committed Nov 18, 2024
1 parent be8e48f commit 2d65004
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions lib/tucan/export.ex
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ defmodule Tucan.Export do
Various export methods for `Tucan` plots.
This is a simple wrapper around the `VegaLite.Convert` API. It provides helper
utilities for exporting a tucan plot as `json`, `html`, `png`, `svg` or `pdf`.
utilities for exporting a tucan plot as `json`, `html`, `png`, `svg`, `jpeg`
or `pdf`.
> #### External dependencies {: .info}
>
> All of the export functions depend on the `vega_lite_convert` package.
> In order to use these functions you need to add the package in your
> dependencies:
>
> ```bash
> ```elixir
> def deps do
> [
> {:vega_lite_convert, "~> 1.0.0"}
Expand All @@ -26,7 +27,7 @@ defmodule Tucan.Export do
## Options
* `:format` - the format to export the graphic as,
must be either of: `:json`, `:html`, `:png`, `:svg`, `:pdf`.
must be either of: `:json`, `:html`, `:png`, `:svg`, `:pdf`, `:jpeg`.
By default the format is inferred from the file extension.
## Examples
Expand Down Expand Up @@ -132,7 +133,6 @@ defmodule Tucan.Export do
where the necessary npm packages are installed.
See also `VegaLite.Convert.to_svg/1`
"""
@spec to_svg(vl :: VegaLite.t()) :: binary()
def to_svg(vl) do
Expand Down

0 comments on commit 2d65004

Please sign in to comment.