Refactor/consolidate core logic

Author: cpsievert

NAMESPACE

@@ -26,6 +26,8 @@ S3method(highlight_key,plotly)
 S3method(layout,matrix)
 S3method(layout,plotly)
 S3method(layout,shiny.tag.list)
+S3method(linewidth_or_size,Geom)
+S3method(linewidth_or_size,element)
 S3method(plotly_build,"NULL")
 S3method(plotly_build,gg)
 S3method(plotly_build,list)

R/ggplotly.R

@@ -684,10 +684,10 @@ gg2list <- function(p, width = NULL, height = NULL,
           d$y <- scales::rescale(d$y, rng$y_range, from = c(0, 1))
           params <- list(
             colour = panelGrid$colour, 
-            linewidth = panelGrid$linewidth,
-            size = panelGrid$size,
             linetype = panelGrid$linetype
           )
+          nm <- linewidth_or_size(panelGrid)
+          params[[nm]] <- panelGrid[[nm]]
           grill <- geom2trace.GeomPath(d, params)
           grill$hoverinfo <- "none"
           grill$showlegend <- FALSE
@@ -968,7 +968,7 @@ gg2list <- function(p, width = NULL, height = NULL,
     bgcolor = toRGB(theme$legend.background$fill),
     bordercolor = toRGB(theme$legend.background$colour),
     borderwidth = unitConvert(
-      theme$legend.background$linewidth %||% theme$legend.background$size, 
+      theme$legend.background[[linewidth_or_size(theme$legend.background)]], 
       "pixels", "width"
     ),
     font = text2font(theme$legend.text)
@@ -1203,7 +1203,7 @@ verifyUnit <- function(u) {
 
   ## the default unit in ggplot2 is millimeters (unless it's element_text())
   if (inherits(u, "element")) {
-    grid::unit(u$linewidth %||% u$size %||% 0, "points")
+    grid::unit(u[[linewidth_or_size(u)]] %||% 0, "points")
   } else {
     grid::unit(u %||% 0, "mm")
   }
@@ -1423,7 +1423,8 @@ gdef2trace <- function(gdef, theme, gglayout) {
           bgcolor = toRGB(theme$legend.background$fill),
           bordercolor = toRGB(theme$legend.background$colour),
           borderwidth = unitConvert(
-            theme$legend.background$linewidth %||% theme$legend.background$size, "pixels", "width"
+            theme$legend.background[[linewidth_or_size(theme$legend.background)]],
+            "pixels", "width"
           ),
           thickness = unitConvert(
             theme$legend.key.width, "pixels", "width"

R/layers2traces.R

@@ -387,13 +387,11 @@ to_basic.GeomHex <- function(data, prestats_data, layout, params, p, ...) {
   dy <- resolution(data[["y"]], FALSE)/sqrt(3)/2 * 1.15
   hexC <- hexbin::hexcoords(dx, dy, n = 1)
   n <- nrow(data)
-  size_var <- if ("linewidth" %in% names(data)) "linewidth" else "size"
-  size <- data[[size_var]]
-  data[[size_var]] <- ifelse(
-    size < 1, size ^ (1 / 6), size ^ 6
-  )
-  x <- rep.int(hexC[["x"]], n) * rep(data[[size_var]], each = 6) + rep(data[["x"]], each = 6)
-  y <- rep.int(hexC[["y"]], n) * rep(data[[size_var]], each = 6) + rep(data[["y"]], each = 6)
+  nm <- linewidth_or_size(GeomHex)
+  size <- data[[nm]]
+  data[[nm]] <- ifelse(size < 1, size ^ (1 / 6), size ^ 6)
+  x <- rep.int(hexC[["x"]], n) * rep(data[[nm]], each = 6) + rep(data[["x"]], each = 6)
+  y <- rep.int(hexC[["y"]], n) * rep(data[[nm]], each = 6) + rep(data[["y"]], each = 6)
   data <- data[rep(seq_len(n), each = 6), ]
   data[["x"]] <- x
   data[["y"]] <- y
@@ -563,11 +561,8 @@ to_basic.GeomSpoke <- function(data, prestats_data, layout, params, p, ...) {
 to_basic.GeomCrossbar <- function(data, prestats_data, layout, params, p, ...) {
   # from GeomCrossbar$draw_panel()
   middle <- base::transform(data, x = xmin, xend = xmax, yend = y, alpha = NA)
-  data <- if ("linewidth" %in% names(middle)) {
-    base::transform(data, linewidth = linewidth * params$fatten)
-  } else {
-    base::transform(data, size = size * params$fatten)
-  }
+  nm <- linewidth_or_size(GeomCrossbar)
+  data[[nm]] <- data[[nm]] * params$fatten
   list(
     prefix_class(to_basic.GeomRect(data), "GeomCrossbar"),
     prefix_class(to_basic.GeomSegment(middle), "GeomCrossbar")
@@ -707,9 +702,6 @@ geom2trace.GeomBlank <- function(data, params, p) {
 geom2trace.GeomPath <- function(data, params, p) {
   data <- group2NA(data)
 
-  # ggplot2 >3.4.0 changed from size to linewidth for controlling line width
-  width_var <- if ("linewidth" %in% names(data)) "linewidth" else "size"
-  
   L <- list(
     x = data[["x"]],
     y = data[["y"]],
@@ -723,7 +715,7 @@ geom2trace.GeomPath <- function(data, params, p) {
     name = if (inherits(data, "GeomSmooth")) "fitted values",
     line = list(
       # TODO: line width array? -- https://github.com/plotly/plotly.js/issues/147
-      width = aes2plotly(data, params, width_var)[1],
+      width = aes2plotly(data, params, linewidth_or_size(GeomPath))[1],
       color = toRGB(
         aes2plotly(data, params, "colour"),
         aes2plotly(data, params, "alpha")
@@ -791,9 +783,6 @@ geom2trace.GeomBar <- function(data, params, p) {
     base <- data[["ymin"]]
     x <- with(data, ymax - ymin)
   }
-  
-  # ggplot2 >3.4.0 changed from size to linewidth for controlling line width
-  width_var <- if ("linewidth" %in% names(data)) "linewidth" else "size"
 
   compact(list(
     orientation = if (flip) "h" else "v",
@@ -819,7 +808,7 @@ geom2trace.GeomBar <- function(data, params, p) {
         aes2plotly(data, params, "alpha")
       ),
       line = list(
-        width = aes2plotly(data, params, width_var),
+        width = aes2plotly(data, params, linewidth_or_size(GeomBar)),
         color = aes2plotly(data, params, "colour")
       )
     )
@@ -830,9 +819,6 @@ geom2trace.GeomBar <- function(data, params, p) {
 geom2trace.GeomPolygon <- function(data, params, p) {
   data <- group2NA(data)
 
-  # ggplot2 >3.4.0 changed from size to linewidth for controlling line width
-  width_var <- if ("linewidth" %in% names(data)) "linewidth" else "size"
-  
   L <- list(
     x = data[["x"]],
     y = data[["y"]],
@@ -844,7 +830,7 @@ geom2trace.GeomPolygon <- function(data, params, p) {
     type = "scatter",
     mode = "lines",
     line = list(
-      width = aes2plotly(data, params, width_var),
+      width = aes2plotly(data, params, linewidth_or_size(GeomPolygon)),
       color = toRGB(
         aes2plotly(data, params, "colour"),
         aes2plotly(data, params, "alpha")
@@ -865,9 +851,6 @@ geom2trace.GeomPolygon <- function(data, params, p) {
 
 #' @export
 geom2trace.GeomBoxplot <- function(data, params, p) {
-  # ggplot2 >3.4.0 changed from size to linewidth for controlling line width
-  width_var <- if ("linewidth" %in% names(data)) "linewidth" else "size"
-  
   compact(list(
     x = data[["x"]],
     y = data[["y"]],
@@ -894,7 +877,7 @@ geom2trace.GeomBoxplot <- function(data, params, p) {
     ),
     line = list(
       color = aes2plotly(data, params, "colour"),
-      width = aes2plotly(data, params, width_var)
+      width = aes2plotly(data, params, linewidth_or_size(GeomBoxplot))
     )
   ))
 }
@@ -1135,6 +1118,26 @@ aes2plotly <- function(data, params, aes = "size") {
   converter(vals)
 }
 
+
+# ggplot2 3.4.0 deprecated size in favor of linewidth in line-based geoms (e.g.,
+# GeomLine, GeomRect, etc) and elements (e.g., element_line(), element_rect(),
+# etc). Note that, some geoms (e.g., GeomBoxplot, GeomSf) can have both 
+# linewidth and size
+linewidth_or_size <- function(x) {
+  UseMethod("linewidth_or_size")
+}
+
+#' @export
+linewidth_or_size.Geom <- function(x) {
+  if ("linewidth" %in% x$aesthetics()) "linewidth" else "size"
+}
+
+#' @export
+linewidth_or_size.element <- function(x) {
+  if ("linewidth" %in% names(x)) "linewidth" else "size"
+}
+
+
 # Convert R pch point codes to plotly "symbol" codes.
 pch2symbol <- function(x) {
   lookup <- list(