First stab at implementing images endpoint

Author: cpsievert

NAMESPACE

@@ -20,6 +20,7 @@ export(paramORdefault)
 export(plot_ly)
 export(plotly)
 export(plotlyOutput)
+export(plotly_IMAGE)
 export(plotly_POST)
 export(plotly_build)
 export(plotly_empty)

R/plotly.R

@@ -316,8 +316,26 @@ plotly_build <- function(l = last_plot()) {
   }
   # search for keyword args in traces and place them at the top level
   kwargs <- lapply(x$data, function(z) z[get_kwargs()])
-  if (length(kwargs) == 1) kwargs <- c(kwargs, kwargs)
-  x <- c(x, Reduce(modifyList, kwargs))
+  # later keywords args take precedence
+  kwargs <- Reduce(modifyList, kwargs)
+  # empty keyword arguments can cause problems
+  kwargs <- kwargs[sapply(kwargs, length) > 0]
+  # filename & fileopt are keyword arguments required by the API
+  if (!is.null(x$url) || !is.null(kwargs$filename)) 
+    kwargs$fileopt <- "overwrite"
+  kwargs$fileopt <- kwargs$fileopt %||% "new"
+  # try our damndest to assign a sensible filename
+  if (is.null(kwargs$filename)) {
+    kwargs$filename <- 
+      as.character(kwargs$layout$title) %||% 
+      paste(
+        c(kwargs$layout$xaxis$title, 
+          kwargs$layout$yaxis$title, 
+          kwargs$layout$zaxis$title), 
+        collapse = " vs. "
+      ) %||%
+      "plot from api" 
+  }
   # traces shouldn't have any names
   x$data <- setNames(x$data, NULL)
   # add plotly class mainly for printing method

R/plotly_IMAGE.R

@@ -0,0 +1,36 @@
+#' Create/Modify plotly images
+#'
+#' The images endpoint turn a plot (which may be given in multiple forms) 
+#' into an image of the desired format.
+#'
+#' @param x either a plotly object or a list.
+#' @param width Image width in pixels
+#' @param height Image height in pixels
+#' @param format The desired image format 'png', 'jpeg', 'svg', 'pdf', 'eps', or 'webp'
+#' @param scale Both png and jpeg formats will be scaled beyond the specified width and height by this number.
+#' @param encoded A boolean flag for base64 encoding of bytes
+#' @export
+#' @examples
+#' 
+#' plotly_IMAGE(plot_ly(x = 1:10))
+#' 
+#' 
+
+plotly_IMAGE <- function(x, width = 1000, height = 500, format = "png", 
+                         scale = 4, encoded = FALSE) {
+  x <- plotly_build(x)
+  
+  bod <- list(
+    figure = to_JSON(x[c("data", "layout")]),
+    width = width,
+    height = height,
+    format = format,
+    scale = scale,
+    encoded = encoded
+  )
+  
+  base_url <- file.path(get_domain("v2"), "images")
+  resp <- httr::POST(base_url, plotly_headers("v2"), body = bod)
+  con <- process(struct(resp, "image"))
+  
+}

R/plotly_POST.R

@@ -28,25 +28,6 @@
 
 plotly_POST <- function(x) {
   x <- plotly_build(x)
-  # empty keyword arguments can cause problems
-  kwargs <- x[get_kwargs()]
-  kwargs <- kwargs[sapply(kwargs, length) > 0]
-
-  # filename & fileopt are keyword arguments required by the API
-  # (note they can also be specified by the user)
-  if (!is.null(x$url) || !is.null(kwargs$filename)) kwargs$fileopt <- "overwrite"
-  if (is.null(kwargs$filename)) {
-    kwargs$filename <- 
-      as.character(kwargs$layout$title) %||% 
-      paste(
-        c(kwargs$layout$xaxis$title, 
-          kwargs$layout$yaxis$title, 
-          kwargs$layout$zaxis$title), 
-        collapse = " vs. "
-      ) %||%
-      "plot from api" 
-  }
-  if (is.null(kwargs$fileopt)) kwargs$fileopt <- "new"
   # construct body of message to plotly server
   bod <- list(
     un = verify("username"),
@@ -55,7 +36,7 @@ plotly_POST <- function(x) {
     platform = "R",
     version = as.character(packageVersion("plotly")),
     args = to_JSON(x$data),
-    kwargs = to_JSON(kwargs)
+    kwargs = to_JSON(x[get_kwargs()])
   )
   base_url <- file.path(get_domain(), "clientresp")
   resp <- httr::POST(base_url, body = bod)

R/process.R

@@ -15,6 +15,12 @@ process.clientresp <- function(resp) {
   con
 }
 
+process.image <- function(resp) {
+  httr::stop_for_status(resp)
+  browser()
+  con <- from_JSON(httr::content(resp, as = "text"))
+}
+
 process.figure <- function(resp) {
   httr::stop_for_status(resp)
   con <- from_JSON(content(resp, as = "text"))

R/utils.R

@@ -141,10 +141,11 @@ struct <- function(x, y, ...) {
 get_domain <- function(type = "main") {
   if (type == "stream") {
     Sys.getenv("plotly_streaming_domain", "http://stream.plot.ly")
+  } else if (type == "v2") {
+    Sys.getenv("plotly_domain", "https://api.plot.ly/v2/")
   } else {
     Sys.getenv("plotly_domain", "https://plot.ly")
   }
-  
 }
 
 # plotly's special keyword arguments in POST body
@@ -153,12 +154,24 @@ get_kwargs <- function() {
 }
 
 # POST header fields
-plotly_headers <- function() {
-  httr::add_headers(.headers = c(
-    "plotly-username" = verify("username"),
-    "plotly-apikey" = verify("api_key"),
-    "plotly-version" = as.character(packageVersion("plotly")),
-    "plotly-platform" = "R"))
+plotly_headers <- function(type = "main") {
+  usr <- verify("username")
+  key <- verify("api_key")
+  h <- if (type == "v2") {
+    c(
+      "Plotly-Username" = base64enc::base64encode(charToRaw(usr)),
+      "Plotly-Apikey" = base64enc::base64encode(charToRaw(key)),
+      "Plotly-Client-Platform" = paste("R", as.character(packageVersion("plotly")))
+    )
+  } else {
+    c(
+      "plotly-username" = usr,
+      "plotly-apikey" = key,
+      "plotly-version" = as.character(packageVersion("plotly")),
+      "plotly-platform" = "R"
+    )
+  }
+  httr::add_headers(.headers = h)
 }
 
 # try to write environment variables to an .Rprofile

man/plotly_IMAGE.Rd

@@ -0,0 +1,30 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/plotly_IMAGE.R
+\name{plotly_IMAGE}
+\alias{plotly_IMAGE}
+\title{Create/Modify plotly images}
+\usage{
+plotly_IMAGE(x, width = 1000, height = 500, format = "png", scale = 4,
+  encoded = FALSE)
+}
+\arguments{
+\item{x}{either a plotly object or a list.}
+
+\item{width}{Image width in pixels}
+
+\item{height}{Image height in pixels}
+
+\item{format}{The desired image format 'png', 'jpeg', 'svg', 'pdf', 'eps', or 'webp'}
+
+\item{scale}{Both png and jpeg formats will be scaled beyond the specified width and height by this number.}
+
+\item{encoded}{A boolean flag for base64 encoding of bytes}
+}
+\description{
+The images endpoint turn a plot (which may be given in multiple forms)
+into an image of the desired format.
+}
+\examples{
+plotly_IMAGE(qplot(1:10))
+}
+