mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
161 lines
9.9 KiB
HTML
161 lines
9.9 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>Create an object representing brushing options — brushOpts • shiny</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></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="Create an object representing brushing options — brushOpts"><meta property="og:description" content="This generates an object representing brushing options, to be passed as the
|
|
brush argument of imageOutput() or
|
|
plotOutput()."><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.8.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>Create an object representing brushing options</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/HEAD/R/image-interact-opts.R" class="external-link"><code>R/image-interact-opts.R</code></a></small>
|
|
<div class="hidden name"><code>brushOpts.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>This generates an object representing brushing options, to be passed as the
|
|
<code>brush</code> argument of <code><a href="plotOutput.html">imageOutput()</a></code> or
|
|
<code><a href="plotOutput.html">plotOutput()</a></code>.</p>
|
|
</div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">brushOpts</span><span class="op">(</span></span>
|
|
<span> <span class="va">id</span>,</span>
|
|
<span> fill <span class="op">=</span> <span class="st">"#9cf"</span>,</span>
|
|
<span> stroke <span class="op">=</span> <span class="st">"#036"</span>,</span>
|
|
<span> opacity <span class="op">=</span> <span class="fl">0.25</span>,</span>
|
|
<span> delay <span class="op">=</span> <span class="fl">300</span>,</span>
|
|
<span> delayType <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"debounce"</span>, <span class="st">"throttle"</span><span class="op">)</span>,</span>
|
|
<span> clip <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> direction <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"xy"</span>, <span class="st">"x"</span>, <span class="st">"y"</span><span class="op">)</span>,</span>
|
|
<span> resetOnNew <span class="op">=</span> <span class="cn">FALSE</span></span>
|
|
<span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div id="arguments">
|
|
<h2>Arguments</h2>
|
|
<dl><dt>id</dt>
|
|
<dd><p>Input value name. For example, if the value is <code>"plot_brush"</code>,
|
|
then the coordinates will be available as <code>input$plot_brush</code>. Multiple
|
|
<code>imageOutput</code>/<code>plotOutput</code> calls may share the same <code>id</code>
|
|
value; brushing one image or plot will cause any other brushes with the
|
|
same <code>id</code> to disappear.</p></dd>
|
|
|
|
|
|
<dt>fill</dt>
|
|
<dd><p>Fill color of the brush. If <code>'auto'</code>, it derives from the link
|
|
color of the plot's HTML container (if <strong>thematic</strong> is enabled, and <code>accent</code>
|
|
is a non-<code>'auto'</code> value, that color is used instead).</p></dd>
|
|
|
|
|
|
<dt>stroke</dt>
|
|
<dd><p>Outline color of the brush. If <code>'auto'</code>, it derives from the
|
|
foreground color of the plot's HTML container (if <strong>thematic</strong> is enabled,
|
|
and <code>fg</code> is a non-<code>'auto'</code> value, that color is used instead).</p></dd>
|
|
|
|
|
|
<dt>opacity</dt>
|
|
<dd><p>Opacity of the brush</p></dd>
|
|
|
|
|
|
<dt>delay</dt>
|
|
<dd><p>How long to delay (in milliseconds) when debouncing or
|
|
throttling, before sending the brush data to the server.</p></dd>
|
|
|
|
|
|
<dt>delayType</dt>
|
|
<dd><p>The type of algorithm for limiting the number of brush
|
|
events. Use <code>"throttle"</code> to limit the number of brush events to one
|
|
every <code>delay</code> milliseconds. Use <code>"debounce"</code> to suspend events
|
|
while the cursor is moving, and wait until the cursor has been at rest for
|
|
<code>delay</code> milliseconds before sending an event.</p></dd>
|
|
|
|
|
|
<dt>clip</dt>
|
|
<dd><p>Should the brush area be clipped to the plotting area? If FALSE,
|
|
then the user will be able to brush outside the plotting area, as long as
|
|
it is still inside the image.</p></dd>
|
|
|
|
|
|
<dt>direction</dt>
|
|
<dd><p>The direction for brushing. If <code>"xy"</code>, the brush can be
|
|
drawn and moved in both x and y directions. If <code>"x"</code>, or <code>"y"</code>,
|
|
the brush wil work horizontally or vertically.</p></dd>
|
|
|
|
|
|
<dt>resetOnNew</dt>
|
|
<dd><p>When a new image is sent to the browser (via
|
|
<code><a href="renderImage.html">renderImage()</a></code>), should the brush be reset? The default,
|
|
<code>FALSE</code>, is useful if you want to update the plot while keeping the
|
|
brush. Using <code>TRUE</code> is useful if you want to clear the brush whenever
|
|
the plot is updated.</p></dd>
|
|
|
|
</dl></div>
|
|
<div id="see-also">
|
|
<h2>See also</h2>
|
|
<div class="dont-index"><p><code><a href="clickOpts.html">clickOpts()</a></code> for clicking events.</p></div>
|
|
</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, 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.0.7.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|