R/output_save.R

In rbokeh: R Interface for Bokeh

#' Make a static png file for an htmlwidget
#'
#' @param p htmlwidget object
#' @param file where to save png file
#' @param timeout plot render timeout in milliseconds (see details)
#' @details This uses phantomjs (\url{https://phantomjs.org}) to render your htmlwidget in a headless browser and take a screenshot of it, creating a static output.  This assumes that phantomjs has been installed on your machine and is available as a system call.  For plots that take longer to load and render, you may need to increase the value of \code{timeout}.  Note that this function is experimental.
#' @examples
#' \dontrun{
#' path <- tempfile(fileext = ".png")
#' figure(tools = NULL) %>%
#'   ly_points(1:10) %>%
#'   widget2png(path)
#' }
#' @export
widget2png <- function(p, file, timeout = 500) {
  phantom <- find_phantom()
  file <- path.expand(file)

  if (phantom == "") {
    message(
      "** phantomjs dependency could not be found - static plot cannot be generated ",
      "(run phantom_install() for details)")
  } else {
    res <- try({
      ff <- tempfile(fileext = ".html")
      ffjs <- tempfile(fileext = ".js")

      if (inherits(p, "rbokeh")) {
        # don't want any padding
        p$sizingPolicy$padding <- 0 # nolint
        suppressMessages(rbokeh2html(p, file = ff))
      } else if (inherits(p, "htmlwidget")) {
        suppressMessages(htmlwidgets::saveWidget(p, file = ff))
      }

      js <- paste0("var page = require('webpage').create();
page.open('file://", ff, "', function() {
  // $('html').style.zoom = 2;
  window.setTimeout(function () {
    page.render('", file, "');
    phantom.exit();
  }, ", timeout, ");
});")
      cat(js, file = ffjs)
      system2(phantom, ffjs, stdout = TRUE, stderr = TRUE)
    })
    if (inherits(res, "try-error"))
      message("** could not create static plot...")

    # system(paste("open ", ffjs))
    # system(paste("open ", dirname(ffjs)))
  }
  invisible(res)
}

#' Instructions for installing phantomjs
#' @export
phantom_install <- function() {
  message(
    "Please visit this page to install phantomjs on your system: ",
    "https://phantomjs.org/download.html")
}

# similar to webshot
find_phantom <- function() {
  phantom <- Sys.which("phantomjs")
  if (Sys.which("phantomjs") == "") {
    if (identical(.Platform$OS.type, "windows")) {
      phantom <- Sys.which(file.path(Sys.getenv("APPDATA"), "npm", "phantomjs.cmd"))
    }
  }
  phantom
}