Add plotly_relayout to shiny input events

Author: cpsievert

R/shiny.R

@@ -36,7 +36,7 @@ renderPlotly <- function(expr, env = parent.frame(), quoted = FALSE) {
 #' This function must be called within a reactive shiny context.
 #' 
 #' @param event The type of plotly event. Currently 'plotly_hover',
-#' 'plotly_click', and 'plotly_selected' are supported.
+#' 'plotly_click', 'plotly_selected', and 'plotly_relayout' are supported.
 #' @param source Which plot should the listener be tied to? This 
 #' (character string) should match the value of \code{source} in \link{plot_ly}.
 #' @export
@@ -45,8 +45,8 @@ renderPlotly <- function(expr, env = parent.frame(), quoted = FALSE) {
 #' shiny::runApp(system.file("examples", "events", package = "plotly"))
 #' }
 
-event_data <- function(event = c("plotly_hover", "plotly_click", "plotly_selected"), 
-                       source = "A") {
+event_data <- function(event = c("plotly_hover", "plotly_click", "plotly_selected", 
+                                 "plotly_relayout"), source = "A") {
   session <- shiny::getDefaultReactiveDomain()
   if (is.null(session)) {
     stop("No reactive domain detected. This function can only be called \n",

inst/examples/plotlyEvents/app.R

@@ -6,7 +6,8 @@ ui <- fluidPage(
   plotlyOutput("plot"),
   verbatimTextOutput("hover"),
   verbatimTextOutput("click"),
-  verbatimTextOutput("brush")
+  verbatimTextOutput("brush"),
+  verbatimTextOutput("zoom")
 )
 
 server <- function(input, output, session) {
@@ -39,6 +40,11 @@ server <- function(input, output, session) {
     if (is.null(d)) "Click and drag events (i.e., select/lasso) appear here (double-click to clear)" else d
   })
 
+  output$zoom <- renderPrint({
+    d <- event_data("plotly_relayout")
+    if (is.null(d)) "Relayout (i.e., zoom) events appear here" else d
+  })
+  
 }
 
 shinyApp(ui, server, options = list(display.mode = "showcase"))

inst/htmlwidgets/plotly.js

@@ -71,6 +71,13 @@ HTMLWidgets.widget({
 
     // send user input event data to shiny
     if (shinyMode) {
+      // https://plot.ly/javascript/zoom-events/
+      graphDiv.on('plotly_relayout', function(d) {
+        Shiny.onInputChange(
+          ".clientValue-" + "plotly_relayout" + "-" + x.source, 
+          JSON.stringify(d)
+        );
+      });
       graphDiv.on('plotly_hover', sendEventData('plotly_hover'));
       graphDiv.on('plotly_click', sendEventData('plotly_click'));
       graphDiv.on('plotly_selected', sendEventData('plotly_selected'));