forked from plotly/plotly.R
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathevent_data.Rd
More file actions
32 lines (29 loc) · 935 Bytes
/
event_data.Rd
File metadata and controls
32 lines (29 loc) · 935 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/shiny.R
\name{event_data}
\alias{event_data}
\title{Access plotly user input event data in shiny}
\usage{
event_data(event = c("plotly_hover", "plotly_click", "plotly_selected",
"plotly_relayout"), source = "A",
session = shiny::getDefaultReactiveDomain())
}
\arguments{
\item{event}{The type of plotly event. Currently 'plotly_hover',
'plotly_click', 'plotly_selected', and 'plotly_relayout' are supported.}
\item{source}{Which plot should the listener be tied to? This
(character string) should match the value of \code{source} in
\code{\link{plot_ly}()}.}
\item{session}{a shiny session object (the default should almost always be used).}
}
\description{
This function must be called within a reactive shiny context.
}
\examples{
\dontrun{
shiny::runApp(system.file("examples", "plotlyEvents", package = "plotly"))
}
}
\author{
Carson Sievert
}