Merge pull request #562 from ropensci/bug

Disambiguate classnames

Author: cpsievert

DESCRIPTION

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

NAMESPACE

@@ -12,7 +12,8 @@ S3method(geom2trace,GeomText)
 S3method(geom2trace,GeomTile)
 S3method(geom2trace,default)
 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)
@@ -49,7 +50,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,12 @@
+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:

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/plotly.R

@@ -331,7 +331,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/utils.R

@@ -36,7 +36,7 @@ hash_plot <- function(df, p) {
   assign(hash, p, envir = plotlyEnv)
   attr(df, "plotly_hash") <- hash
   # add plotly class mainly for printing method
-  class(df) <- unique(c("plotly", class(df)))
+  class(df) <- unique(c("plotly_hash", class(df)))
   # return a data frame to be compatible with things like dplyr
   df
 }

inst/htmlwidgets/lib/plotlyjs/plotly-latest.min.js

@@ -1,6 +1,6 @@
 dependencies:
   - name: plotlyjs
-    version: 1.9.0
+    version: 1.10.0
     src: "htmlwidgets/lib/plotlyjs"
     script: plotly-latest.min.js
     stylesheet: plotly-htmlwidgets.css