mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-10 15:38:19 -05:00
192 lines
14 KiB
HTML
192 lines
14 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>Table output with the JavaScript DataTables library — dataTableOutput • 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="Table output with the JavaScript DataTables library — dataTableOutput"><meta property="og:description" content="
|
|
This function is deprecated, use
|
|
DT::renderDT() instead. It
|
|
provides a superset of functionality, better performance, and better user
|
|
experience."><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.0.9000</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>Table output with the JavaScript DataTables library</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/rc-v1.12.1/R/bootstrap.R" class="external-link"><code>R/bootstrap.R</code></a>, <a href="https://github.com/rstudio/shiny/blob/rc-v1.12.1/R/shinywrappers.R" class="external-link"><code>R/shinywrappers.R</code></a></small>
|
|
<div class="hidden name"><code>renderDataTable.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p><a href="https://lifecycle.r-lib.org/articles/stages.html#deprecated" class="external-link"><img src="figures/lifecycle-deprecated.svg" alt="[Deprecated]"></a></p>
|
|
<p>This function is deprecated, use
|
|
<a href="https://rstudio.github.io/DT/shiny.html" class="external-link">DT::renderDT()</a> instead. It
|
|
provides a superset of functionality, better performance, and better user
|
|
experience.</p>
|
|
</div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">dataTableOutput</span><span class="op">(</span><span class="va">outputId</span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">renderDataTable</span><span class="op">(</span></span>
|
|
<span> <span class="va">expr</span>,</span>
|
|
<span> options <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> searchDelay <span class="op">=</span> <span class="fl">500</span>,</span>
|
|
<span> callback <span class="op">=</span> <span class="st">"function(oTable) {}"</span>,</span>
|
|
<span> escape <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> env <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sys.parent.html" class="external-link">parent.frame</a></span><span class="op">(</span><span class="op">)</span>,</span>
|
|
<span> quoted <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
<span> outputArgs <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span></span>
|
|
<span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div id="arguments">
|
|
<h2>Arguments</h2>
|
|
|
|
|
|
<dl><dt id="arg-outputid">outputId<a class="anchor" aria-label="anchor" href="#arg-outputid"></a></dt>
|
|
<dd><p>output variable to read the table from</p></dd>
|
|
|
|
|
|
<dt id="arg-expr">expr<a class="anchor" aria-label="anchor" href="#arg-expr"></a></dt>
|
|
<dd><p>An expression that returns a data frame or a matrix.</p></dd>
|
|
|
|
|
|
<dt id="arg-options">options<a class="anchor" aria-label="anchor" href="#arg-options"></a></dt>
|
|
<dd><p>A list of initialization options to be passed to DataTables,
|
|
or a function to return such a list. You can find a complete list of
|
|
options at <a href="https://datatables.net/reference/option/" class="external-link">https://datatables.net/reference/option/</a>.</p>
|
|
<p>Any top-level strings with class <code>"AsIs"</code> (as created by <code><a href="https://rdrr.io/r/base/AsIs.html" class="external-link">I()</a></code>) will be
|
|
evaluated in JavaScript. This is useful when the type of the option value
|
|
is not supported in JSON, e.g., a JavaScript function, which can be
|
|
obtained by evaluating a character string. This only applies to the
|
|
root-level elements of options list, and does not worked for lower-level
|
|
elements in the list.</p></dd>
|
|
|
|
|
|
<dt id="arg-searchdelay">searchDelay<a class="anchor" aria-label="anchor" href="#arg-searchdelay"></a></dt>
|
|
<dd><p>The delay for searching, in milliseconds (to avoid too
|
|
frequent search requests).</p></dd>
|
|
|
|
|
|
<dt id="arg-callback">callback<a class="anchor" aria-label="anchor" href="#arg-callback"></a></dt>
|
|
<dd><p>A JavaScript function to be applied to the DataTable object.
|
|
This is useful for DataTables plug-ins, which often require the DataTable
|
|
instance to be available.</p></dd>
|
|
|
|
|
|
<dt id="arg-escape">escape<a class="anchor" aria-label="anchor" href="#arg-escape"></a></dt>
|
|
<dd><p>Whether to escape HTML entities in the table: <code>TRUE</code> means
|
|
to escape the whole table, and <code>FALSE</code> means not to escape it.
|
|
Alternatively, you can specify numeric column indices or column names to
|
|
indicate which columns to escape, e.g. <code>1:5</code> (the first 5 columns),
|
|
<code>c(1, 3, 4)</code>, or <code>c(-1, -3)</code> (all columns except the first and
|
|
third), or <code>c('Species', 'Sepal.Length')</code>.</p></dd>
|
|
|
|
|
|
<dt id="arg-env">env<a class="anchor" aria-label="anchor" href="#arg-env"></a></dt>
|
|
<dd><p>The parent environment for the reactive expression. By default,
|
|
this is the calling environment, the same as when defining an ordinary
|
|
non-reactive expression. If <code>expr</code> is a quosure and <code>quoted</code> is <code>TRUE</code>,
|
|
then <code>env</code> is ignored.</p></dd>
|
|
|
|
|
|
<dt id="arg-quoted">quoted<a class="anchor" aria-label="anchor" href="#arg-quoted"></a></dt>
|
|
<dd><p>If it is <code>TRUE</code>, then the <code><a href="https://rdrr.io/r/base/substitute.html" class="external-link">quote()</a></code>ed value of <code>expr</code>
|
|
will be used when <code>expr</code> is evaluated. If <code>expr</code> is a quosure and you
|
|
would like to use its expression as a value for <code>expr</code>, then you must set
|
|
<code>quoted</code> to <code>TRUE</code>.</p></dd>
|
|
|
|
|
|
<dt id="arg-outputargs">outputArgs<a class="anchor" aria-label="anchor" href="#arg-outputargs"></a></dt>
|
|
<dd><p>A list of arguments to be passed through to the implicit
|
|
call to <code>dataTableOutput()</code> when <code>renderDataTable()</code> is used
|
|
in an interactive R Markdown document.</p></dd>
|
|
|
|
</dl></div>
|
|
|
|
<div id="ref-examples">
|
|
<h2>Examples</h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co">## Only run this example in interactive R sessions</span></span></span>
|
|
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/interactive.html" class="external-link">interactive</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="co"># pass a callback function to DataTables using I()</span></span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="shinyApp.html">shinyApp</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> ui <span class="op">=</span> <span class="fu"><a href="fluidPage.html">fluidPage</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="fluidPage.html">fluidRow</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="column.html">column</a></span><span class="op">(</span><span class="fl">12</span>,</span></span>
|
|
<span class="r-in"><span> <span class="fu">dataTableOutput</span><span class="op">(</span><span class="st">'table'</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">)</span>,</span></span>
|
|
<span class="r-in"><span> server <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">input</span>, <span class="va">output</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="va">output</span><span class="op">$</span><span class="va">table</span> <span class="op"><-</span> <span class="fu">renderDataTable</span><span class="op">(</span><span class="va">iris</span>,</span></span>
|
|
<span class="r-in"><span> options <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> pageLength <span class="op">=</span> <span class="fl">5</span>,</span></span>
|
|
<span class="r-in"><span> initComplete <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/AsIs.html" class="external-link">I</a></span><span class="op">(</span><span class="st">"function(settings, json) {alert('Done.');}"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">}</span></span></span>
|
|
<span class="r-in"><span> <span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="op">}</span></span></span>
|
|
</code></pre></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, 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>
|
|
|