Files
shiny/reference/absolutePanel.html
2023-07-03 12:53:12 +00:00

191 lines
11 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>Panel with absolute positioning — absolutePanel • 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="Panel with absolute positioning — absolutePanel"><meta property="og:description" content="Creates a panel whose contents are absolutely positioned."><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.7.4.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>Panel with absolute positioning</h1>
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/HEAD/R/jqueryui.R" class="external-link"><code>R/jqueryui.R</code></a></small>
<div class="hidden name"><code>absolutePanel.Rd</code></div>
</div>
<div class="ref-description">
<p>Creates a panel whose contents are absolutely positioned.</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">absolutePanel</span><span class="op">(</span></span>
<span> <span class="va">...</span>,</span>
<span> top <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> left <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> right <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> bottom <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> width <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> height <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> draggable <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> fixed <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> cursor <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">"auto"</span>, <span class="st">"move"</span>, <span class="st">"default"</span>, <span class="st">"inherit"</span><span class="op">)</span></span>
<span><span class="op">)</span></span>
<span></span>
<span><span class="fu">fixedPanel</span><span class="op">(</span></span>
<span> <span class="va">...</span>,</span>
<span> top <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> left <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> right <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> bottom <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> width <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> height <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> draggable <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> cursor <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">"auto"</span>, <span class="st">"move"</span>, <span class="st">"default"</span>, <span class="st">"inherit"</span><span class="op">)</span></span>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>...</dt>
<dd><p>Attributes (named arguments) or children (unnamed arguments) that
should be included in the panel.</p></dd>
<dt>top</dt>
<dd><p>Distance between the top of the panel, and the top of the page or
parent container.</p></dd>
<dt>left</dt>
<dd><p>Distance between the left side of the panel, and the left of the
page or parent container.</p></dd>
<dt>right</dt>
<dd><p>Distance between the right side of the panel, and the right of
the page or parent container.</p></dd>
<dt>bottom</dt>
<dd><p>Distance between the bottom of the panel, and the bottom of the
page or parent container.</p></dd>
<dt>width</dt>
<dd><p>Width of the panel.</p></dd>
<dt>height</dt>
<dd><p>Height of the panel.</p></dd>
<dt>draggable</dt>
<dd><p>If <code>TRUE</code>, allows the user to move the panel by
clicking and dragging.</p></dd>
<dt>fixed</dt>
<dd><p>Positions the panel relative to the browser window and prevents
it from being scrolled with the rest of the page.</p></dd>
<dt>cursor</dt>
<dd><p>The type of cursor that should appear when the user mouses over
the panel. Use <code>"move"</code> for a north-east-south-west icon,
<code>"default"</code> for the usual cursor arrow, or <code>"inherit"</code> for the
usual cursor behavior (including changing to an I-beam when the cursor is
over text). The default is <code>"auto"</code>, which is equivalent to
<code>ifelse(draggable, "move", "inherit")</code>.</p></dd>
</dl></div>
<div id="value">
<h2>Value</h2>
<p>An HTML element or list of elements.</p>
</div>
<div id="details">
<h2>Details</h2>
<p>The <code>absolutePanel</code> function creates a <code>&lt;div&gt;</code> tag whose CSS
position is set to <code>absolute</code> (or fixed if <code>fixed = TRUE</code>). The way
absolute positioning works in HTML is that absolute coordinates are specified
relative to its nearest parent element whose position is not set to
<code>static</code> (which is the default), and if no such parent is found, then
relative to the page borders. If you're not sure what that means, just keep
in mind that you may get strange results if you use <code>absolutePanel</code> from
inside of certain types of panels.</p>
<p>The <code>fixedPanel</code> function is the same as <code>absolutePanel</code> with
<code>fixed = TRUE</code>.</p>
<p>The position (<code>top</code>, <code>left</code>, <code>right</code>, <code>bottom</code>) and size
(<code>width</code>, <code>height</code>) parameters are all optional, but you should
specify exactly two of <code>top</code>, <code>bottom</code>, and <code>height</code> and
exactly two of <code>left</code>, <code>right</code>, and <code>width</code> for predictable
results.</p>
<p>Like most other distance parameters in Shiny, the position and size
parameters take a number (interpreted as pixels) or a valid CSS size string,
such as <code>"100px"</code> (100 pixels) or <code>"25%"</code>.</p>
<p>For arcane HTML reasons, to have the panel fill the page or parent you should
specify <code>0</code> for <code>top</code>, <code>left</code>, <code>right</code>, and <code>bottom</code>
rather than the more obvious <code>width = "100%"</code> and <code>height = "100%"</code>.</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, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, Barbara Borges.</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>