Merge branch 'master' into setProps

Author: cpsievert

DESCRIPTION

@@ -33,7 +33,7 @@ Imports:
     viridisLite,
     base64enc,
     htmltools,
-    htmlwidgets (>= 0.9),
+    htmlwidgets (>= 1.2),
     tidyr,
     hexbin,
     RColorBrewer,

NEWS.md

@@ -2,9 +2,10 @@
 
 ## NEW FEATURES & IMPROVEMENTS
 
-* Upgraded to plotly.js v1.35.2. A _huge_ amount of features and improvements have been made since v1.29.2 (i.e., the version included in the last CRAN release of the R package - v4.7.1). Highlights include a complete re-write of `scattergl` to make it nearly feature complete with `scatter`, localization of text rendering (i.e., international translations), and two new trace types (`violin` & `table`). Read more about the v1.32.0 release [here](https://codeburst.io/notes-from-the-latest-plotly-js-release-b035a5b43e21) and the complete list of changes [here](https://github.com/plotly/plotly.js/releases).
+* Upgraded to plotly.js v1.38.1. A _huge_ amount of features and improvements have been made since v1.29.2 (i.e., the version included in the last CRAN release of the R package - v4.7.1). Highlights include a complete re-write of `scattergl` to make it nearly feature complete with `scatter`, localization of text rendering (i.e., international translations), and two new trace types (`violin` & `table`). Read more about the v1.32.0 release [here](https://codeburst.io/notes-from-the-latest-plotly-js-release-b035a5b43e21) and the complete list of changes [here](https://github.com/plotly/plotly.js/releases).
 * Support for **sf** (simple feature) data structures was added to `plot_ly()`, `plot_mapbox()`, and `plot_geo()` (via the new `add_sf()` function). See [this blog post](https://blog.cpsievert.me/2018/03/30/visualizing-geo-spatial-data-with-sf-and-plotly) for an overview.
 * New "special arguments" `stroke`, `strokes`, `alpha_stroke`, `span`, and `spans` were added for easier control over the stroke (i.e., outline) appearance of various (filled) graphical marks. For an overview, see the **sf** blog post linked to in the bullet point above and the new package demos (list all demos with `demo(package = "plotly")`).
+* One may now inform `ggplotly()` about the relevant **shiny** output size via `session$clientData`. This ensures `ggplotly()` sizing is closer to **ggplot2** sizing, even on window resize. For an example, run `plotly_example("shiny", "ggplotly_sizing")`.
 * The selection (i.e., linked-brushing) mode can now switch from 'transient' to 'persistent' by holding the 'shift' key. It's still possible to _force_ persistent selection by setting `persistent = TRUE` in `highlight()`, but `persistent = FALSE` (the default) is now recommended since it allows one to switch between [persistent/transient selection](https://plotly-book.cpsievert.me/linking-views-without-shiny.html#transient-versus-persistent-selection) in the browser, rather than at the command line.
 * Instead of an error, `ggplotly(NULL, "message")` and `plotly_build(NULL, "message")` now returns `htmltools::div("message")`, making it easier to relay messages in shiny when data isn't yet ready to plot (see #1116)
 * The `animation_button()` function gains a `label` argument, making it easier to control the label of an animation button generated through the `frame` API (see #1205).
@@ -13,17 +14,20 @@
 
 * The `color` argument now maps to `fillcolor`, making it much easier to use polygon fills to encode data values (e.g., choropleth maps). For backwards-compatibilty reasons, when `color` maps to `fillcolor`, `alpha` defaults to 0.5 (instead of 1). For an example, `plot_mapbox(mn_res, color = ~INDRESNAME)` or `plot_mapbox(mn_res, split = ~INDRESNAME, color = ~AREA, showlegend = FALSE, stroke = I("black"))`.
 * The `color` argument no longer automatically add `"markers"` to the `mode` attribute for scatter/scattergl trace types. Those who wish to have the old behavior back, should add `"markers"` to the `mode` explicity (e.g., change `plot_ly(economics, x = ~pce, y = ~pop, color = ~as.numeric(date), mode = "lines")` to `plot_ly(economics, x = ~pce, y = ~pop, color = ~as.numeric(date), mode = "lines+markers")`).
-* The `size` argument now informs a default [error_[x/y].width](https://plot.ly/r/reference/#scatter-error_x-width) (and `span` informs [error_[x/y].thickness](https://plot.ly/r/reference/#scatter-error_x-thickness)). Note you can override the default by specifying directly (e.g. `plot_ly(x = 1:10, y = 1:10, size = I(10), error_x = list(value = 5, width = 0))`)
+* The `size` argument now informs a default [error_[x/y].width](https://plot.ly/r/reference/#scatter-error_x-width) (and `span` informs [error_[x/y].thickness](https://plot.ly/r/reference/#scatter-error_x-thickness)). Note you can override the default by specifying directly (e.g. `plot_ly(x = 1:10, y = 1:10, size = I(10), error_x = list(value = 5, width = 0))`).
 * `layout.showlegend` now defaults to `TRUE` for a *single* pie trace. This is a more sensible default and matches pure plotly.js behavior.
 * The `elementId` field is no longer populated, which fixes the "Ignoring explicitly provided widget ID" warning in shiny applications (see #985).
 
 ## BUG FIXES
 
+
+* The default `height`/`width` that `ggplotly()` assumes is now more consistently correct in various context, but it also now requires access to one of the following devices: `Cairo::Cairo()`, `png()`, or `jpg()`. 
+* In RStudio, `ggplotly()` was ignoring a specified `height`/`width` (see #1190).
+* `ggplotly()` now uses fixed heights for facet strips meaning that their height is still correct after a window resize (see #1265).
 * Bug fix for linking views with crosstalk where the source of the selection is an aggregated trace (see #1218).
 * Fixed algorithm for coercing the proposed layout to the plot schema (see #1156).
-* grid conversions in `ggplotly()` weren't respected a specified `height`/`width` in RStudio (see #1190).
-* `add_*()` no longer inherits `crosstalk::SharedData` key information when `inherit = FALSE`, see #1242.
-* The `limits` argument of `colorbar()` wasn't being applied to `line.color`/`line.cmin`/`line.cmax` (see #1236)
+* `add_*()` no longer inherits `crosstalk::SharedData` key information when `inherit = FALSE` (see #1242).
+* The `limits` argument of `colorbar()` wasn't being applied to `line.color`/`line.cmin`/`line.cmax` (see #1236).
 
 # 4.7.1
 

R/ggplotly.R

@@ -7,6 +7,9 @@
 #' graphics device (if no device is open, width/height of a new (off-screen) 
 #' device defaults to 640/480). In other words, `height` and
 #' `width` must be specified at runtime to ensure sizing is correct.
+#' For examples on how to specify the output container's `height`/`width` in a 
+#' shiny app, see `plotly_example("shiny", "ggplotly_sizing")`.
+#' 
 #'
 #' @param p a ggplot object.
 #' @param width Width of the plot in pixels (optional, defaults to automatic sizing).
@@ -190,8 +193,8 @@ gg2list <- function(p, width = NULL, height = NULL,
   }
   # if a device (or RStudio) is already open, use the device size as default size
   if (!is.null(grDevices::dev.list()) || is_rstudio()) {
-    width <- width %||% grDevices::dev.size("px")[1]
-    height <- height %||% grDevices::dev.size("px")[2]
+    width <- width %||% default(grDevices::dev.size("px")[1])
+    height <- height %||% default(grDevices::dev.size("px")[2])
   }
   # open the device and make sure it closes on exit
   dev_fun(file = tempfile(), width = width %||% 640, height = height %||% 480)
@@ -1032,8 +1035,8 @@ gg2list <- function(p, width = NULL, height = NULL,
   # If a trace isn't named, it shouldn't have additional hoverinfo
   traces <- lapply(compact(traces), function(x) { x$name <- x$name %||% ""; x })
 
-  gglayout$width <- width
-  gglayout$height <- height
+  gglayout$width <- width %|D|% NULL
+  gglayout$height <- height %|D|% NULL
   gglayout$barmode <- gglayout$barmode %||% "relative"
 
   l <- list(
@@ -1239,21 +1242,31 @@ uniq <- function(x) {
 make_strip_rect <- function(xdom, ydom, theme, side = "top") {
   rekt <- rect2shape(theme[["strip.background"]])
   stripTextX <- theme[["strip.text.x"]] %||% theme[["strip.text"]]
-  xTextSize <- unitConvert(stripTextX$size, "npc", "width")
+  topSize <- 
+    mm2pixels(grid::convertHeight(stripTextX$margin[1], "mm")) +
+    mm2pixels(grid::convertHeight(stripTextX$margin[3], "mm")) +
+    mm2pixels(grid::convertHeight(grid::unit(stripTextX$size, units = "points"), "mm"))
   stripTextY <- theme[["strip.text.y"]] %||% theme[["strip.text"]]
-  yTextSize <- unitConvert(stripTextY$size, "npc", "height")
+  rightSize <- 
+    mm2pixels(grid::convertWidth(stripTextX$margin[2], "mm")) +
+    mm2pixels(grid::convertWidth(stripTextX$margin[4], "mm")) +
+    mm2pixels(grid::convertWidth(grid::unit(stripTextY$size, units = "points"), "mm"))
   if ("right" %in% side) {
     # x-padding should be accounted for in `layout.margin.r`
-    rekt$x0 <- xdom[2]
-    rekt$x1 <- xdom[2] + xTextSize
     rekt$y0 <- ydom[1]
     rekt$y1 <- ydom[2]
+    rekt$x0 <- 0
+    rekt$x1 <- rightSize
+    rekt$xanchor <- xdom[2]
+    rekt$xsizemode <- "pixel"
   }
   if ("top" %in% side) {
     rekt$x0 <- xdom[1]
     rekt$x1 <- xdom[2]
-    rekt$y0 <- ydom[2]
-    rekt$y1 <- ydom[2] + yTextSize
+    rekt$y0 <- 0
+    rekt$y1 <- topSize
+    rekt$yanchor <- ydom[2]
+    rekt$ysizemode <- "pixel"
   }
   list(rekt)
 }

R/plotly.R

@@ -422,7 +422,7 @@ typedArrayPolyfill <- function() {
 # and bundle size at print time.
 plotlyMainBundle <- function() {
   htmltools::htmlDependency(
-    "plotlyjs", "1.35.2",
+    "plotlyjs", "1.38.1",
     src = depPath("plotlyjs"),
     script = "plotly-latest.min.js",
     stylesheet = "plotly-htmlwidgets.css"

R/shiny.R

@@ -27,7 +27,8 @@ plotlyOutput <- function(outputId, width = "100%", height = "400px",
     width = width, 
     height = height, 
     inline = inline, 
-    package = "plotly"
+    package = "plotly",
+    reportSize = TRUE
   )
 }
 

R/sysdata.rda

@@ -349,16 +349,13 @@ supply_defaults <- function(p) {
       list(domain = geoDomain), p$x$layout[[p$x$layout$mapType]]
     )
   } else {
-    axes <- if (is_type(p, "scatterternary"))  {
-      c("aaxis", "baxis", "caxis") 
-    } else if (is_type(p, "pie") || is_type(p, "parcoords") || is_type(p, "sankey") || is_type(p, "table")) {
-      NULL
-    } else {
-      c("xaxis", "yaxis")
-    }
+    types <- vapply(p$x$data, function(tr) tr[["type"]] %||% "scatter", character(1))
+    axes <- unlist(lapply(types, function(x) {
+      grep("^[a-z]axis$", names(Schema$traces[[x]]$attributes), value = TRUE) %||% NULL
+    }))
     for (axis in axes) {
       p$x$layout[[axis]] <- modify_list(
-        list(domain = c(0, 1)), p$x$layout[[axis]]
+        list(domain = c(0, 1), automargin = TRUE), p$x$layout[[axis]]
       )
     }
   }

R/utils.R

@@ -0,0 +1,24 @@
+library(shiny)
+library(plotly)
+
+ui <- fluidPage(
+  plotlyOutput("pid")
+)
+
+server <- function(input, output, session, ...) {
+  
+  # to relay the height/width of the plot's container, we'll query this 
+  # session's client data http://shiny.rstudio.com/articles/client-data.html
+  cdata <- session$clientData
+  
+  output$pid <- renderPlotly({
+    p <- ggplot(iris) + 
+      geom_point(aes(Sepal.Length, Sepal.Width)) +
+      facet_wrap(~Species)
+    
+    ggplotly(p, width = cdata$output_pid_width, height = cdata$output_pid_height)
+  })
+  
+}
+
+shinyApp(ui, server)

inst/examples/shiny/ggplotly_sizing/app.R

@@ -33,7 +33,7 @@ HTMLWidgets.widget({
 
       // Enable persistent selection when shift key is down
       // https://stackoverflow.com/questions/1828613/check-if-a-key-is-down
-       var persistOnShift = function(e) {
+      var persistOnShift = function(e) {
         if (!e) window.event;
         if (e.shiftKey) { 
           x.highlight.persistent = true; 
@@ -199,7 +199,7 @@ HTMLWidgets.widget({
       // https://www.mapbox.com/mapbox-gl-js/example/fitbounds/
       // so we do this manually...
       // TODO: make sure this triggers on a redraw and relayout as well as on initial draw
-      var mapboxIDs = graphDiv._fullLayout._subplots.mapbox;
+      var mapboxIDs = graphDiv._fullLayout._subplots.mapbox || [];
       for (var i = 0; i < mapboxIDs.length; i++) {
         var id = mapboxIDs[i];
         var mapOpts = x.layout[id] || {};
@@ -655,7 +655,7 @@ TraceManager.prototype.updateSelection = function(group, keys) {
         /  (2) highlight(selected = attrs_selected(...))
         */
         // TODO: it would be neat to have a dropdown to dynamically specify these!
-        $.extend(true, trace, this.highlight.selected, d.selected);
+        $.extend(true, trace, this.highlight.selected);
 
         // if it is defined, override color with the "dynamic brush color""
         if (d.marker) {
@@ -771,9 +771,8 @@ TraceManager.prototype.updateSelection = function(group, keys) {
 
       if (tracesToDim.length > 0) {
         Plotly.restyle(this.gd, {"opacity": opacities}, tracesToDim);
-        // this is an unfortunate consequence of the selected/unselected API
-        // https://codepen.io/cpsievert/pen/opOawp
-        Plotly.restyle(this.gd, {"unselected": {"marker": {"opacity": 1}}});
+        // turn off the selected/unselected API
+        Plotly.restyle(this.gd, {"selectedpoints": null});
       }
 
     }