maintain backwards-compatibility; document priority argument; update news

Author: cpsievert

NEWS.md

@@ -5,6 +5,11 @@
 * The `orca_serve()` function was added for efficient exporting of many plotly graphs. For examples, see `help(orca_serve)`.
 * The `orca()` function gains new arguments `more_args` and `...` for finer control over the underlying system commands.
 
+
+* Improved `event_data()` interface:
+  * The `event` argument of the `event_data()` function now supports the following events: `plotly_selecting`, `plotly_brushed`, `plotly_brushing`, `plotly_restyle`, `plotly_legendclick`, `plotly_legenddoubleclick`, `plotly_clickannotation`, `plotly_afterplot`, `plotly_doubleclick`, `plotly_deselect`, `plotly_unhover`. 
+  * A new `priority` argument. By setting `priority='event'`, the `event` is treated like a true event: any reactive expression using the `event` becomes invalidated (regardless of whether the input values has changed). For an example, see `plotly_example`
+
 ## IMPROVEMENTS
 
 * Upgraded to plotly.js v1.42.5.

R/shiny.R

@@ -84,6 +84,10 @@ register_plot_events <- function(p) {
 #' with the `source` argument in [plot_ly()] (or [ggplotly()]) to respond to  
 #' events emitted from that specific plot.
 #' @param session a shiny session object (the default should almost always be used).
+#' @param 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).
 #' @export
 #' @seealso [event_register], [event_unregister]
 #' @references 
@@ -100,10 +104,10 @@ event_data <- function(
     "plotly_selected", "plotly_selecting", "plotly_brushed", "plotly_brushing", 
     "plotly_deselect", "plotly_relayout", "plotly_restyle", "plotly_legendclick", 
     "plotly_legenddoubleclick", "plotly_clickannotation", "plotly_afterplot"
-  ), 
+  ),
   source = "A",
   session = shiny::getDefaultReactiveDomain(),
-  priority = c("event", "input")
+  priority = c("input", "event")
 ) {
   if (is.null(session)) {
     stop("No reactive domain detected. This function can only be called \n",
@@ -113,7 +117,7 @@ event_data <- function(
   event <- match.arg(event)
   # check to see if this event-source-priority combo is registered
   eventID <- paste(event, source, sep = "-")
-  eventIDRegistered <- eventID %in% session$userData[["plotlyShinyEventIDs"]]
+  eventIDRegistered <- eventID %in% session$userData$plotlyShinyEventIDs
   if (!eventIDRegistered) {
     stop(
       "The '", event, "' event has not been registered for a source ID ",

inst/examples/shiny/event_priority/app.R

@@ -9,9 +9,8 @@ ui <- fluidPage(
 server <- function(input, output, session) {
 
   output$p <- renderPlotly({
-    plot_ly(x = 1:2, y = 1:2, size = I(c(100, 150)))  %>%
-      add_markers() %>%
-      event_register("plotly_click", "event")
+    plot_ly(x = 1, y = 1, marker = list(size = 100))  %>%
+      add_trace(text = "Click me", mode = "markers+text")
   })
 
   output$time1 <- renderText({