apexcharter/reference/ax_yaxis.html

200 lines
112 KiB
HTML
Raw Normal View 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="Y-axis options"><title>Y-axis options — ax_yaxis • 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.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><link href="../deps/Poppins-0.4.6/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="Y-axis options — ax_yaxis"><meta property="og:description" content="Y-axis options"><!-- 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.2/htmlwidgets.js"></script><script src="libs/apexcharter-binding-0.4.0.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.0.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>Y-axis options</h1>
<small class="dont-index">Source: <a href="https://github.com/dreamRs/apexcharter/blob/HEAD/R/apex-utils.R" class="external-link"><code>R/apex-utils.R</code></a></small>
<div class="d-none name"><code>ax_yaxis.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Y-axis options</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">ax_yaxis</span><span class="op">(</span></span>
<span> <span class="va">ax</span>,</span>
<span> opposite <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> tickAmount <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> max <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> min <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> floating <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> labels <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> axisBorder <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> axisTicks <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> title <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> tooltip <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> crosshairs <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> <span class="va">...</span></span>
<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>opposite</dt>
<dd><p>Logical. When enabled, will draw the yaxis on the right side of the chart.</p></dd>
<dt>tickAmount</dt>
<dd><p>Number of Tick Intervals to show.</p></dd>
<dt>max</dt>
<dd><p>Lowest number to be set for the y-axis. The graph drawing beyond this number will be clipped off.</p></dd>
<dt>min</dt>
<dd><p>Highest number to be set for the y-axis. The graph drawing beyond this number will be clipped off.</p></dd>
<dt>floating</dt>
<dd><p>Logical. Floating takes y-axis is taken out of normal flow and places y-axis on svg element directly,
similar to an absolutely positioned element. Set the offsetX and offsetY then to adjust the position manually</p></dd>
<dt>labels</dt>
<dd><p>A list of parameters.</p></dd>
<dt>axisBorder</dt>
<dd><p>A list of parameters.</p></dd>
<dt>axisTicks</dt>
<dd><p>A list of parameters.</p></dd>
<dt>title</dt>
<dd><p>A list of parameters.</p></dd>
<dt>tooltip</dt>
<dd><p>A list of parameters.</p></dd>
<dt>crosshairs</dt>
<dd><p>A list of parameters.</p></dd>
<dt>...</dt>
<dd><p>Additional parameters.</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="note">Note<a class="anchor" aria-label="anchor" href="#note"></a></h2>
<p>See <a href="https://apexcharts.com/docs/options/yaxis/" class="external-link">https://apexcharts.com/docs/options/yaxis/</a></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 class="fu"><a href="https://rdrr.io/r/utils/data.html" class="external-link">data</a></span><span class="op">(</span><span class="st">"economics_long"</span>, package <span class="op">=</span> <span class="st">"ggplot2"</span><span class="op">)</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">economics_long</span>,</span></span>
<span class="r-in"><span> mapping <span class="op">=</span> <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span>x <span class="op">=</span> <span class="va">date</span>, y <span class="op">=</span> <span class="va">value01</span>, group <span class="op">=</span> <span class="va">variable</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> type <span class="op">=</span> <span class="st">"line"</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">ax_yaxis</span><span class="op">(</span></span></span>
<span class="r-in"><span> decimalsInFloat <span class="op">=</span> <span class="fl">2</span>, title <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>text <span class="op">=</span> <span class="st">"Rescaled to [0,1]"</span><span class="op">)</span></span></span>
<span class="r-in"><span> <span class="op">)</span></span></span>
<div id="htmlwidget-48a3e3a5170e13dfc673" style="width:700px;height:432.632880098888px;" class="apexcharter html-widget "></div>
<script type="application/json" data-for="htmlwidget-48a3e3a5170e13dfc673">{"x":{"ax_opts":{"chart":{"type":"line"},"series":[{"name":"pce","type":"line","data":[[-79056000000,0],[-76377600000,0.0002652497197765077],[-73699200000,0.0007615233890357775],[-71107200000,0.0004706043415389667],[-68428800000,0.0009155393553576157],[-65836800000,0.001574385433512166],[-63158400000,0.002070659102771431],[-60480000000,0.002301683052254198],[-57974400000,0.003217222407611809],[-55296000000,0.003191553079891505],[-52704000000,0.00368782674915077],[-50025600000,0.004243995516424089],[-47433600000,0.004834390053991158],[-44755200000,0.00515953487178171],[-42076800000,0.005262212182662942],[-39484800000,0.005553131230159753],[-36806400000,0.005989509801404973],[-34214400000,0.005972396916258099],[-31536000000,0.006571347896398595],[-28857600000,0.007016282910217254],[-26438400000,0.00703339579536412],[-23760000000,0.007461217924035903],[-21168000000,0.008008830248735783],[-18489600000,0.0080601689041764],[-15897600000,0.008214184870498248],[-13219200000,0.00883024873578561],[-10540800000,0.009112611340708994],[-7948800000,0.00956610279710108],[-5270400000,0.009737231648569792],[-2678400000,0.00993402982775881],[0,0.01043885993959152],[2678400000,0.01089235139598361],[5097600000,0.0107468918722352],[7776000000,0.01106348024745232],[10368000000,0.0116110925721522],[13046400000,0.01194479383251619],[15638400000,0.01213303556913178],[18316800000,0.01250951904236295],[20995200000,0.01304001848191596],[23587200000,0.01297156694132847],[26265600000,0.01282610741758007],[28857600000,0.01359618724918928],[31536000000,0.01449461371940003],[34214400000,0.0147769763243234],[36633600000,0.01499944383123273],[39312000000,0.01558128192622635],[41904000000,0.01577808010541538],[44582400000,0.01652249060930427],[47174400000,0.01644548262614336],[49852800000,0.0169588691805495],[52531200000,0.01765194102899779],[55123200000,0.01789152142105398],[57801600000,0.0183278999922992],[60393600000,0.01896963318530688],[63072000000,0.01923488290508338],[65750400000,0.01963703570603487],[68256000000,0.0207493732405815],[70934400000,0.02103173584550488],[73526400000,0.02150234018704384],[76204800000,0.02181037211968753],[78796800000,0.02252055685328268],[81475200000,0.02306816917798256],[84153600000,0.02347887842150748],[86745600000,0.0246596674966416],[89424000000,0.025138828280754],[92016000000,0.0256179890648664],[94694400000,0.0265078590925037],[97372800000,0.02730360825183322],[99792000000,0.02790255923197371],[102470400000,0.02815069606660336],[105062400000,0.02865552617843606],[107740800000,0.02888655012791882],[110332800000,0.02972508150011552],[113011200000,0.02965662995952803],[115689600000,0.03101710432870431],[118281600000,0.03093153990296995],[120960000000,0.03167595040685885],[123552000000,0.03165028107913855],[126230400000,0.03232624004243996],[128908800000,0.03277117505625862],[131328000000,0.03377227883735059],[134006400000,0.03457658443925354],[136598400000,0.03556913177777208],[139276800000,0.03604829256188448],[141868800000,0.03689538037665461],[144547200000,0.03834141917156523],[147225600000,0.03836708849928554],[149817600000,0.03871790264479641],[152496000000,0.03846120936759334],[155088000000,0.03894037015170573],[157766400000,0.04012115922683986],[160444800000,0.04130194830197398],[162864000000,0.0414046256128552],[165542400000,0.04178110908608638],[168134400000,0.0438260988611375],[170812800000,0.04450205782443891],[173404800000,0.04561439535898554],[176083200000,0.04623045922427292],[178761600000,0.04689786174500089],[181353600000,0.04741980474198049],[184032000000,0.04869471468542239],[186624000000,0.0500894148248924],[189302400000,0.05137288121090774],[191980800000,0.05142421986634838],[194486400000,0.05204028373163574],[197164800000,0.05293871020184649],[199756800000,0.05270768625236372],[202435200000,0.05423073303043527],[205027200000,0.05500936930461791],[207705600000,0.05572811048078651],[210384000000,0.05665220627871756],[212976000000,0.05733672168459241],[215654400000,0.05838060767855157],[218246400000,0.0603058072575746],[22092
<span class="r-in"><span><span class="co"># Format tick labels</span></span></span>
<span class="r-in"><span><span class="va">temperature</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> month <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">month.name</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> tp <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">4</span>, <span class="op">-</span><span class="fl">2</span>, <span class="fl">2</span>, <span class="fl">7</span>, <span class="fl">11</span>, <span class="fl">14</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="fu"><a href="apex.html">apex</a></span><span class="op">(</span><span class="va">temperature</span>, <span class="fu"><a href="apexcharter-exports.html">aes</a></span><span class="op">(</span><span class="va">month</span>, <span class="va">tp</span><span class="op">)</span>, <span class="st">"line"</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">ax_yaxis</span><span class="op">(</span></span></span>
<span class="r-in"><span> labels <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> formatter <span class="op">=</span> <span class="fu">htmlwidgets</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/pkg/htmlwidgets/man/JS.html" class="external-link">JS</a></span><span class="op">(</span><span class="st">"function(value) {return value + '\u00b0C';}"</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>
<div id="htmlwidget-ba6ac75931265d4acdac" style="width:700px;height:432.632880098888px;" class="apexcharter html-widget "></div>
<script type="application/json" data-for="htmlwidget-ba6ac75931265d4acdac">{"x":{"ax_opts":{"chart":{"type":"line"},"series":[{"name":"tp","type":"line","data":[{"x":"January","y":4},{"x":"February","y":-2},{"x":"March","y":2},{"x":"April","y":7},{"x":"May","y":11},{"x":"June","y":14}]}],"dataLabels":{"enabled":false},"stroke":{"curve":"straight","width":2},"yaxis":{"decimalsInFloat":2,"labels":{"style":{"colors":"#848484"},"formatter":"function(value) {return value + '°C';}"}},"xaxis":{"labels":{"style":{"colors":"#848484"}}}},"auto_update":{"series_animate":true,"update_options":false,"options_animate":true,"options_redrawPaths":true,"update_synced_charts":false},"sparkbox":false,"xaxis":{"min":"April","max":"May"},"type":"line"},"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>