apexcharter/docs/reference/index.html

522 lines
16 KiB
HTML

<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<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>Function reference • apexcharter</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="../css/theme.css" rel="stylesheet">
<!-- Font -->
<link href="../css/montserrat.css" rel="stylesheet">
<style>body {font-family: 'Montserrat', sans-serif;}</style>
<!-- Particles -->
<script src="../js/particles.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<style>
html,
body {
margin: 0;
padding: 0;
}
.contents {
opacity: 1;
background-color: #FFF;
z-index: 1;
}
#sidebar {
opacity: 1;
background-color: #FFF;
z-index: 1;
}
footer {
z-index: 1;
}
#particles {
position: fixed;
display: block;
top: 0;
bottom: 0;
left: 0;
right: 0;
z-index: 0;
}
.background {
position: absolute;
display: block;
top: 0;
left: 0;
z-index: 0;
}
</style>
<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/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="Function reference" />
<!-- 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 id="body">
<div class="container template-reference-index">
<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 hidden-xs hidden-sm" style="padding: 10px 15px !important;">
<img src="https://github.com/dreamRs.png" class="hidden-xs hidden-sm" style="height: 50px;display: inline;vertical-align: middle;">
<a class="navbar-link" href="../index.html">apexcharter</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.1.3.990</span>
</span>
<span class="navbar-brand hidden-md hidden-lg">
<a class="navbar-link" href="../index.html">apexcharter</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.1.3.990</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fas fa fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../articles/apexcharter.html">Get started</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/articles/advanced-configuration.html">Advanced configuration examples</a>
</li>
<li>
<a href="../articles/labs.html">Labs: title, subtitle &amp; axis</a>
</li>
<li>
<a href="../articles/lines.html">Options &amp; styles for lines</a>
</li>
<li>
<a href="../articles/shiny-integration.html">Shiny integration</a>
</li>
<li>
<a href="../articles/sync-charts.html">Syncing charts</a>
</li>
</ul>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/dreamRs/apexcharter">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="contents col-md-9">
<div class="page-header">
<h1>Reference</h1>
</div>
<table class="ref-index">
<colgroup>
<col class="alias" />
<col class="title" />
</colgroup>
<tbody>
<tr>
<th colspan="2">
<h2 id="section-all-functions" class="hasAnchor"><a href="#section-all-functions" class="anchor"></a>All functions</h2>
<p class="section-desc"></p>
</th>
</tr>
<tr>
<td>
<p><code><a href="apex.html">apex()</a></code> </p>
</td>
<td><p>Quick ApexChart</p></td>
</tr><tr>
<td>
<p><code><a href="apexchart.html">apexchart()</a></code> </p>
</td>
<td><p>Create an apexcharts.js widget</p></td>
</tr><tr>
<td>
<p><code><a href="apexcharter-exports.html">apexcharter-exports</a></code> </p>
</td>
<td><p>apexcharter exported operators and S3 methods</p></td>
</tr><tr>
<td>
<p><code><a href="apexcharter-package.html">apexcharter-package</a></code> </p>
</td>
<td><p>An <code>htmlwidget</code> interface to the
ApexCharts javascript chart library</p></td>
</tr><tr>
<td>
<p><code><a href="apexcharter-shiny.html">apexchartOutput()</a></code> <code><a href="apexcharter-shiny.html">renderApexchart()</a></code> </p>
</td>
<td><p>Shiny bindings for apexcharter</p></td>
</tr><tr>
<td>
<p><code><a href="apexchartProxy.html">apexchartProxy()</a></code> </p>
</td>
<td><p>Proxy for <code>apexchart</code></p></td>
</tr><tr>
<td>
<p><code><a href="ax-series.html">ax_series()</a></code> <code><a href="ax-series.html">ax_series2()</a></code> </p>
</td>
<td><p>Add data to a chart</p></td>
</tr><tr>
<td>
<p><code><a href="ax_annotations.html">ax_annotations()</a></code> </p>
</td>
<td><p>Annotations properties</p></td>
</tr><tr>
<td>
<p><code><a href="ax_chart.html">ax_chart()</a></code> </p>
</td>
<td><p>Chart parameters</p></td>
</tr><tr>
<td>
<p><code><a href="ax_colors.html">ax_colors()</a></code> </p>
</td>
<td><p>Colors</p></td>
</tr><tr>
<td>
<p><code><a href="ax_dataLabels.html">ax_dataLabels()</a></code> </p>
</td>
<td><p>Labels on data</p></td>
</tr><tr>
<td>
<p><code><a href="ax_fill.html">ax_fill()</a></code> </p>
</td>
<td><p>Fill property</p></td>
</tr><tr>
<td>
<p><code><a href="ax_grid.html">ax_grid()</a></code> </p>
</td>
<td><p>Add grids on chart</p></td>
</tr><tr>
<td>
<p><code><a href="ax_labels.html">ax_labels()</a></code> <code><a href="ax_labels.html">ax_labels2()</a></code> </p>
</td>
<td><p>Alternative axis labels</p></td>
</tr><tr>
<td>
<p><code><a href="ax_labs.html">ax_labs()</a></code> </p>
</td>
<td><p>Modify axis, legend, and chart labels</p></td>
</tr><tr>
<td>
<p><code><a href="ax_legend.html">ax_legend()</a></code> </p>
</td>
<td><p>Legend properties</p></td>
</tr><tr>
<td>
<p><code><a href="ax_markers.html">ax_markers()</a></code> </p>
</td>
<td><p>Markers properties</p></td>
</tr><tr>
<td>
<p><code><a href="ax_plotOptions.html">ax_plotOptions()</a></code> </p>
</td>
<td><p>Specific options for chart</p></td>
</tr><tr>
<td>
<p><code><a href="ax_proxy_options.html">ax_proxy_options()</a></code> </p>
</td>
<td><p>Proxy for updating options</p></td>
</tr><tr>
<td>
<p><code><a href="ax_proxy_series.html">ax_proxy_series()</a></code> </p>
</td>
<td><p>Proxy for updating series.</p></td>
</tr><tr>
<td>
<p><code><a href="ax_responsive.html">ax_responsive()</a></code> </p>
</td>
<td><p>Responsive options</p></td>
</tr><tr>
<td>
<p><code><a href="ax_states.html">ax_states()</a></code> </p>
</td>
<td><p>Charts' states</p></td>
</tr><tr>
<td>
<p><code><a href="ax_stroke.html">ax_stroke()</a></code> </p>
</td>
<td><p>Stroke properties</p></td>
</tr><tr>
<td>
<p><code><a href="ax_subtitle.html">ax_subtitle()</a></code> </p>
</td>
<td><p>Chart's subtitle</p></td>
</tr><tr>
<td>
<p><code><a href="ax_theme.html">ax_theme()</a></code> </p>
</td>
<td><p>Theme for charts</p></td>
</tr><tr>
<td>
<p><code><a href="ax_title.html">ax_title()</a></code> </p>
</td>
<td><p>Chart's title</p></td>
</tr><tr>
<td>
<p><code><a href="ax_tooltip.html">ax_tooltip()</a></code> </p>
</td>
<td><p>Tooltip options</p></td>
</tr><tr>
<td>
<p><code><a href="ax_xaxis.html">ax_xaxis()</a></code> </p>
</td>
<td><p>X-axis options</p></td>
</tr><tr>
<td>
<p><code><a href="ax_yaxis.html">ax_yaxis()</a></code> </p>
</td>
<td><p>Y-axis options</p></td>
</tr><tr>
<td>
<p><code><a href="ax_yaxis2.html">ax_yaxis2()</a></code> </p>
</td>
<td><p>Secondary Y-axis options</p></td>
</tr><tr>
<td>
<p><code><a href="bar_opts.html">bar_opts()</a></code> </p>
</td>
<td><p>Bar options</p></td>
</tr><tr>
<td>
<p><code><a href="config_update.html">config_update()</a></code> </p>
</td>
<td><p>Configuration for auto update</p></td>
</tr><tr>
<td>
<p><code><a href="events_opts.html">events_opts()</a></code> </p>
</td>
<td><p>Events options</p></td>
</tr><tr>
<td>
<p><code><a href="format_date.html">format_date()</a></code> </p>
</td>
<td><p>Format date in JS</p></td>
</tr><tr>
<td>
<p><code><a href="format_num.html">format_num()</a></code> </p>
</td>
<td><p>Format numbers (with D3)</p></td>
</tr><tr>
<td>
<p><code><a href="heatmap_opts.html">heatmap_opts()</a></code> </p>
</td>
<td><p>Heatmap options</p></td>
</tr><tr>
<td>
<p><code><a href="parse_df.html">parse_df()</a></code> </p>
</td>
<td><p>Convert a <code>data.frame</code> to a <code>list</code></p></td>
</tr><tr>
<td>
<p><code><a href="pie_opts.html">pie_opts()</a></code> </p>
</td>
<td><p>Pie options</p></td>
</tr><tr>
<td>
<p><code><a href="radialBar_opts.html">radialBar_opts()</a></code> </p>
</td>
<td><p>Radial bar options</p></td>
</tr><tr>
<td>
<p><code><a href="run_input_demo.html">run_input_demo()</a></code> </p>
</td>
<td><p>Run Shiny input events examples</p></td>
</tr><tr>
<td>
<p><code><a href="set_input_click.html">set_input_click()</a></code> </p>
</td>
<td><p>Retrieve click information in Shiny</p></td>
</tr><tr>
<td>
<p><code><a href="set_input_selection.html">set_input_selection()</a></code> </p>
</td>
<td><p>Retrieve selection information in Shiny</p></td>
</tr><tr>
<td>
<p><code><a href="set_input_zoom.html">set_input_zoom()</a></code> </p>
</td>
<td><p>Retrieve zoom information in Shiny</p></td>
</tr><tr>
<td>
<p><code><a href="unhcr_popstats_2017.html">unhcr_popstats_2017</a></code> </p>
</td>
<td><p>UNHCR data for 2017</p></td>
</tr><tr>
<td>
<p><code><a href="unhcr_ts.html">unhcr_ts</a></code> </p>
</td>
<td><p>UNHCR data by continent of origin</p></td>
</tr>
</tbody>
</table>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#section-all-functions">All functions</a></li>
</ul>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by <a href='https://twitter.com/_pvictorr'><img src="https://pbs.twimg.com/profile_images/844237339404722177/E1U61aM8_normal.jpg"/> Victor Perrier</a>, <a href='https://twitter.com/_mfaan'><img src="https://pbs.twimg.com/profile_images/912313931326218240/o1-wvA18_normal.jpg" /> Fanny Meyer</a>.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p>
</div>
</footer>
</div>
<div id="particles"></div>
<script>
window.onload = function() {
var config = {"particles":{"number":{"value":90,"density":{"enable":true,"value_area":1200}},"color":{"value":"#112446"},"shape":{"type":"circle","stroke":{"width":0,"color":"#000000"},"polygon":{"nb_sides":5},"image":{"src":"img/github.svg","width":100,"height":100}},"opacity":{"value":0.8,"random":false,"anim":{"enable":false,"speed":1,"opacity_min":0.1,"sync":false}},"size":{"value":3,"random":true,"anim":{"enable":false,"speed":40,"size_min":0.1,"sync":false}},"line_linked":{"enable":true,"distance":150,"color":"#112446","opacity":0.6,"width":1},"move":{"enable":true,"speed":5,"direction":"none","random":false,"straight":false,"out_mode":"out","bounce":false,"attract":{"enable":false,"rotateX":600,"rotateY":1200}}},"interactivity":{"detect_on":"canvas","events":{"onhover":{"enable":true,"mode":"repulse"},"onclick":{"enable":true,"mode":"push"},"resize":true}},"modes":{"grab":{"distance":400,"line_linked":{"opacity":1}},"bubble":{"distance":400,"size":40,"duration":2,"opacity":8,"speed":3},"repulse":{"distance":200,"duration":0.4},"push":{"particles_nb":4},"remove":{"particles_nb":2}},"retina_detect":true} ;
particlesJS("particles", config);
};
</script>
</body>
</html>