Exports a figure to PNG, JPEG, WebP, SVG, PDF or EPS with plotly.js's own image export, using the plotly.js bundled with this package in headless Chrome (driven by the chromote package). No Python is needed.
Arguments
- ...
Unused.
- p
A
go_figure(), a figure from apx_*()function or a plotly htmlwidget (anythingas_widget()accepts).- file
Output file; the format is taken from the extension (
.png,.jpeg,.jpg,.webp,.svg,.pdfor.eps).- width, height
Image size in pixels. Default: the figure's layout width and height, or 700 x 500.
- scale
Multiplier for the image resolution (e.g. 2 for high-DPI PNGs).
Value
save_image() returns file invisibly. chrome_exporter()
returns an exporter with transform() and shutdown() functions.
Details
It uses the browser set by the CHROMOTE_CHROME environment variable, an
installed Google Chrome, another installed Chromium-based browser
(Microsoft Edge, which every Windows 10/11 machine has, Chromium or Brave,
also when installed for the current user only), or a Chrome Headless Shell
downloaded by chromote. Without any of these, an interactive session asks
whether to download Chrome Headless Shell (about 100 MB, kept for later
sessions); elsewhere, download it once with
chromote::chrome_versions_add("latest-stable", "chrome-headless-shell").
The browser is started on the first export and reused for later ones.
Large figures can take a while to draw: an export waits up to
getOption("plotly.core.export_timeout", 300) seconds.
LaTeX (see TeX()) is typeset with the MathJax bundled with the package,
so it works offline. PDF is made
by printing the SVG image to a page of the figure's size; EPS is converted
from the SVG image with the rsvg package.
Downloads
save_image() downloads nothing on its own in scripts, tests or
examples. In an interactive session that needs set-up, it asks first
(see install_chrome()). What it may download keeps its own licence (see
the package's COPYRIGHTS file): Chrome Headless Shell (from Google's
Chrome for Testing, kept in chromote's cache), on Linux the shared
libraries Chrome needs (your distribution's packages, kept in
tools::R_user_dir("plotly.core", "cache")). remove_chrome() removes
the downloads.
chrome_exporter() returns an exporter of its own, whose
transform(p, file, ...) function writes images; call its shutdown()
function when done.
Examples
if (FALSE) { # \dontrun{
fig <- px_data_iris() |> px_scatter(x = ~sepal_width, y = ~sepal_length, color = ~species)
save_image(fig, tempfile(fileext = ".png"), width = 800, height = 500, scale = 2)
save_image(fig, tempfile(fileext = ".svg"))
} # }