Merge branch 'master' of github.com:ropensci/plotly into fix/subplot

Author: cpsievert

CONTRIBUTING.md

@@ -23,7 +23,13 @@ Sys.setenv('TRAVIS_COMMIT' = substr(system('git rev-parse HEAD', intern = T), 1,
 devtools::load_all(); source('tests/testthat.R', chdir = TRUE)
 ```
 
-You can also build a ggplot2/plotly comparison table:
+You can also build a ggplot2/plotly comparison table. To do so, you'll first need to clone the [plotly-test-table](https://github.com/cpsievert/plotly-test-table) repo.
+
+```shell
+$ git clone https://github.com/cpsievert/plotly-test-table.git ../plotly-test-table
+```
+
+Then, from R:
 
 ```r
 Sys.setenv('PLOTLY_TABLE' = 'TRUE')

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: plotly
 Title: Create Interactive Web Graphics via 'plotly.js'
-Version: 3.4.15
+Version: 3.5.1
 Authors@R: c(person("Carson", "Sievert", role = c("aut", "cre"),
     email = "[email protected]"),
     person("Chris", "Parmer", role = c("aut", "cph"),

NAMESPACE

@@ -14,7 +14,8 @@ S3method(geom2trace,default)
 S3method(ggplotly,ggmatrix)
 S3method(ggplotly,ggplot)
 S3method(print,figure)
-S3method(print,plotly)
+S3method(print,plotly_built)
+S3method(print,plotly_hash)
 S3method(to_basic,GeomAbline)
 S3method(to_basic,GeomArea)
 S3method(to_basic,GeomBoxplot)
@@ -51,7 +52,8 @@ export(get_figure)
 export(gg2list)
 export(ggplotly)
 export(knit_print.figure)
-export(knit_print.plotly)
+export(knit_print.plotly_built)
+export(knit_print.plotly_hash)
 export(last_plot)
 export(layout)
 export(offline)

NEWS

@@ -1,3 +1,22 @@
+3.6.0 -- 26 Apr 2016
+
+CHANGES:
+
+Upgrade to plotlyjs v1.10.0 -- https://github.com/plotly/plotly.js/releases/tag/v1.9.0
+
+Distinguish between "built" (plotly_built) and "non-built" (plotly_hash) plotly objects. See #562
+
+
+3.5.0 -- 19 Apr 2016
+
+NEW FEATURES:
+
+The toRGB() function will now respect alpha channels in hex color codes and can recursively apply alpha. 
+
+CHANGES:
+
+The toRGB() function will always output color codes with an alpha channel (e.g. toRGB('black') is now 'rgba(0,0,0,1)' instead of 'rgb(0,0,0)')
+
 3.4.15 -- 18 Apr 2016
 
 BUGFIX:

R/ggplotly.R

@@ -300,8 +300,6 @@ gg2list <- function(p, width = NULL, height = NULL, tooltip = "all", source = "A
       theme[["strip.text.x"]] %||% theme[["strip.text"]],
       "npc", "height"
     )
-    # TODO: why does stripSize need to be inflated here?
-    panelMarginY <- panelMarginY + 1.5 * stripSize
     # space for ticks/text in free scales
     if (p$facet$free$x) {
       axisTicksX <- unitConvert(

R/imports.R

@@ -7,4 +7,5 @@
 #' @importFrom viridis viridis
 #' @importFrom jsonlite toJSON fromJSON
 #' @importFrom httr GET POST PATCH content config add_headers stop_for_status
+#' @importFrom htmlwidgets createWidget sizingPolicy
 NULL

R/layers2traces.R

@@ -460,7 +460,10 @@ geom2trace.GeomPolygon <- function(data, params, p) {
     line = list(
       # NOTE: line attributes must be constant on a polygon
       width = aes2plotly(data, params, "size"),
-      color = aes2plotly(data, params, "colour"),
+      color = toRGB(
+        aes2plotly(data, params, "colour"),
+        aes2plotly(data, params, "alpha")
+      ),
       dash = aes2plotly(data, params, "linetype")
     ),
     fill = "tozerox",

R/plotly.R

@@ -332,7 +332,7 @@ plotly_build <- function(l = last_plot()) {
       x$layout$hovermode <- x$layout$hovermode %||% "closest"
   }
   # add plotly class mainly for printing method
-  structure(x, class = unique("plotly", class(x)))
+  structure(x, class = unique("plotly_built", class(x)))
 }
 
 # returns a _list of traces_.

R/print.R

@@ -3,24 +3,36 @@
 #' @param x a plotly object
 #' @param ... additional arguments
 #' @export
-#' @importFrom htmlwidgets createWidget
-#' @importFrom htmlwidgets sizingPolicy
-print.plotly <- function(x, ...) {
-  if (!inherits(x, "htmlwidget")) x <- as.widget(x)
-  get("print.htmlwidget", envir = asNamespace("htmlwidgets"))(x, ...)
+print.plotly_hash <- function(x, ...) {
+  x <- as.widget(x)
+  print(x, ...)
 }
 
+#' Print a 'built' plotly object
+#' 
+#' @param x a plotly object
+#' @param ... additional arguments
+#' @export
+print.plotly_built <- print.plotly_hash
+
 #' Print a plotly object in a knitr doc
 #' 
 #' @param x a plotly object
 #' @param options knitr options.
 #' @param ... additional arguments
 #' @export
-knit_print.plotly <- function(x, options, ...) {
-  if (!inherits(x, "htmlwidget")) x <- as.widget(x)
-  get("knit_print.htmlwidget", envir = asNamespace("htmlwidgets"))(x, options = options, ...)
+knit_print.plotly_hash <- function(x, options, ...) {
+  x <- as.widget(x)
+  knitr::knit_print(x, options, ...)
 }
 
+#' Print a 'built' plotly object in a knitr doc
+#' 
+#' @param x a plotly object
+#' @param ... additional arguments
+#' @export
+knit_print.plotly_built <- knit_print.plotly_hash
+
 #' Convert a plotly object to an htmlwidget object
 #' 
 #' @param x a plotly object.
@@ -34,22 +46,22 @@ knit_print.plotly <- function(x, options, ...) {
 
 as.widget <- function(x, ...) {
   if (inherits(x, "htmlwidget")) return(x)
-  p <- plotly_build(x)
+  if (!inherits(x, "plotly_built")) x <- plotly_build(x)
   # set some margin defaults if none are provided
-  p$layout$margin <- modifyList(
+  x$layout$margin <- modifyList(
     list(b = 40, l = 60, t = 25, r = 10),
-    p$layout$margin %||% list()
+    x$layout$margin %||% list()
   )
-  p$config$modeBarButtonsToRemove <- 
-    i(p$config$modeBarButtonsToRemove %||% "sendDataToCloud")
-  p$base_url <- get_domain()
+  x$config$modeBarButtonsToRemove <- 
+    i(x$config$modeBarButtonsToRemove %||% "sendDataToCloud")
+  x$base_url <- get_domain()
   # customize the JSON serializer (for htmlwidgets)
-  attr(p, 'TOJSON_FUNC') <- to_JSON
+  attr(x, 'TOJSON_FUNC') <- to_JSON
   htmlwidgets::createWidget(
     name = "plotly",
-    x = p,
-    width = p$width,
-    height = p$height,
+    x = x,
+    width = x$width,
+    height = x$height,
     sizingPolicy = htmlwidgets::sizingPolicy(
       padding = 5, 
       browser.fill = TRUE

R/toRGB.R

@@ -5,27 +5,36 @@
 #' @export
 toRGB <- function(x, alpha = 1) {
   if (is.null(x)) return(x)
-  # as of ggplot2 version 1.1, an NA alpha is treated as though it's 1
-  alpha[is.na(alpha)] <- 1
-  # if we've already made the proper conversion, return the input
-  if (inherits(x, "plotly_rgba")) return(x)
-  if (inherits(x, "plotly_rgb")) {
-    if (all(alpha == 1)) return(x)
-    # all alpha channel
-    x <- sub("^rgb", "rgba", sub("\\)", paste0(",", alpha, ")"), x))
-    return(prefix_class(x, "plotly_rgba"))
+  if (any(x %in% "transparent")) return(x)
+  # add alpha to already converted "rgb(x,y,z)" codes
+  idx <- grepl("^rgba\\(", x) & alpha <= 1 & 0 <= alpha
+  if (any(idx)) {
+    x[idx] <- rgb2hex(x[idx])
   }
   # for some reason ggplot2 has "NA" in some place (instead of NA)
   if (is.character(x)) {
     x[x == "NA"] <- NA
   }
-  has_alpha <- all(0 <= alpha & alpha < 1)
-  rgb_matrix <- col2rgb(x, alpha = has_alpha)
-  # rescale alpha 
-  # TODO: what if x already has an alpha channel???
-  if (has_alpha) rgb_matrix["alpha", ] <- alpha
-  container <- if (has_alpha) "rgba(%s)" else "rgb(%s)"
-  rgb_a <- sprintf(container, apply(rgb_matrix, 2, paste, collapse = ","))
-  rgb_a[is.na(x)] <- "transparent"
-  structure(rgb_a, class = if (has_alpha) "plotly_rgba" else "plotly_rgb")
+  # as of ggplot2 version 1.1, an NA alpha is treated as though it's 1
+  alpha[is.na(alpha)] <- 1
+  rgb_matrix <- grDevices::col2rgb(x, alpha = TRUE)
+  # multiply the existing alpha with specified alpha (both on 0-1 scale)
+  rgb_matrix["alpha", ] <- alpha * scales::rescale(
+    rgb_matrix["alpha", ], from = c(0, 255)
+  )
+  rgb_matrix["alpha", ] <- round(rgb_matrix["alpha", ], 4)
+  rgba <- sprintf("rgba(%s)", apply(rgb_matrix, 2, paste, collapse = ","))
+  rgba[is.na(x)] <- "transparent"
+  rgba
+}
+
+# take a 'plotly color' and produce a hex code
+rgb2hex <- function(string = "rgba(255,255,255,1)") {
+  vals <- sub("rgba\\(", "", sub("\\)", "", string))
+  valz <- strsplit(vals, ",")
+  sapply(valz, function(x) {
+    x <- setNames(as.numeric(x), c("red", "green", "blue", "alpha"))
+    x[["alpha"]] <- x[["alpha"]] * 255
+    do.call(grDevices::rgb, c(x, list(maxColorValue = 255)))
+  })
 }