Add 'plotly_selecting' to acceptable 'on' events

Author: cpsievert

R/highlight.R

@@ -145,7 +145,7 @@ highlight <- function(p, on = "plotly_click", off,
   # main (non-plotly.js) spec passed along to HTMLwidgets.renderValue()
   p$x$highlight <- list(
     # NULL may be used to disable on/off events
-    on = if (!is.null(on)) match.arg(on, paste0("plotly_", c("click", "hover", "selected"))),
+    on = if (!is.null(on)) match.arg(on, paste0("plotly_", c("click", "hover", "selected", "selecting"))),
     off = if (is.default(off)) off else if (!is.null(off)) match.arg(off, off_options),
     persistent = persistent,
     dynamic = dynamic,

R/utils.R

@@ -402,7 +402,7 @@ supply_highlight_attrs <- function(p) {
   # add HTML dependencies, set a sensible dragmode default, & throw messages
   if (hasKeys) {
     p$x$layout$dragmode <- p$x$layout$dragmode %|D|% 
-      default(switch(p$x$highlight$on %||% "", plotly_selected = "select") %||% "zoom")
+      default(switch(p$x$highlight$on %||% "", plotly_selected = "select", plotly_selecting = "select") %||% "zoom")
     if (is.default(p$x$highlight$off)) {
       message(
         sprintf(

demo/crosstalk-highlight-intro.R

@@ -16,13 +16,14 @@ sd <- SharedData$new(df, ~patient)
 p <- plot_ly(sd, x = ~visit, y = ~perc, color = I("black"),
              text = ~paste("Patient:", patient)) %>%
   group_by(patient) %>%
-  add_trace(mode = "markers+lines") %>%
-  highlight("plotly_selected")
+  add_trace(mode = "markers+lines")
+
+highlight(p, "plotly_selecting", color = "red")
 
 # Since crosstalk's SharedData object was supplied to plot_ly() with a key of
 # patient, it knows to highlight any lines/markers matching the selected patient(s).
 # By default, the "on trigger" is "plotly_click", but we've changed that to 
-# "plotly_selected", which corresponds to click and drag mouse events.
+# "plotly_selecting", which corresponds to click and drag mouse events.
 # Plotly provides two types of drag modes that will trigger a "plotly_selected"
 # event: "lasso" and "select". You can change the dragmode interactively via 
 # the modebar and/or set the default dragmode via `layout()`.