event_data: Access plotly user input event data in shiny

Description Usage Arguments Author(s) References See Also Examples

View source: R/shiny.R

Description

This function must be called within a reactive shiny context.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
event_data(
  event = c("plotly_hover", "plotly_unhover", "plotly_click", "plotly_doubleclick",
    "plotly_selected", "plotly_selecting", "plotly_brushed", "plotly_brushing",
    "plotly_deselect", "plotly_relayout", "plotly_restyle", "plotly_legendclick",
    "plotly_legenddoubleclick", "plotly_clickannotation", "plotly_afterplot",
    "plotly_sunburstclick"),
  source = "A",
  session = shiny::getDefaultReactiveDomain(),
  priority = c("input", "event")
)

Arguments

event

The type of plotly event. All supported events are listed in the function signature above (i.e., the usage section).

source

a character string of length 1. Match the value of this string with the source argument in plot_ly() (or ggplotly()) to respond to events emitted from that specific plot.

session

a shiny session object (the default should almost always be used).

priority

the priority of the corresponding shiny input value. If equal to "event", then event_data() always triggers re-execution, instead of re-executing only when the relevant shiny input value changes (the default).

Author(s)

Carson Sievert

References

See Also

event_register, event_unregister

Examples

1
2
3
4
## Not run: 
plotly_example("shiny", "event_data")

## End(Not run)

plotly documentation built on Feb. 13, 2020, 1:07 a.m.