set_input_click: Retrieve click information in Shiny

In apexcharter: Create Interactive Chart with the JavaScript 'ApexCharts' Library

Retrieve click information in Shiny

Description

According to type of chart, different values are retrieved:

• bar and column: retrieve category (x-axis).

• pie and donut: retrieve label.

• time-series: retrieve x-axis value, you have to display markers with size > 0 and set tooltip's options intersect = TRUE and shared = FALSE.

• scatter: retrieve XY coordinates.

Usage

set_input_click(
  ax,
  inputId,
  multiple = FALSE,
  effect_type = c("darken", "lighten", "none"),
  effect_value = 0.35,
  session = shiny::getDefaultReactiveDomain()
)

Arguments

ax	An apexchart() htmlwidget object.
inputId	The id that will be used server-side for retrieving click.
multiple	Allow multiple selection: TRUE or FALSE (default).
effect_type	Type of effect for selected element, default is to use lightly darken color.
effect_value	A larger value intensifies the select effect, accept value between 0 and 1.
session	The Shiny session.

Value

An apexchart() htmlwidget object.

Note

If x-axis is of type datetime, value retrieved is of class POSIXct.

Examples

library(apexcharter)

# Not in Shiny but you can still click on bars
data.frame(
  month = month.abb,
  value = sample(1:100, 12)
) %>% 
  apex(aes(month, value)) %>% 
  set_input_click("month_click", multiple = TRUE)


# Interactive examples:
if (interactive()) {

  run_demo_input("click")

}

apexcharter documentation built on Sept. 11, 2024, 8:22 p.m.