2021-12-10 17:17:40 +01:00
<!DOCTYPE html>
2023-05-05 10:08:10 +02:00
<!-- 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 = "Events options" > < title > Events options — events_opts • 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 = "Events options — events_opts" > < meta property = "og:description" content = "Events 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]>
2021-12-10 17:17:40 +01:00
< 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 >
< 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 >
2023-06-12 10:00:18 +02:00
< small class = "nav-text text-muted me-auto" data-bs-toggle = "tooltip" data-bs-placement = "bottom" title = "" > 0.4.0.9300< / small >
2021-12-10 17:17:40 +01:00
< 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 >
2022-02-27 17:23:59 +01:00
< div id = "navbar" class = "collapse navbar-collapse ms-3" >
2021-12-10 17:17:40 +01:00
< 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 > Events options< / h1 >
< small class = "dont-index" > Source: < a href = "https://github.com/dreamRs/apexcharter/blob/HEAD/R/apex-options.R" class = "external-link" > < code > R/apex-options.R< / code > < / a > < / small >
< div class = "d-none name" > < code > events_opts.Rd< / code > < / div >
< / div >
< div class = "ref-description section level2" >
< p > Events options< / p >
< / div >
< div class = "section level2" >
< h2 id = "ref-usage" > Usage< a class = "anchor" aria-label = "anchor" href = "#ref-usage" > < / a > < / h2 >
2022-12-01 14:31:31 +01:00
< div class = "sourceCode" > < pre class = "sourceCode r" > < code > < span > < span class = "fu" > events_opts< / span > < span class = "op" > (< / span > < / span >
< span > click < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > beforeMount < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > mounted < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > updated < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > legendClick < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > selection < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > dataPointSelection < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > dataPointMouseEnter < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > dataPointMouseLeave < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > beforeZoom < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > zoomed < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > scrolled < 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 >
2021-12-10 17:17:40 +01:00
< / div >
< div class = "section level2" >
< h2 id = "arguments" > Arguments< a class = "anchor" aria-label = "anchor" href = "#arguments" > < / a > < / h2 >
< dl > < dt > click< / dt >
< dd > < p > Fires when user clicks on any area of the chart.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > beforeMount< / dt >
< dd > < p > Fires before the chart has been drawn on screen.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > mounted< / dt >
< dd > < p > Fires after the chart has been drawn on screen.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > updated< / dt >
< dd > < p > Fires when the chart has been dynamically updated.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > legendClick< / dt >
< dd > < p > Fires when user clicks on legend.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > selection< / dt >
< dd > < p > Fires when user selects rect using the selection tool.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > dataPointSelection< / dt >
< dd > < p > Fires when user clicks on a datapoint (bar/column/marker/bubble/donut-slice).< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > dataPointMouseEnter< / dt >
< dd > < p > Fires when user's mouse enter on a datapoint (bar/column/marker/bubble/donut-slice).< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > dataPointMouseLeave< / dt >
< dd > < p > MouseLeave event for a datapoint (bar/column/marker/bubble/donut-slice).< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > beforeZoom< / dt >
< dd > < p > This function, if defined, runs just before zooming in/out of the chart allowing you to set a custom range for zooming in/out.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > zoomed< / dt >
< dd > < p > Fires when user zooms in/out the chart using either the selection zooming tool or zoom in/out buttons.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > scrolled< / dt >
< dd > < p > Fires when user scrolls using the pan tool.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< dt > ...< / dt >
< dd > < p > Additional parameters.< / p > < / dd >
2022-12-01 14:31:31 +01:00
2021-12-10 17:17:40 +01:00
< / dl > < / div >
< div class = "section level2" >
< h2 id = "value" > Value< a class = "anchor" aria-label = "anchor" href = "#value" > < / a > < / h2 >
2022-12-01 14:31:31 +01:00
< p > A < code > list< / code > of options that can be used in < code > < a href = "ax_chart.html" > ax_chart< / a > < / code > .< / p >
2021-12-10 17:17:40 +01:00
< / div >
< div class = "section level2" >
< h2 id = "note" > Note< a class = "anchor" aria-label = "anchor" href = "#note" > < / a > < / h2 >
< p > All arguments should be JavaScript function defined with < code > < a href = "https://rdrr.io/pkg/htmlwidgets/man/JS.html" class = "external-link" > htmlwidgets::JS< / a > < / code > .< / p >
< p > See < a href = "https://apexcharts.com/docs/options/chart/events/" class = "external-link" > https://apexcharts.com/docs/options/chart/events/< / a > .< / p >
< / div >
< div class = "section level2" >
< h2 id = "ref-examples" > Examples< a class = "anchor" aria-label = "anchor" href = "#ref-examples" > < / a > < / h2 >
2022-12-01 14:31:31 +01:00
< div class = "sourceCode" > < pre class = "sourceCode r" > < code > < span class = "r-in" > < span > < / span > < / span >
< span class = "r-in" > < span > < span class = "kw" > if< / span > < span class = "op" > (< / span > < span class = "fu" > < a href = "https://rdrr.io/r/base/interactive.html" class = "external-link" > interactive< / a > < / span > < span class = "op" > (< / span > < span class = "op" > )< / span > < span class = "op" > )< / span > < span class = "op" > {< / 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://shiny.rstudio.com/" class = "external-link" > shiny< / a > < / span > < span class = "op" > )< / span > < / span > < / span >
< span class = "r-in" > < span > < / span > < / span >
2023-05-17 15:53:51 +02:00
< span class = "r-in" > < span > < span class = "va" > ui< / span > < span class = "op" > < -< / span > < span class = "fu" > < a href = "https://rdrr.io/pkg/shiny/man/fluidPage.html" class = "external-link" > fluidPage< / a > < / span > < span class = "op" > (< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > < a href = "https://rdrr.io/pkg/shiny/man/fluidPage.html" class = "external-link" > fluidRow< / a > < / span > < span class = "op" > (< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > < a href = "https://rdrr.io/pkg/shiny/man/column.html" class = "external-link" > column< / a > < / span > < span class = "op" > (< / span > < / span > < / span >
2022-12-01 14:31:31 +01:00
< span class = "r-in" > < span > width < span class = "op" > =< / span > < span class = "fl" > 8< / span > , offset < span class = "op" > =< / span > < span class = "fl" > 2< / span > ,< / span > < / span >
< span class = "r-in" > < span > < span class = "va" > tags< / span > < span class = "op" > $< / span > < span class = "fu" > h2< / span > < span class = "op" > (< / span > < span class = "st" > "Apexchart in Shiny"< / span > < span class = "op" > )< / span > ,< / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > < a href = "apexcharter-shiny.html" > apexchartOutput< / a > < / span > < span class = "op" > (< / span > < span class = "st" > "chart"< / span > < span class = "op" > )< / span > ,< / span > < / span >
2023-05-17 15:53:51 +02:00
< span class = "r-in" > < span > < span class = "fu" > < a href = "https://rdrr.io/pkg/shiny/man/textOutput.html" class = "external-link" > verbatimTextOutput< / a > < / span > < span class = "op" > (< / span > outputId < span class = "op" > =< / span > < span class = "st" > "res_click"< / span > < span class = "op" > )< / span > < / span > < / span >
2022-12-01 14:31:31 +01:00
< span class = "r-in" > < 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 >
< span class = "r-in" > < span > < / span > < / span >
< span class = "r-in" > < span > < span class = "va" > server< / span > < span class = "op" > < -< / span > < span class = "kw" > function< / span > < span class = "op" > (< / span > < span class = "va" > input< / span > , < span class = "va" > output< / span > , < span class = "va" > session< / span > < span class = "op" > )< / span > < span class = "op" > {< / span > < / span > < / span >
< span class = "r-in" > < span > < / span > < / span >
< span class = "r-in" > < span > < span class = "va" > output< / span > < span class = "op" > $< / span > < span class = "va" > chart< / span > < span class = "op" > < -< / span > < span class = "fu" > < a href = "apexcharter-shiny.html" > renderApexchart< / a > < / span > < span class = "op" > (< / span > < span class = "op" > {< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > < a href = "apexchart.html" > apexchart< / a > < / span > < span class = "op" > (< / span > < span class = "op" > )< / span > < span class = "op" > < a href = "apexcharter-exports.html" > %> %< / a > < / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > < a href = "ax_chart.html" > ax_chart< / a > < / span > < span class = "op" > (< / span > < / span > < / span >
< span class = "r-in" > < span > type < span class = "op" > =< / span > < span class = "st" > "bar"< / span > ,< / span > < / span >
< span class = "r-in" > < span > events < span class = "op" > =< / span > < span class = "fu" > events_opts< / span > < span class = "op" > (< / span > < / span > < / span >
< span class = "r-in" > < span > dataPointSelection < span class = "op" > =< / span > < span class = "fu" > < a href = "apexcharter-exports.html" > JS< / a > < / span > < span class = "op" > (< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "st" > "function(event, chartContext, config) {< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "st" > Shiny.setInputValue('click', config.selectedDataPoints)< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "st" > }"< / 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 >
< span class = "r-in" > < span > < span class = "op" > )< / span > < span class = "op" > < a href = "apexcharter-exports.html" > %> %< / a > < / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > < a href = "ax-series.html" > ax_series< / a > < / span > < span class = "op" > (< / span > < / span > < / span >
< span class = "r-in" > < 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 > name < span class = "op" > =< / span > < span class = "st" > "Example"< / span > ,< / span > < / span >
< span class = "r-in" > < span > data < span class = "op" > =< / span > < span class = "fu" > < a href = "https://rdrr.io/r/base/sample.html" class = "external-link" > sample< / a > < / span > < span class = "op" > (< / span > < span class = "fl" > 1< / span > < span class = "op" > :< / span > < span class = "fl" > 100< / span > , < span class = "fl" > 5< / 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 class = "op" > < a href = "apexcharter-exports.html" > %> %< / a > < / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > < a href = "ax_xaxis.html" > ax_xaxis< / a > < / span > < span class = "op" > (< / span > < / span > < / span >
< span class = "r-in" > < span > categories < span class = "op" > =< / span > < span class = "va" > LETTERS< / span > < span class = "op" > [< / span > < span class = "fl" > 1< / span > < span class = "op" > :< / span > < span class = "fl" > 5< / 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 class = "op" > )< / span > < / span > < / span >
< span class = "r-in" > < span > < / span > < / span >
2023-05-17 15:53:51 +02:00
< span class = "r-in" > < span > < span class = "va" > output< / span > < span class = "op" > $< / span > < span class = "va" > res_click< / span > < span class = "op" > < -< / span > < span class = "fu" > < a href = "https://rdrr.io/pkg/shiny/man/renderPrint.html" class = "external-link" > renderPrint< / a > < / span > < span class = "op" > (< / span > < span class = "op" > {< / span > < / span > < / span >
2022-12-01 14:31:31 +01:00
< span class = "r-in" > < span > < span class = "va" > input< / span > < span class = "op" > $< / span > < span class = "va" > click< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "op" > }< / span > < span class = "op" > )< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "op" > }< / span > < / span > < / span >
< span class = "r-in" > < span > < / span > < / span >
2023-05-17 15:53:51 +02:00
< span class = "r-in" > < span > < span class = "fu" > < a href = "https://rdrr.io/pkg/shiny/man/shinyApp.html" class = "external-link" > shinyApp< / a > < / span > < span class = "op" > (< / span > < span class = "va" > ui< / span > , < span class = "va" > server< / span > < span class = "op" > )< / span > < / span > < / span >
2022-12-01 14:31:31 +01:00
< span class = "r-in" > < span > < span class = "op" > }< / span > < / span > < / span >
2021-12-10 17:17:40 +01:00
< / 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" >
2023-01-08 18:49:46 +01:00
< p > < / p > < p > Site built with < a href = "https://pkgdown.r-lib.org/" class = "external-link" > pkgdown< / a > 2.0.7.< / p >
2021-12-10 17:17:40 +01:00
< / div >
< / footer > < / div >
< / body > < / html >