356 lines
18 KiB
HTML
356 lines
18 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, shrink-to-fit=no"><title>Function reference • apexcharter</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-4.6.0/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-4.6.0/bootstrap.bundle.min.js"></script><script src="../deps/bs3compat-0.3.1/transition.js"></script><script src="../deps/bs3compat-0.3.1/tabs.js"></script><script src="../deps/bs3compat-0.3.1/bs3compat.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"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></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><!-- 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><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><link href="../syntax-highlighting.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 data-spy="scroll" data-target="#toc" data-headroom>
|
|
|
|
|
|
<nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-primary"><div class="container">
|
|
<a class="navbar-brand mb-0 h1" href="../index.html">apexcharter</a>
|
|
|
|
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
|
<span class="navbar-toggler-icon"></span>
|
|
</button>
|
|
|
|
<button type="button" id="version-badge" class="badge badge-default d-none d-lg-block" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Released version">0.3.0.9000</button>
|
|
|
|
<div id="navbar" class="collapse navbar-collapse">
|
|
<ul class="navbar-nav mr-auto ml-3"><li class="nav-item">
|
|
<a class="nav-link" href="../articles/apexcharter.html">Get started</a>
|
|
</li>
|
|
<li class="active nav-item">
|
|
<a class="nav-link" href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li class="nav-item dropdown">
|
|
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-articles">Articles</a>
|
|
<div class="dropdown-menu" aria-labelledby="dropdown-articles">
|
|
<a class="dropdown-item" href="../articles/extra/advanced-configuration.html">Advanced configuration examples</a>
|
|
<a class="dropdown-item" href="../articles/extra/chart-options.html">Customize chart options</a>
|
|
<a class="dropdown-item" href="../articles/extra/facets.html">Create grid of charts</a>
|
|
<a class="dropdown-item" href="../articles/extra/shiny-integration.html">Use in Shiny application</a>
|
|
<a class="dropdown-item" href="../articles/extra/spark-box.html">Create boxes with sparklines</a>
|
|
<a class="dropdown-item" href="../articles/extra/sync-charts.html">Synchronize charts with each other</a>
|
|
</div>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a class="nav-link" href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
|
<input type="search" class="form-control mr-sm-2" aria-label="Search" name="search-input" data-search-index="/search.json" id="search-input" placeholder="Search..." autocomplete="off"></form>
|
|
|
|
<ul class="navbar-nav ml-1"><li class="nav-item">
|
|
<a class="nav-link" href="https://github.com/dreamRs/apexcharter/" aria-label="github">
|
|
<span class="fab fa fab fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
</nav><div class="container template-reference-index">
|
|
<div class="row">
|
|
<div class="contents col-md-9">
|
|
<img src="" class="pkg-logo" alt=""><div class="page-header pb-2 mt-4 mb-2 border-bottom toc-ignore">
|
|
<h1 class="display-4">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" aria-hidden="true"></a>All functions</h2>
|
|
<p class="section-desc"></p>
|
|
</th>
|
|
</tr></tbody><tbody><tr><td>
|
|
<p><code><a href="add-line.html">add_line()</a></code> <code><a href="add-line.html">add_smooth_line()</a></code> </p>
|
|
</td>
|
|
<td><p>Add a line to a chart</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="add-shade.html">add_shade()</a></code> <code><a href="add-shade.html">add_shade_weekend()</a></code> </p>
|
|
</td>
|
|
<td><p>Add a shaded area to a chart</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="add-vh-lines.html">add_hline()</a></code> <code><a href="add-vh-lines.html">add_vline()</a></code> </p>
|
|
</td>
|
|
<td><p>Add horizontal or vertical line</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="add_event.html">add_event()</a></code> </p>
|
|
</td>
|
|
<td><p>Add an event to a chart</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="add_event_marker.html">add_event_marker()</a></code> </p>
|
|
</td>
|
|
<td><p>Add an event marker to a chart</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="add_point.html">add_point()</a></code> </p>
|
|
</td>
|
|
<td><p>Add an annotation point</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="apex-facets.html">ax_facet_wrap()</a></code> <code><a href="apex-facets.html">ax_facet_grid()</a></code> </p>
|
|
</td>
|
|
<td><p>Facets for ApexCharts</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="apex.html">apex()</a></code> </p>
|
|
</td>
|
|
<td><p>Quick ApexCharts</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-facets.html">apexfacetOutput()</a></code> <code><a href="apexcharter-shiny-facets.html">renderApexfacet()</a></code> </p>
|
|
</td>
|
|
<td><p>Shiny bindings for faceting with apexcharter</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="apexcharter-shiny-grid.html">apexgridOutput()</a></code> <code><a href="apexcharter-shiny-grid.html">renderApexgrid()</a></code> </p>
|
|
</td>
|
|
<td><p>Shiny bindings for grid with apexcharter</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="apexcharter-shiny.html">apexchartOutput()</a></code> <code><a href="apexcharter-shiny.html">renderApexchart()</a></code> <code><a href="apexcharter-shiny.html">sparkBoxOutput()</a></code> <code><a href="apexcharter-shiny.html">renderSparkBox()</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="apex_grid.html">apex_grid()</a></code> </p>
|
|
</td>
|
|
<td><p>Create a grid of ApexCharts</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_colors_manual.html">ax_colors_manual()</a></code> </p>
|
|
</td>
|
|
<td><p>Set specific color's series</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_nodata.html">ax_nodata()</a></code> </p>
|
|
</td>
|
|
<td><p>Configuration for charts with no data</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="bubble_opts.html">bubble_opts()</a></code> </p>
|
|
</td>
|
|
<td><p>Bubble options</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="candles.html">candles</a></code> </p>
|
|
</td>
|
|
<td><p>Candlestick demo data</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="climate_paris.html">climate_paris</a></code> </p>
|
|
</td>
|
|
<td><p>Paris Climate</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="consumption.html">consumption</a></code> </p>
|
|
</td>
|
|
<td><p>Electricity consumption and forecasting</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="label.html">label()</a></code> </p>
|
|
</td>
|
|
<td><p>Label for annotations</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_demo_input.html">run_demo_input()</a></code> </p>
|
|
</td>
|
|
<td><p>Run Shiny input events examples</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="run_demo_sparkbox.html">run_demo_sparkbox()</a></code> </p>
|
|
</td>
|
|
<td><p>Run Shiny spark boxes example</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="run_demo_sync.html">run_demo_sync()</a></code> </p>
|
|
</td>
|
|
<td><p>Run Shiny synchronization example</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_export.html">set_input_export()</a></code> </p>
|
|
</td>
|
|
<td><p>Retrieve chart's base64 dataURI.</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="set_tooltip_fixed.html">set_tooltip_fixed()</a></code> </p>
|
|
</td>
|
|
<td><p>Fixed tooltip</p></td>
|
|
</tr><tr><td>
|
|
<p><code><a href="spark_box.html">spark_box()</a></code> </p>
|
|
</td>
|
|
<td><p>Create a box with a sparkline</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="pkgdown-sidebar">
|
|
<div class="sticky-top">
|
|
<nav id="toc"><h2 data-toc-skip>Contents</h2>
|
|
|
|
</nav></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<footer><div class="pkgdown-footer-left">
|
|
<p></p><p>Developed by <a href="https://twitter.com/_pvictorr" class="external-link"><img src="https://pbs.twimg.com/profile_images/844237339404722177/E1U61aM8_normal.jpg"> Victor Perrier</a>, <a href="https://twitter.com/_mfaan" class="external-link"><img src="https://pbs.twimg.com/profile_images/912313931326218240/o1-wvA18_normal.jpg"> Fanny Meyer</a>.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown-footer-right">
|
|
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 1.6.1.9001.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|