282 lines
13 KiB
HTML
282 lines
13 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>Tooltip options — ax_tooltip • 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="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
|
||
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
|
||
|
||
<!-- Font Awesome icons -->
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" 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>
|
||
|
||
<!-- sticky kit -->
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>
|
||
|
||
<!-- pkgdown -->
|
||
<link href="../pkgdown.css" rel="stylesheet">
|
||
<script src="../pkgdown.js"></script>
|
||
|
||
|
||
|
||
<meta property="og:title" content="Tooltip options — ax_tooltip" />
|
||
|
||
<meta property="og:description" content="Tooltip options" />
|
||
<meta name="twitter:card" content="summary" />
|
||
|
||
|
||
|
||
<!-- 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>
|
||
<div class="container template-reference-topic">
|
||
<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">
|
||
<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.1</span>
|
||
</span>
|
||
</div>
|
||
|
||
<div id="navbar" class="navbar-collapse collapse">
|
||
<ul class="nav navbar-nav">
|
||
<li>
|
||
<a href="../index.html">
|
||
<span class="fa fa-home fa-lg"></span>
|
||
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="../articles/starting-with-apexcharts.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/labs.html">Labs: title, subtitle & axis</a>
|
||
</li>
|
||
<li>
|
||
<a href="../articles/lines.html">Options & styles for lines</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="../news/index.html">News</a>
|
||
</li>
|
||
</ul>
|
||
|
||
<ul class="nav navbar-nav navbar-right">
|
||
<li>
|
||
<a href="https://github.com/dreamRs/apexcharter">
|
||
<span class="fa fa-github fa-lg"></span>
|
||
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
|
||
</div><!--/.nav-collapse -->
|
||
</div><!--/.container -->
|
||
</div><!--/.navbar -->
|
||
|
||
|
||
</header>
|
||
|
||
<div class="row">
|
||
<div class="col-md-9 contents">
|
||
<div class="page-header">
|
||
<h1>Tooltip options</h1>
|
||
<small class="dont-index">Source: <a href='https://github.com/dreamRs/apexcharter/blob/master/R/apex-utils.R'><code>R/apex-utils.R</code></a></small>
|
||
<div class="hidden name"><code>ax_tooltip.Rd</code></div>
|
||
</div>
|
||
|
||
<div class="ref-description">
|
||
|
||
<p>Tooltip options</p>
|
||
|
||
</div>
|
||
|
||
<pre class="usage"><span class='fu'>ax_tooltip</span>(<span class='no'>ax</span>, <span class='kw'>enabled</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>shared</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>followCursor</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
||
<span class='kw'>intersect</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>inverseOrder</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>custom</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
||
<span class='kw'>fillSeriesColor</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>onDatasetHover</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>theme</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
||
<span class='kw'>x</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>y</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>z</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>marker</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>items</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
||
<span class='kw'>fixed</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='no'>...</span>)</pre>
|
||
|
||
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
|
||
<table class="ref-arguments">
|
||
<colgroup><col class="name" /><col class="desc" /></colgroup>
|
||
<tr>
|
||
<th>ax</th>
|
||
<td><p>A <code>apexcharts</code> <code>htmlwidget</code> object.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>enabled</th>
|
||
<td><p>Logical. Show tooltip when user hovers over chart area.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>shared</th>
|
||
<td><p>Logical. When having multiple series, show a shared tooltip.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>followCursor</th>
|
||
<td><p>Logical. Follow user’s cursor position instead of putting tooltip on actual data points.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>intersect</th>
|
||
<td><p>Logical. Show tooltip only when user hovers exactly over datapoint.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>inverseOrder</th>
|
||
<td><p>Logical. In multiple series, when having shared tooltip, inverse the order of series (for better comparison in stacked charts).</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>custom</th>
|
||
<td><p>JS function. Draw a custom html tooltip instead of the default one based on the values provided in the function arguments.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>fillSeriesColor</th>
|
||
<td><p>Logical. When enabled, fill the tooltip background with the corresponding series color.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>onDatasetHover</th>
|
||
<td><p>A list of parameters.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>theme</th>
|
||
<td><p>A list of parameters.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>x</th>
|
||
<td><p>A list of parameters.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>y</th>
|
||
<td><p>A list of parameters.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>z</th>
|
||
<td><p>A list of parameters.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>marker</th>
|
||
<td><p>A list of parameters.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>items</th>
|
||
<td><p>A list of parameters.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>fixed</th>
|
||
<td><p>A list of parameters.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th>...</th>
|
||
<td><p>Additional parameters.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
|
||
|
||
<p>A <code>apexcharts</code> <code>htmlwidget</code> object.</p>
|
||
|
||
<h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2>
|
||
|
||
<p>See <a href='https://apexcharts.com/docs/options/tooltip/'>https://apexcharts.com/docs/options/tooltip/</a></p>
|
||
|
||
|
||
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
|
||
<pre class="examples"><div class='input'><span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/library'>library</a></span>(<span class='no'>dplyr</span>)
|
||
<span class='fu'><a href='https://www.rdocumentation.org/packages/utils/topics/data'>data</a></span>(<span class='st'>"mpg"</span>, <span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"ggplot2"</span>)
|
||
|
||
<span class='co'># Hide tooltip</span>
|
||
<span class='fu'><a href='apex.html'>apex</a></span>(
|
||
<span class='kw'>data</span> <span class='kw'>=</span> <span class='fu'><a href='https://dplyr.tidyverse.org/reference/tally.html'>count</a></span>(<span class='no'>mpg</span>, <span class='no'>manufacturer</span>, <span class='no'>year</span>),
|
||
<span class='kw'>mapping</span> <span class='kw'>=</span> <span class='fu'><a href='apexcharter-exports.html'>aes</a></span>(<span class='kw'>x</span> <span class='kw'>=</span> <span class='no'>manufacturer</span>, <span class='kw'>y</span> <span class='kw'>=</span> <span class='no'>n</span>, <span class='kw'>fill</span> <span class='kw'>=</span> <span class='no'>year</span>)
|
||
) <span class='kw'>%>%</span>
|
||
<span class='fu'>ax_tooltip</span>(<span class='kw'>enabled</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)
|
||
|
||
<span class='co'># Share between series</span>
|
||
<span class='fu'><a href='apex.html'>apex</a></span>(
|
||
<span class='kw'>data</span> <span class='kw'>=</span> <span class='fu'><a href='https://dplyr.tidyverse.org/reference/tally.html'>count</a></span>(<span class='no'>mpg</span>, <span class='no'>manufacturer</span>, <span class='no'>year</span>),
|
||
<span class='kw'>mapping</span> <span class='kw'>=</span> <span class='fu'><a href='apexcharter-exports.html'>aes</a></span>(<span class='kw'>x</span> <span class='kw'>=</span> <span class='no'>manufacturer</span>, <span class='kw'>y</span> <span class='kw'>=</span> <span class='no'>n</span>, <span class='kw'>fill</span> <span class='kw'>=</span> <span class='no'>year</span>)
|
||
) <span class='kw'>%>%</span>
|
||
<span class='fu'>ax_tooltip</span>(<span class='kw'>shared</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
|
||
|
||
<span class='co'># Fixed tooltip</span>
|
||
<span class='fu'><a href='https://www.rdocumentation.org/packages/utils/topics/data'>data</a></span>(<span class='st'>"economics"</span>, <span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"ggplot2"</span>)
|
||
<span class='fu'><a href='apex.html'>apex</a></span>(
|
||
<span class='kw'>data</span> <span class='kw'>=</span> <span class='no'>economics</span>,
|
||
<span class='kw'>mapping</span> <span class='kw'>=</span> <span class='fu'><a href='apexcharter-exports.html'>aes</a></span>(<span class='kw'>x</span> <span class='kw'>=</span> <span class='no'>date</span>, <span class='kw'>y</span> <span class='kw'>=</span> <span class='no'>psavert</span>),
|
||
<span class='kw'>type</span> <span class='kw'>=</span> <span class='st'>"line"</span>
|
||
) <span class='kw'>%>%</span>
|
||
<span class='fu'>ax_tooltip</span>(
|
||
<span class='kw'>fixed</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/list'>list</a></span>(<span class='kw'>enabled</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>position</span> <span class='kw'>=</span> <span class='st'>"topLeft"</span>)
|
||
)</div></pre>
|
||
</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="#arguments">Arguments</a></li>
|
||
|
||
<li><a href="#value">Value</a></li>
|
||
|
||
<li><a href="#note">Note</a></li>
|
||
|
||
<li><a href="#examples">Examples</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.3.0.</p>
|
||
</div>
|
||
</footer>
|
||
</div>
|
||
|
||
|
||
|
||
</body>
|
||
</html>
|
||
|