Robot
/
apexcharter
mirror of https://github.com/dreamRs/apexcharter.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
apexcharter/docs/reference/add-shade.html

177 lines
18 KiB
HTML
Raw Blame History

<!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"><meta name="description" content="add_shade() allow to add a shaded area on specified range,
add_shade_weekend() add a shadow on every week-end."><title>Add a shaded area to a chart — add-shade • 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="Add a shaded area to a chart — add-shade"><meta property="og:description" content="add_shade() allow to add a shaded area on specified range,
add_shade_weekend() add a shadow on every week-end."><!-- 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-topic">
<div class="row">
<div class="col-md-9 contents">
<img src="" class="pkg-logo" alt=""><div class="page-header pb-2 mt-4 mb-2 border-bottom toc-ignore">
<h1 class="display-4">Add a shaded area to a chart</h1>
<small class="dont-index">Source: <a href="https://github.com/dreamRs/apexcharter/blob/master/R/annotations.R"><code>R/annotations.R</code></a></small>
<div class="d-none name"><code>add-shade.Rd</code></div>
</div>
<div class="ref-description section level2">
<p><code>add_shade()</code> allow to add a shaded area on specified range,
<code>add_shade_weekend()</code> add a shadow on every week-end.</p>
</div>
<div id="ref-usage" class="ref-usage section level2 sourceCode">
<pre class="sourceCode r"><code><span class="fu">add_shade</span><span class="op">(</span><span class="va">ax</span>, <span class="va">from</span>, <span class="va">to</span>, color <span class="op">=</span> <span class="st">"#848484"</span>, opacity <span class="op">=</span> <span class="fl">0.2</span>, label <span class="op">=</span> <span class="cn">NULL</span>, <span class="va">...</span><span class="op">)</span>
<span class="fu">add_shade_weekend</span><span class="op">(</span><span class="va">ax</span>, color <span class="op">=</span> <span class="st">"#848484"</span>, opacity <span class="op">=</span> <span class="fl">0.2</span>, label <span class="op">=</span> <span class="cn">NULL</span>, <span class="va">...</span><span class="op">)</span></code></pre>
</div>
<h2>Arguments</h2>
<dl class="row" id="ref-arguments"><dt class="col-sm-3 section level2" id="pkg-arg-ax">ax</dt>
<dd class="col-sm-9" id="ref-arguments desc"><p>An <code><a href="apexchart.html">apexchart()</a></code> <code>htmlwidget</code> object.</p></dd>
<dt class="col-sm-3 section level2" id="pkg-arg-from">from</dt>
<dd class="col-sm-9" id="ref-arguments desc"><p>Vector of position to start shadow.</p></dd>
<dt class="col-sm-3 section level2" id="pkg-arg-to">to</dt>
<dd class="col-sm-9" id="ref-arguments desc"><p>Vector of position to end shadow.</p></dd>
<dt class="col-sm-3 section level2" id="pkg-arg-color">color</dt>
<dd class="col-sm-9" id="ref-arguments desc"><p>Color of the shadow.</p></dd>
<dt class="col-sm-3 section level2" id="pkg-arg-opacity">opacity</dt>
<dd class="col-sm-9" id="ref-arguments desc"><p>Opacity of the shadow.</p></dd>
<dt class="col-sm-3 section level2" id="pkg-arg-label">label</dt>
<dd class="col-sm-9" id="ref-arguments desc"><p>Add a label to the shade, use a <code>character</code>
or see <code><a href="label.html">label</a></code> for more controls.</p></dd>
<dt class="col-sm-3 section level2" id="pkg-arg-...">...</dt>
<dd class="col-sm-9" id="ref-arguments desc"><p>Additional arguments, see
<a href="https://apexcharts.com/docs/options/annotations/">https://apexcharts.com/docs/options/annotations/</a> for possible options.</p></dd>
</dl><div class="ref-section section level2" id="section-value">
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value" aria-hidden="true"></a>Value</h2>
<p>An <code><a href="apexchart.html">apexchart()</a></code> <code>htmlwidget</code> object.</p>
</div>
<div class="ref-section section level2" id="section-note">
<h2 class="hasAnchor" id="note"><a class="anchor" href="#note" aria-hidden="true"></a>Note</h2>
<p><code>add_shade_weekend</code> only works if variable
used for x-axis is of class <code>Date</code> or <code>POSIXt</code>.</p>
</div>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples" aria-hidden="true"></a>Examples</h2>
<div class="ref-examples sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span>
<span class="r-in"><span class="kw"><a href="https://rdrr.io/r/base/library.html">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/dreamRs/apexcharter">apexcharter</a></span><span class="op">)</span></span>
<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/utils/data.html">data</a></span><span class="op">(</span><span class="st">"consumption"</span><span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="co"># specify from and to date</span></span>
<span class="r-in"><span class="fu"><a href="apex.html">apex</a></span><span class="op">(</span><span class="va">consumption</span>, <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">date</span>, <span class="va">value</span>, group <span class="op">=</span> <span class="va">type</span><span class="op">)</span>, <span class="st">"spline"</span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span> </span>
<span class="r-in"> <span class="fu">add_shade</span><span class="op">(</span>from <span class="op">=</span> <span class="st">"2020-01-06"</span>, to <span class="op">=</span> <span class="st">"2020-01-20"</span><span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="co"># you can add several shadows</span></span>
<span class="r-in"><span class="fu"><a href="apex.html">apex</a></span><span class="op">(</span><span class="va">consumption</span>, <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">date</span>, <span class="va">value</span>, group <span class="op">=</span> <span class="va">type</span><span class="op">)</span>, <span class="st">"spline"</span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span> </span>
<span class="r-in"> <span class="fu">add_shade</span><span class="op">(</span>from <span class="op">=</span> <span class="st">"2020-01-06"</span>, to <span class="op">=</span> <span class="st">"2020-01-20"</span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span> </span>
<span class="r-in"> <span class="fu">add_shade</span><span class="op">(</span>from <span class="op">=</span> <span class="st">"2020-02-04"</span>, to <span class="op">=</span> <span class="st">"2020-02-10"</span><span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="co"># or use a vector</span></span>
<span class="r-in"><span class="fu"><a href="apex.html">apex</a></span><span class="op">(</span><span class="va">consumption</span>, <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">date</span>, <span class="va">value</span>, group <span class="op">=</span> <span class="va">type</span><span class="op">)</span>, <span class="st">"spline"</span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span> </span>
<span class="r-in"> <span class="fu">add_shade</span><span class="op">(</span></span>
<span class="r-in"> from <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html">c</a></span><span class="op">(</span><span class="st">"2020-01-06"</span>, <span class="st">"2020-02-04"</span><span class="op">)</span>,</span>
<span class="r-in"> to <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html">c</a></span><span class="op">(</span><span class="st">"2020-01-20"</span>, <span class="st">"2020-02-10"</span><span class="op">)</span></span>
<span class="r-in"> <span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"></span>
<span class="r-in"><span class="co"># Add a label</span></span>
<span class="r-in"><span class="fu"><a href="apex.html">apex</a></span><span class="op">(</span><span class="va">consumption</span>, <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">date</span>, <span class="va">value</span>, group <span class="op">=</span> <span class="va">type</span><span class="op">)</span>, <span class="st">"spline"</span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span> </span>
<span class="r-in"> <span class="fu">add_shade</span><span class="op">(</span></span>
<span class="r-in"> from <span class="op">=</span> <span class="st">"2020-01-06"</span>, to <span class="op">=</span> <span class="st">"2020-01-20"</span>,</span>
<span class="r-in"> label <span class="op">=</span> <span class="st">"interesting period"</span></span>
<span class="r-in"> <span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="co"># add label with more options</span></span>
<span class="r-in"><span class="fu"><a href="apex.html">apex</a></span><span class="op">(</span><span class="va">consumption</span>, <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">date</span>, <span class="va">value</span>, group <span class="op">=</span> <span class="va">type</span><span class="op">)</span>, <span class="st">"spline"</span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span> </span>
<span class="r-in"> <span class="fu">add_shade</span><span class="op">(</span></span>
<span class="r-in"> from <span class="op">=</span> <span class="st">"2020-01-06"</span>, to <span class="op">=</span> <span class="st">"2020-01-20"</span>,</span>
<span class="r-in"> color <span class="op">=</span> <span class="st">"firebrick"</span>,</span>
<span class="r-in"> label <span class="op">=</span> <span class="fu"><a href="label.html">label</a></span><span class="op">(</span></span>
<span class="r-in"> text <span class="op">=</span> <span class="st">"something happened"</span>,</span>
<span class="r-in"> background <span class="op">=</span> <span class="st">"firebrick"</span>,</span>
<span class="r-in"> color <span class="op">=</span> <span class="st">"white"</span>, </span>
<span class="r-in"> fontWeight <span class="op">=</span> <span class="st">"bold"</span>,</span>
<span class="r-in"> padding <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html">c</a></span><span class="op">(</span><span class="fl">3</span>, <span class="fl">5</span>, <span class="fl">3</span>, <span class="fl">5</span><span class="op">)</span></span>
<span class="r-in"> <span class="op">)</span></span>
<span class="r-in"> <span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"></span>
<span class="r-in"><span class="co"># automatically add shadow on week-ends</span></span>
<span class="r-in"><span class="fu"><a href="apex.html">apex</a></span><span class="op">(</span><span class="va">consumption</span>, <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">date</span>, <span class="va">value</span>, group <span class="op">=</span> <span class="va">type</span><span class="op">)</span>, <span class="st">"spline"</span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span> </span>
<span class="r-in"> <span class="fu">add_shade_weekend</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"></span>
<span class="r-in"></span>
</code></pre></div>
</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>
Reference in New Issue View Git Blame Copy Permalink