mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-10 15:38:19 -05:00
149 lines
9.0 KiB
HTML
149 lines
9.0 KiB
HTML
<!DOCTYPE html>
|
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Capture a plot as a PNG file. — plotPNG • shiny</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js" integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin="anonymous" referrerpolicy="no-referrer"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Capture a plot as a PNG file. — plotPNG"><meta property="og:description" content='The PNG graphics device used is determined in the following order:
|
|
If the ragg package is installed (and the shiny.useragg is not
|
|
set to FALSE), then use ragg::agg_png().
|
|
If a quartz device is available (i.e., capabilities("aqua") is
|
|
TRUE), then use png(type = "quartz").
|
|
If the Cairo package is installed (and the shiny.usecairo option
|
|
is not set to FALSE), then use Cairo::CairoPNG().
|
|
Otherwise, use grDevices::png(). In this case, Linux and Windows
|
|
may not antialias some point shapes, resulting in poor quality output.
|
|
|
|
'><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]--></head><body data-spy="scroll" data-target="#toc">
|
|
|
|
|
|
<div class="container template-reference-topic">
|
|
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">shiny</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">1.12.1</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav"><li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul><ul class="nav navbar-nav navbar-right"><li>
|
|
<a href="https://github.com/rstudio/shiny/" class="external-link">
|
|
<span class="fab fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul></div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
|
|
</header><div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>Capture a plot as a PNG file.</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/rc-v1.12.1/R/imageutils.R" class="external-link"><code>R/imageutils.R</code></a></small>
|
|
<div class="hidden name"><code>plotPNG.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>The PNG graphics device used is determined in the following order:</p><ul><li><p>If the ragg package is installed (and the <code>shiny.useragg</code> is not
|
|
set to <code>FALSE</code>), then use <code><a href="https://ragg.r-lib.org/reference/agg_png.html" class="external-link">ragg::agg_png()</a></code>.</p></li>
|
|
<li><p>If a quartz device is available (i.e., <code>capabilities("aqua")</code> is
|
|
<code>TRUE</code>), then use <code>png(type = "quartz")</code>.</p></li>
|
|
<li><p>If the Cairo package is installed (and the <code>shiny.usecairo</code> option
|
|
is not set to <code>FALSE</code>), then use <code><a href="https://rdrr.io/pkg/Cairo/man/Cairo.html" class="external-link">Cairo::CairoPNG()</a></code>.</p></li>
|
|
<li><p>Otherwise, use <code><a href="https://rdrr.io/r/grDevices/png.html" class="external-link">grDevices::png()</a></code>. In this case, Linux and Windows
|
|
may not antialias some point shapes, resulting in poor quality output.</p></li>
|
|
</ul></div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">plotPNG</span><span class="op">(</span></span>
|
|
<span> <span class="va">func</span>,</span>
|
|
<span> filename <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span>fileext <span class="op">=</span> <span class="st">".png"</span><span class="op">)</span>,</span>
|
|
<span> width <span class="op">=</span> <span class="fl">400</span>,</span>
|
|
<span> height <span class="op">=</span> <span class="fl">400</span>,</span>
|
|
<span> res <span class="op">=</span> <span class="fl">72</span>,</span>
|
|
<span> <span class="va">...</span></span>
|
|
<span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div id="arguments">
|
|
<h2>Arguments</h2>
|
|
|
|
|
|
<dl><dt id="arg-func">func<a class="anchor" aria-label="anchor" href="#arg-func"></a></dt>
|
|
<dd><p>A function that generates a plot.</p></dd>
|
|
|
|
|
|
<dt id="arg-filename">filename<a class="anchor" aria-label="anchor" href="#arg-filename"></a></dt>
|
|
<dd><p>The name of the output file. Defaults to a temp file with
|
|
extension <code>.png</code>.</p></dd>
|
|
|
|
|
|
<dt id="arg-width">width<a class="anchor" aria-label="anchor" href="#arg-width"></a></dt>
|
|
<dd><p>Width in pixels.</p></dd>
|
|
|
|
|
|
<dt id="arg-height">height<a class="anchor" aria-label="anchor" href="#arg-height"></a></dt>
|
|
<dd><p>Height in pixels.</p></dd>
|
|
|
|
|
|
<dt id="arg-res">res<a class="anchor" aria-label="anchor" href="#arg-res"></a></dt>
|
|
<dd><p>Resolution in pixels per inch. This value is passed to the
|
|
graphics device. Note that this affects the resolution of PNG rendering in
|
|
R; it won't change the actual ppi of the browser.</p></dd>
|
|
|
|
|
|
<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
|
|
<dd><p>Arguments to be passed through to the graphics device. These can
|
|
be used to set the width, height, background color, etc.</p></dd>
|
|
|
|
</dl></div>
|
|
<div id="value">
|
|
<h2>Value</h2>
|
|
<p>A path to the newly generated PNG file.</p>
|
|
</div>
|
|
<div id="details">
|
|
<h2>Details</h2>
|
|
<p>A <code>NULL</code> value provided to <code>width</code> or <code>height</code> is ignored (i.e., the
|
|
default <code>width</code> or <code>height</code> of the graphics device is used).</p>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
|
|
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
|
|
</nav></div>
|
|
</div>
|
|
|
|
|
|
<footer><div class="copyright">
|
|
<p></p><p>Developed by Winston Chang, Joe Cheng, JJ Allaire, Carson Sievert, Barret Schloerke, Garrick Aden-Buie, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, Barbara Borges, Posit Software, PBC.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.2.0.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|