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

178 lines
21 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 horizontal or vertical line"><title>Add horizontal or vertical line — add-vh-lines • 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-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/Poppins-0.4.9/font.css" rel="stylesheet"><!-- 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.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" 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><!-- 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 --><script src="../pkgdown.js"></script><meta property="og:title" content="Add horizontal or vertical line — add-vh-lines"><meta property="og:description" content="Add horizontal or vertical line"><!-- 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]--><!-- dependencies from examples --><script src="libs/htmlwidgets-1.6.4/htmlwidgets.js"></script><script src="libs/apexcharter-binding-0.4.1.9300/apexcharter.js"></script></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-primary"><div class="container">
<a class="navbar-brand me-2" href="../index.html">apexcharter</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.4.1.9300</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse ms-3">
<ul class="navbar-nav me-auto"><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-bs-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 me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
<ul class="navbar-nav"><li class="nav-item">
<a class="external-link 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">
<main id="main" class="col-md-9"><div class="page-header">
<img src="" class="logo" alt=""><h1>Add horizontal or vertical line</h1>
<small class="dont-index">Source: <a href="https://github.com/dreamRs/apexcharter/blob/HEAD/R/annotations.R" class="external-link"><code>R/annotations.R</code></a></small>
<div class="d-none name"><code>add-vh-lines.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Add horizontal or vertical line</p>
</div>
<div class="section level2">
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">add_hline</span><span class="op">(</span><span class="va">ax</span>, <span class="va">value</span>, color <span class="op">=</span> <span class="st">"#000"</span>, dash <span class="op">=</span> <span class="fl">0</span>, label <span class="op">=</span> <span class="cn">NULL</span>, <span class="va">...</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">add_vline</span><span class="op">(</span><span class="va">ax</span>, <span class="va">value</span>, color <span class="op">=</span> <span class="st">"#000"</span>, dash <span class="op">=</span> <span class="fl">0</span>, label <span class="op">=</span> <span class="cn">NULL</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
<dl><dt>ax</dt>
<dd><p>An <code><a href="apexchart.html">apexchart()</a></code> <code>htmlwidget</code> object.</p></dd>
<dt>value</dt>
<dd><p>Vector of position for the line(s).</p></dd>
<dt>color</dt>
<dd><p>Color(s) of the line(s).</p></dd>
<dt>dash</dt>
<dd><p>Creates dashes in borders of SVG path.
A higher number creates more space between dashes in the border.
Use <code>0</code> for plain line.</p></dd>
<dt>label</dt>
<dd><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>...</dt>
<dd><p>Additional arguments, see
<a href="https://apexcharts.com/docs/options/annotations/" class="external-link">https://apexcharts.com/docs/options/annotations/</a> for possible options.</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>An <code><a href="apexchart.html">apexchart()</a></code></p>
<p></p>
<p><code>htmlwidget</code> object.</p>
</div>
<div class="section level2">
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span>
<span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/dreamRs/apexcharter" class="external-link">apexcharter</a></span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># On a column chart</span></span></span>
<span class="r-in"><span><span class="va">unhcr_ts</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span></span></span>
<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/base/subset.html" class="external-link">subset</a></span><span class="op">(</span><span class="va">year</span> <span class="op">==</span> <span class="fl">2017</span> <span class="op">&amp;</span> <span class="va">population_type</span> <span class="op">==</span> <span class="st">"Asylum-seekers"</span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span></span></span>
<span class="r-in"><span> <span class="fu"><a href="apex.html">apex</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">continent_origin</span>, <span class="va">n</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> <span class="st">"column"</span></span></span>
<span class="r-in"><span> <span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span></span></span>
<span class="r-in"><span> <span class="fu">add_hline</span><span class="op">(</span>value <span class="op">=</span> <span class="fl">5e5</span><span class="op">)</span></span></span>
<div id="htmlwidget-1834a22cd196f3aa03a1" style="width:700px;height:432.632880098888px;" class="apexcharter html-widget"></div>
<script type="application/json" data-for="htmlwidget-1834a22cd196f3aa03a1">{"x":{"ax_opts":{"chart":{"type":"bar"},"series":[{"name":"n","type":"bar","data":[{"x":"Africa","y":964124},{"x":"Asia","y":1353541},{"x":"Europe","y":130065},{"x":"North America","y":384104},{"x":"Oceania","y":1315},{"x":"South America","y":210425}]}],"dataLabels":{"enabled":false},"plotOptions":{"bar":{"horizontal":false,"isDumbbell":false}},"tooltip":{"shared":true,"intersect":false,"followCursor":true},"grid":{"yaxis":{"lines":{"show":true}},"xaxis":{"lines":{"show":false}}},"yaxis":{"labels":{"style":{"colors":"#848484"}}},"xaxis":{"labels":{"style":{"colors":"#848484"}}},"annotations":{"position":"front","yaxis":[{"y":500000,"borderColor":"#000","strokeDashArray":0}]}},"auto_update":{"series_animate":true,"update_options":false,"options_animate":true,"options_redrawPaths":true,"update_synced_charts":false},"sparkbox":false,"xaxis":{"min":"Africa","max":"South America"},"type":"column"},"evals":[],"jsHooks":[]}</script><span class="r-in"><span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># On a scatter chart</span></span></span>
<span class="r-in"><span><span class="fu"><a href="apex.html">apex</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> data <span class="op">=</span> <span class="va">cars</span>,</span></span>
<span class="r-in"><span> <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">speed</span>, <span class="va">dist</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> <span class="st">"scatter"</span></span></span>
<span class="r-in"><span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span></span></span>
<span class="r-in"><span> <span class="fu">add_hline</span><span class="op">(</span>value <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mean.html" class="external-link">mean</a></span><span class="op">(</span><span class="va">cars</span><span class="op">$</span><span class="va">dist</span><span class="op">)</span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span></span></span>
<span class="r-in"><span> <span class="fu">add_vline</span><span class="op">(</span>value <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mean.html" class="external-link">mean</a></span><span class="op">(</span><span class="va">cars</span><span class="op">$</span><span class="va">speed</span><span class="op">)</span><span class="op">)</span></span></span>
<div id="htmlwidget-28515d92cb327f90c9eb" style="width:700px;height:432.632880098888px;" class="apexcharter html-widget"></div>
<script type="application/json" data-for="htmlwidget-28515d92cb327f90c9eb">{"x":{"ax_opts":{"chart":{"type":"scatter"},"series":[{"name":"dist","type":"scatter","data":[{"x":4,"y":2},{"x":4,"y":10},{"x":7,"y":4},{"x":7,"y":22},{"x":8,"y":16},{"x":9,"y":10},{"x":10,"y":18},{"x":10,"y":26},{"x":10,"y":34},{"x":11,"y":17},{"x":11,"y":28},{"x":12,"y":14},{"x":12,"y":20},{"x":12,"y":24},{"x":12,"y":28},{"x":13,"y":26},{"x":13,"y":34},{"x":13,"y":34},{"x":13,"y":46},{"x":14,"y":26},{"x":14,"y":36},{"x":14,"y":60},{"x":14,"y":80},{"x":15,"y":20},{"x":15,"y":26},{"x":15,"y":54},{"x":16,"y":32},{"x":16,"y":40},{"x":17,"y":32},{"x":17,"y":40},{"x":17,"y":50},{"x":18,"y":42},{"x":18,"y":56},{"x":18,"y":76},{"x":18,"y":84},{"x":19,"y":36},{"x":19,"y":46},{"x":19,"y":68},{"x":20,"y":32},{"x":20,"y":48},{"x":20,"y":52},{"x":20,"y":56},{"x":20,"y":64},{"x":22,"y":66},{"x":23,"y":54},{"x":24,"y":70},{"x":24,"y":92},{"x":24,"y":93},{"x":24,"y":120},{"x":25,"y":85}]}],"dataLabels":{"enabled":false},"xaxis":{"type":"numeric","min":0,"max":25,"tickAmount":5,"crosshairs":{"show":true,"stroke":{"dashArray":0}},"labels":{"style":{"colors":"#848484"}}},"yaxis":{"min":0,"max":120,"tickAmount":6,"labels":{"formatter":"function(value) {var locale = formatLocale(JSON.parse('{ \"decimal\": \".\", \"thousands\": \",\", \"grouping\": [3], \"currency\": [\"$\", \"\"]}')); return '' + locale.format('~r')(value) + '';}","style":{"colors":"#848484"}},"tooltip":{"enabled":true}},"grid":{"xaxis":{"lines":{"show":true}}},"annotations":{"position":"front","yaxis":[{"y":42.98,"borderColor":"#000","strokeDashArray":0}],"xaxis":[{"x":15.4,"borderColor":"#000","strokeDashArray":0}]}},"auto_update":{"series_animate":true,"update_options":false,"options_animate":true,"options_redrawPaths":true,"update_synced_charts":false},"sparkbox":false,"xaxis":{"min":4,"max":25},"type":"scatter"},"evals":["ax_opts.yaxis.labels.formatter"],"jsHooks":[]}</script><span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># With labels</span></span></span>
<span class="r-in"><span><span class="fu"><a href="apex.html">apex</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> data <span class="op">=</span> <span class="va">cars</span>,</span></span>
<span class="r-in"><span> <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">speed</span>, <span class="va">dist</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> <span class="st">"scatter"</span></span></span>
<span class="r-in"><span><span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span></span></span>
<span class="r-in"><span> <span class="fu">add_hline</span><span class="op">(</span></span></span>
<span class="r-in"><span> value <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mean.html" class="external-link">mean</a></span><span class="op">(</span><span class="va">cars</span><span class="op">$</span><span class="va">dist</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> label <span class="op">=</span> <span class="st">"Mean of dist"</span></span></span>
<span class="r-in"><span> <span class="op">)</span> <span class="op"><a href="apexcharter-exports.html">%&gt;%</a></span></span></span>
<span class="r-in"><span> <span class="fu">add_vline</span><span class="op">(</span></span></span>
<span class="r-in"><span> value <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mean.html" class="external-link">mean</a></span><span class="op">(</span><span class="va">cars</span><span class="op">$</span><span class="va">speed</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> label <span class="op">=</span> <span class="fu"><a href="label.html">label</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> text <span class="op">=</span> <span class="st">"Mean of speed"</span>,</span></span>
<span class="r-in"><span> borderColor <span class="op">=</span> <span class="st">"red"</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>
<div id="htmlwidget-0caf26d4e3c00206b0c5" style="width:700px;height:432.632880098888px;" class="apexcharter html-widget"></div>
<script type="application/json" data-for="htmlwidget-0caf26d4e3c00206b0c5">{"x":{"ax_opts":{"chart":{"type":"scatter"},"series":[{"name":"dist","type":"scatter","data":[{"x":4,"y":2},{"x":4,"y":10},{"x":7,"y":4},{"x":7,"y":22},{"x":8,"y":16},{"x":9,"y":10},{"x":10,"y":18},{"x":10,"y":26},{"x":10,"y":34},{"x":11,"y":17},{"x":11,"y":28},{"x":12,"y":14},{"x":12,"y":20},{"x":12,"y":24},{"x":12,"y":28},{"x":13,"y":26},{"x":13,"y":34},{"x":13,"y":34},{"x":13,"y":46},{"x":14,"y":26},{"x":14,"y":36},{"x":14,"y":60},{"x":14,"y":80},{"x":15,"y":20},{"x":15,"y":26},{"x":15,"y":54},{"x":16,"y":32},{"x":16,"y":40},{"x":17,"y":32},{"x":17,"y":40},{"x":17,"y":50},{"x":18,"y":42},{"x":18,"y":56},{"x":18,"y":76},{"x":18,"y":84},{"x":19,"y":36},{"x":19,"y":46},{"x":19,"y":68},{"x":20,"y":32},{"x":20,"y":48},{"x":20,"y":52},{"x":20,"y":56},{"x":20,"y":64},{"x":22,"y":66},{"x":23,"y":54},{"x":24,"y":70},{"x":24,"y":92},{"x":24,"y":93},{"x":24,"y":120},{"x":25,"y":85}]}],"dataLabels":{"enabled":false},"xaxis":{"type":"numeric","min":0,"max":25,"tickAmount":5,"crosshairs":{"show":true,"stroke":{"dashArray":0}},"labels":{"style":{"colors":"#848484"}}},"yaxis":{"min":0,"max":120,"tickAmount":6,"labels":{"formatter":"function(value) {var locale = formatLocale(JSON.parse('{ \"decimal\": \".\", \"thousands\": \",\", \"grouping\": [3], \"currency\": [\"$\", \"\"]}')); return '' + locale.format('~r')(value) + '';}","style":{"colors":"#848484"}},"tooltip":{"enabled":true}},"grid":{"xaxis":{"lines":{"show":true}}},"annotations":{"position":"front","yaxis":[{"y":42.98,"borderColor":"#000","strokeDashArray":0,"label":{"text":"Mean of dist"}}],"xaxis":[{"x":15.4,"borderColor":"#000","strokeDashArray":0,"label":{"borderColor":"red","text":"Mean of speed","style":{"padding":{"top":2,"right":5,"bottom":2,"left":5}}}}]}},"auto_update":{"series_animate":true,"update_options":false,"options_animate":true,"options_redrawPaths":true,"update_synced_charts":false},"sparkbox":false,"xaxis":{"min":4,"max":25},"type":"scatter"},"evals":["ax_opts.yaxis.labels.formatter"],"jsHooks":[]}</script></code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
</nav></aside></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> 2.0.7.</p>
</div>
</footer></div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink