Merge pull request #742 from ropensci/feature/sharing

Feature/sharing

Author: cpsievert

NEWS.md

@@ -3,6 +3,7 @@
 ## CHANGES
 
 * Now requires  a version of __ggplot2__ higher than 2.1.0 because the new ggproto faceting infrastructure introduced breaking changes.
+* A book icon is added to the mode bar, by default, which links to the plotly book. If you want to remove this icon from a plot `p`, do `config(p, modeBarButtonsToRemove = "Collaborate")`
 
 ## BUG FIXES
 

R/layout.R

@@ -60,10 +60,26 @@ rangeslider <- function(p, ...) {
 #' @author Carson Sievert
 #' @export
 #' @examples \dontrun{
-#' config(plot_ly(), displaylogo = FALSE, modeBarButtonsToRemove = list('sendDataToCloud'))
+#' config(plot_ly(), displaylogo = FALSE)
 #' }
 
 config <- function(p, ...) {
-  p$x$config <- modify_list(p$x$config, list(...))
+  attrs <- list(...)
+  # accumulate these attributes
+  p$x$config[["modeBarButtonsToRemove"]] <- c(
+    p$x$config[["modeBarButtonsToRemove"]] %||% 'sendDataToCloud',
+    attrs[["modeBarButtonsToRemove"]]
+  )
+  # include the plotly book collaboration link?
+  removeCollab <- "Collaborate" %in% p$x$config[["modeBarButtonsToRemove"]]
+  if (length(p$x$config[["modeBarButtonsToRemove"]])) {
+    p$x$config[["modeBarButtonsToRemove"]] <- list(p$x$config[["modeBarButtonsToRemove"]])
+  }
+  p$x$config[["modeBarButtonsToAdd"]] <- c(
+    if (!removeCollab) list(sharingButton()),
+    attrs[["modeBarButtonsToAdd"]]
+  )
+  attrs <- attrs[grepl("modeBarButtonsTo", names(attrs))]
+  p$x$config <- modify_list(p$x$config, attrs)
   p
 }

R/plotly.R

@@ -144,9 +144,6 @@ plot_ly <- function(data = data.frame(), ..., type = NULL,
         # sane margin defaults (mainly for RStudio)
         margin = list(b = 40, l = 60, t = 25, r = 10)
     ),
-    config = list(modeBarButtonsToRemove = I("sendDataToCloud")),
-    base_url = get_domain(),
-    # TODO: make this trace specific when we merge with crosstalk branch
     source = source
   )
 

R/plotly_build.R

@@ -323,6 +323,9 @@ plotly_build.plotly <- function(p) {
   p <- verify_hovermode(p)
   # try to convert to webgl if toWebGl was used
   p <- verify_webgl(p)
+  # populate R's non-default config
+  p <- config(p)
+  p$x$base_url <- get_domain()
   p
 }
 

R/sharingButton.R

@@ -0,0 +1,23 @@
+sharingButton <- function() {
+  url <- 'https://cpsievert.github.io/plotly_book/plot-ly-for-collaboration.html'
+  list(
+    name = "Collaborate",
+    icon = list(
+      width = 1800,
+      ascent = 1500,
+      descent = -150,
+      path = sharingPath
+    ),
+    click = htmlwidgets::JS(sprintf(
+      "function(gd) { 
+        // is this being viewed in RStudio?
+        if (location.search == '?viewer_pane=1') {
+          alert('To learn about plotly for collaboration, visit:\\n %s');
+        } else {
+          window.open('%s', '_blank');
+        }
+      }", url, url))
+  )
+}
+
+sharingPath <- 'M1703 478q40 57 18 129l-275 906q-19 64-76.5 107.5t-122.5 43.5h-923q-77 0-148.5-53.5t-99.5-131.5q-24-67-2-127 0-4 3-27t4-37q1-8-3-21.5t-3-19.5q2-11 8-21t16.5-23.5 16.5-23.5q23-38 45-91.5t30-91.5q3-10 .5-30t-.5-28q3-11 17-28t17-23q21-36 42-92t25-90q1-9-2.5-32t.5-28q4-13 22-30.5t22-22.5q19-26 42.5-84.5t27.5-96.5q1-8-3-25.5t-2-26.5q2-8 9-18t18-23 17-21q8-12 16.5-30.5t15-35 16-36 19.5-32 26.5-23.5 36-11.5 47.5 5.5l-1 3q38-9 51-9h761q74 0 114 56t18 130l-274 906q-36 119-71.5 153.5t-128.5 34.5h-869q-27 0-38 15-11 16-1 43 24 70 144 70h923q29 0 56-15.5t35-41.5l300-987q7-22 5-57 38 15 59 43zm-1064 2q-4 13 2 22.5t20 9.5h608q13 0 25.5-9.5t16.5-22.5l21-64q4-13-2-22.5t-20-9.5h-608q-13 0-25.5 9.5t-16.5 22.5zm-83 256q-4 13 2 22.5t20 9.5h608q13 0 25.5-9.5t16.5-22.5l21-64q4-13-2-22.5t-20-9.5h-608q-13 0-25.5 9.5t-16.5 22.5z'