make plotly_build a generic function

Author: cpsievert

NAMESPACE

@@ -13,6 +13,9 @@ S3method(geom2trace,GeomTile)
 S3method(geom2trace,default)
 S3method(ggplotly,ggmatrix)
 S3method(ggplotly,ggplot)
+S3method(plotly_build,gg)
+S3method(plotly_build,plotly_built)
+S3method(plotly_build,plotly_hash)
 S3method(print,figure)
 S3method(print,plotly_built)
 S3method(print,plotly_hash)

R/ggplotly.R

@@ -448,7 +448,7 @@ gg2list <- function(p, width = NULL, height = NULL, tooltip = "all", source = "A
               gglayout$annotations,
               make_label(
                 faced(axisTitleText, axisTitle$face), x, y, el = axisTitle,
-                xanchor = "center", yanchor = "middle"
+                xanchor = "center", yanchor = "middle", annotationType = "axis"
               )
             )
           }

R/plotly.R

@@ -221,21 +221,46 @@ style <- function(p = last_plot(), ..., traces = 1, evaluate = FALSE) {
   hash_plot(data, p)
 }
 
-#' Build a plotly object before viewing it
+#' Create a 'plotly_built' object
 #' 
-#' For convenience and efficiency purposes, plotly objects are subject to lazy 
-#' evaluation. That is, the actual content behind a plotly object is not 
-#' created until it is absolutely necessary. In some instances, you may want 
-#' to perform this evaluation yourself, and work directly with the resulting 
-#' list.
+#' This generic function creates the list object sent to plotly.js
+#' for rendering. Using this function can be useful for overriding defaults
+#' provided by \code{ggplotly}/\code{plot_ly} or for debugging rendering
+#' errors.
 #' 
-#' @param l a ggplot object, or a plotly object, or a list.
+#' @param l a ggplot object, or a plotly_hash object, or a list.
 #' @export
+#' @examples
+#' 
+#' p <- plot_ly()
+#' # data frame
+#' str(p)
+#' # the actual list of options sent to plotly.js
+#' str(plotly_build(p))
+#' 
+#' p <- qplot(data = mtcars, wt, mpg, geom = c("point", "smooth"))
+#' l <- plotly_build(p)
+#' # turn off hoverinfo for the smooth (but keep it for the points)
+#' l$data[[2]]$hoverinfo <- "none"
+#' l$data[[3]]$hoverinfo <- "none"
+#' l
+#' 
 plotly_build <- function(l = last_plot()) {
-  # ggplot objects (including ggmatrix) don't need any special type of handling
-  if (inherits(l, "gg")) {
-    return(structure(get_plot(ggplotly(l)), class = "plotly"))
-  }
+  UseMethod("plotly_build")
+}
+
+#' @export
+plotly_build.plotly_built <- function(l = last_plot()) {
+  l
+}
+
+#' @export
+plotly_build.gg <- function(l = last_plot()) {
+  structure(get_plot(ggplotly(l)), class = "plotly_built")
+}
+
+#' @export
+plotly_build.plotly_hash <- function(l = last_plot()) {
   l <- get_plot(l)
   # assume unnamed list elements are data/traces
   nms <- names(l)