apexcharter/man/set_input_click.Rd

38 lines
1.1 KiB
Plaintext
Raw Normal View History

2020-03-04 11:55:23 +01:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/shiny-input.R
\name{set_input_click}
\alias{set_input_click}
\title{Retrieve click information in Shiny}
\usage{
2020-03-04 12:04:47 +01:00
set_input_click(
ax,
inputId,
multiple = FALSE,
effect_type = c("darken", "lighten", "none"),
effect_value = 0.35
)
2020-03-04 11:55:23 +01:00
}
\arguments{
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
\item{inputId}{The id that will be used server-side for retrieveng category.}
\item{multiple}{Allow multiple selection: \code{TRUE} or \code{FALSE} (default).}
2020-03-04 12:04:47 +01:00
\item{effect_type}{Type of effect for selected element, default is to use lightly darken color.}
\item{effect_value}{A larger value intensifies the select effect, accept value between 0 and 1.}
2020-03-04 11:55:23 +01:00
}
\value{
An \code{apexcharts} \code{htmlwidget} object.
}
\description{
According to type of chart, different values are retrieved:
\itemize{
\item \strong{bar and column:} retrieve category (x-axis).
\item \strong{pie and donut:} retrieve label.
\item \strong{time-series:} retrieve x-axis value, you have to display markers
with size > 0 and set tooltip's options \code{intersect = TRUE} and \code{shared = FALSE}.
}
}