Bump version, update news, add support for hover and clear events

Author: cpsievert

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: plotly
 Title: Create Interactive Web Graphics via Plotly's JavaScript Graphing Library
-Version: 2.4.4
+Version: 2.5.0
 Authors@R: c(person("Carson", "Sievert", role = c("aut", "cre"),
     email = "[email protected]"),
     person("Chris", "Parmer", role = c("aut", "cph"),

NEWS

@@ -1,3 +1,19 @@
+2.5.0 -- 1 Mar 2015
+
+NEW FEATURES
+
+* New event_data() function provides easy access to plotly events in shiny.
+For an example, see https://github.com/ropensci/plotly/tree/master/inst/examples/plotlyEvents
+
+* plot_ly() and ggplotly() gain a source argument to differentiate between 
+plotly events in shiny apps with multiple plots. ggplotly() also gains width 
+and height arguments.
+
+CHANGES
+
+The arguments filename, fileopt, world_readable in ggplotly() were removed as
+they should be provided to plotly_POST() instead. 
+
 2.4.4 -- 13 Feb 2015
 
 as.widget() now returns htmlwidget objects untouched. See #449.

R/shiny.R

@@ -35,8 +35,8 @@ 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_click' and 
-#' 'plotly_selected' are supported.
+#' @param event The type of plotly event. Currently 'plotly_hover',
+#' 'plotly_click', and 'plotly_selected' 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,14 +45,13 @@ renderPlotly <- function(expr, env = parent.frame(), quoted = FALSE) {
 #' shiny::runApp(system.file("examples", "events", package = "plotly"))
 #' }
 
-event_data <- function(event = c("plotly_click", "plotly_selected"), 
+event_data <- function(event = c("plotly_hover", "plotly_click", "plotly_selected"), 
                        source = "A") {
   session <- shiny::getDefaultReactiveDomain()
   if (is.null(session)) {
     stop("No reactive domain detected. This function can only be called \n",
          "from within a reactive shiny context.")
   }
-  # TODO: is this safe?
   val <- session$input[[sprintf(".clientValue-%s-%s", event[1], source)]]
   if (event[1] == "plotly_selected" && !is.null(val)) {
     data.frame(lapply(val, as.numeric))

inst/examples/plotlyEvents/app.R

@@ -4,6 +4,7 @@ library(plotly)
 ui <- fluidPage(
   radioButtons("plotType", "Plot Type:", choices = c("ggplotly", "plotly")),
   plotlyOutput("plot"),
+  verbatimTextOutput("hover"),
   verbatimTextOutput("click"),
   verbatimTextOutput("brush")
 )
@@ -20,14 +21,19 @@ server <- function(input, output, session) {
     }
   })
 
+  output$hover <- renderPrint({
+    d <- event_data("plotly_hover")
+    if (is.null(d)) "Hover events appear here (unhover to clear)" else d
+  })
+  
   output$click <- renderPrint({
     d <- event_data("plotly_click")
-    if (is.null(d)) "Click on a point to view event data" else d
+    if (is.null(d)) "Click events appear here (double-click to clear)" else d
   })
 
   output$brush <- renderPrint({
     d <- event_data("plotly_selected")
-    if (is.null(d)) "Click and drag to view event data" else d
+    if (is.null(d)) "Click and drag events (i.e., select/lasso) appear here (double-click to clear)" else d
   })
 
 }

inst/htmlwidgets/plotly.js

@@ -8,7 +8,6 @@ HTMLWidgets.widget({
   },
 
   resize: function(el, width, height, instance) {
-    // TODO: impose fixed coordinates, if specified (see #342)
     Plotly.relayout(el.id, {width: width, height: height});
   },  
 
@@ -52,10 +51,38 @@ HTMLWidgets.widget({
           }
           return obj;
         });
-        Shiny.onInputChange(
-          ".clientValue-plotly_click-" + x.source, 
-          d
-        );
+        Shiny.onInputChange(".clientValue-plotly_click-" + x.source, d);
+      });
+      
+      // clear click selection
+      graphDiv.on('plotly_doubleclick', function(eventData) {
+        Shiny.onInputChange(".clientValue-plotly_click-" + x.source, null);
+      });
+      
+      graphDiv.on('plotly_hover', function(eventData) {
+        // extract only the data we may want to access in R
+        var d = eventData.points.map(function(pt) {
+          var obj = {
+              curveNumber: pt.curveNumber, 
+              pointNumber: pt.pointNumber, 
+              x: pt.x,
+              y: pt.y
+          };
+          if (pt.data.hasOwnProperty("key")) {
+            if (typeof pt.pointNumber === "number") {
+              obj.key = pt.data.key[pt.pointNumber];
+            } else {
+              obj.key = pt.data.key[pt.pointNumber[0]][pt.pointNumber[1]];
+            } // TODO: can pointNumber be 3D?
+          }
+          return obj;
+        });
+        Shiny.onInputChange(".clientValue-plotly_hover-" + x.source, d);
+      });
+      
+      // clear hover selection
+      graphDiv.on('plotly_unhover', function(eventData) {
+        Shiny.onInputChange(".clientValue-plotly_hover-" + x.source, null);
       });
 
       graphDiv.on('plotly_selected', function(eventData) {
@@ -69,14 +96,15 @@ HTMLWidgets.widget({
             x: pts.map(function(pt) {return pt.x; }),
             y: pts.map(function(pt) {return pt.y; })
           };
-          Shiny.onInputChange(
-            ".clientValue-plotly_selected-" + x.source, 
-            obj
-          );
+          Shiny.onInputChange(".clientValue-plotly_selected-" + x.source, obj);
         }
       });
 
-      // TODO: send `null` on a double-click to clear input value!?
+      // clear select/lasso selection & click
+      graphDiv.on('plotly_deselect', function(eventData) {
+        Shiny.onInputChange(".clientValue-plotly_selected-" + x.source, null);
+        Shiny.onInputChange(".clientValue-plotly_click-" + x.source, null);
+      });
 
     } // shinyMode
   } // renderValue