Merge pull request #371 from ropensci/feature/asWidget

export as.widget() for convenience sake. See #294

Author: cpsievert

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: plotly
 Title: Create Interactive Web Graphics via Plotly's JavaScript Graphing Library
-Version: 2.0.18
+Version: 2.0.19
 Authors@R: c(person("Carson", "Sievert", role = c("aut", "cre"),
     email = "[email protected]"),
     person("Chris", "Parmer", role = c("aut", "cph"),

NAMESPACE

@@ -4,6 +4,7 @@ S3method(print,figure)
 S3method(print,plotly)
 export("%>%")
 export(add_trace)
+export(as.widget)
 export(config)
 export(embed_notebook)
 export(get_figure)

NEWS

@@ -1,3 +1,7 @@
+2.0.19 -- 23 Dec 2015
+
+Added as.widget() function for conveniency in converting plotly object to htmlwidget objects. See #294.
+
 2.0.18 -- 22 Dec 2015
 
 Fix #365

R/print.R

@@ -1,33 +1,37 @@
 #' Print a plotly object
 #' 
 #' @param x a plotly object
-#' @param ... additional arguments (currently ignored)
+#' @param ... additional arguments
 #' @export
 #' @importFrom htmlwidgets createWidget
 #' @importFrom htmlwidgets sizingPolicy
 print.plotly <- function(x, ...) {
-  w <- toWidget(x)
-  get("print.htmlwidget", envir = asNamespace("htmlwidgets"))(w)
+  if (!inherits(x, "htmlwidget")) x <- as.widget(x)
+  get("print.htmlwidget", envir = asNamespace("htmlwidgets"))(w, ...)
 }
 
 #' Print a plotly object in a knitr doc
 #' 
 #' @param x a plotly object
 #' @param options knitr options.
-#' @param ... additional arguments (currently ignored)
+#' @param ... additional arguments
 #' @export
 knit_print.plotly <- function(x, options, ...) {
-  w <- toWidget(x)
-  get("knit_print.htmlwidget", envir = asNamespace("htmlwidgets"))(w, options = options)
+  if (!inherits(x, "htmlwidget")) x <- as.widget(x)
+  get("knit_print.htmlwidget", envir = asNamespace("htmlwidgets"))(w, options = options, ...)
 }
 
 #' Convert a plotly object to an htmlwidget object
 #' 
-#' Users shouldn't need to use this function. It's exported for internal reasons.
-#' 
 #' @param x a plotly object.
+#' @param ... other options passed onto \code{htmlwidgets::createWidget}
+#' @export
+#' @examples \dontrun{
+#' p <- plot_ly(mtcars, x = mpg, y = disp, mode = "markers")
+#' htmlwidgets::saveWidget(as.widget(p), "index.html")
+#' }
 #' 
-toWidget <- function(x) {
+as.widget <- function(x, ...) {
   p <- plotly_build(x)
   # set some margin defaults if none are provided
   p$layout$margin <- modifyList(
@@ -41,13 +45,17 @@ toWidget <- function(x) {
     x = p,
     width = p$width,
     height = p$height,
-    htmlwidgets::sizingPolicy(
+    sizingPolicy = htmlwidgets::sizingPolicy(
       padding = 5, 
       browser.fill = TRUE
-    )
+    ),
+    ...
   )
 }
 
+# for legacy reasons
+toWidget <- as.widget
+
 #' Print a plotly figure object
 #' 
 #' @param x a plotly figure object

R/shiny.R

@@ -26,6 +26,6 @@ plotlyOutput <- function(outputId, width = "100%", height = "400px") {
 renderPlotly <- function(expr, env = parent.frame(), quoted = FALSE) {
   if (!quoted) { expr <- substitute(expr) } # force quoted
   # https://github.com/ramnathv/htmlwidgets/issues/166#issuecomment-153000306
-  expr <- as.call(list(call(":::", quote("plotly"), quote("toWidget")), expr))
+  expr <- call("as.widget", expr)
   shinyRenderWidget(expr, plotlyOutput, env, quoted = TRUE)
 }