Add a class and print method for built objects

Author: cpsievert

NAMESPACE

@@ -12,6 +12,7 @@ S3method(geom2trace,GeomText)
 S3method(geom2trace,GeomTile)
 S3method(geom2trace,default)
 S3method(print,figure)
+S3method(print,plotly_built)
 S3method(print,plotly_hash)
 S3method(to_basic,GeomAbline)
 S3method(to_basic,GeomArea)
@@ -49,6 +50,7 @@ export(get_figure)
 export(gg2list)
 export(ggplotly)
 export(knit_print.figure)
+export(knit_print.plotly_built)
 export(knit_print.plotly_hash)
 export(last_plot)
 export(layout)

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

@@ -10,6 +10,13 @@ print.plotly_hash <- function(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
@@ -21,6 +28,13 @@ knit_print.plotly_hash <- function(x, options, ...) {
   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 +48,22 @@ knit_print.plotly_hash <- 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