colorbar limits now controls line.color/line.cmin/line.cmax, fixes #1236

Author: cpsievert

NEWS.md

@@ -23,6 +23,7 @@
 * 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)
 
 # 4.7.1
 

R/helpers.R

@@ -66,6 +66,10 @@ colorbar_built <- function(p, ..., limits = NULL, which = 1) {
           x$marker[["color"]][col < limits[1] | limits[2] < col] <- default(NA)
           x$marker[["cmin"]] <- default(limits[1])
           x$marker[["cmax"]] <- default(limits[2])
+          col <- x$line[["color"]]
+          x$line[["color"]][col < limits[1] | limits[2] < col] <- default(NA)
+          x$line[["cmin"]] <- default(limits[1])
+          x$line[["cmax"]] <- default(limits[2])
           x
         })
       }

tests/testthat/test-plotly-colorbar.R

@@ -135,8 +135,44 @@ test_that("positioning with multiple colorbars and legends", {
 
   expect_true(b$x$layout$legend$y == 0.5)
   expect_true(b$x$layout$legend$yanchor == "top")
+})
+
+
+test_that("Colorbar limits controls marker.color and line.color", {
 
+  # https://github.com/ropensci/plotly/issues/1236
+  p <- plot_ly(
+    mtcars, x = ~hp, y = ~cyl, z = ~mpg, color = ~mpg,
+    type = "scatter3d", mode = "lines+markers"
+  )
 
-  
-  
+  b <- plotly_build(p)
+  expect_length(b$x$data, 2)
+  expect_true(all(b$x$data[[1]]$marker$color == mtcars$mpg))
+  expect_true(all(b$x$data[[1]]$line$color == mtcars$mpg))
+  expect_true(b$x$data[[1]]$marker$cmin == min(mtcars$mpg))
+  expect_true(b$x$data[[1]]$marker$cmax == max(mtcars$mpg))
+  expect_true(b$x$data[[1]]$line$cmin == min(mtcars$mpg))
+  expect_true(b$x$data[[1]]$line$cmax == max(mtcars$mpg))
+  
+  p2 <- colorbar(p, limits = c(0, 100))
+  b2 <- plotly_build(p2)
+  expect_length(b2$x$data, 2)
+  expect_true(all(b2$x$data[[1]]$marker$color == mtcars$mpg))
+  expect_true(all(b2$x$data[[1]]$line$color == mtcars$mpg))
+  expect_true(b2$x$data[[1]]$marker$cmin == 0)
+  expect_true(b2$x$data[[1]]$marker$cmax == 100)
+  expect_true(b2$x$data[[1]]$line$cmin == 0)
+  expect_true(b2$x$data[[1]]$line$cmax == 100)
+  
+  p3 <- colorbar(p, limits = c(20, 100))
+  b3 <- plotly_build(p3)
+  mpg <- mtcars$mpg
+  mpg[mpg < 20] <- NA
+  expect_true(Reduce(`&`, Map(identical, b3$x$data[[1]]$marker$color, mpg)))
+  expect_true(Reduce(`&`, Map(identical, b3$x$data[[1]]$line$color, mpg)))
+  expect_true(b3$x$data[[1]]$marker$cmin == 20)
+  expect_true(b3$x$data[[1]]$marker$cmax == 100)
+  expect_true(b3$x$data[[1]]$line$cmin == 20)
+  expect_true(b3$x$data[[1]]$line$cmax == 100)
 })