relay inherit info to the build step and don't attach crosstalk key/set when it is FALSE; fixes #1242

Author: cpsievert

R/add.R

@@ -57,6 +57,7 @@ add_trace <- function(p, ...,
 
   # "native" plotly arguments
   attrs <- list(...)
+  attrs$inherit <- inherit
 
   if (!is.null(attrs[["group"]])) {
     warning("The group argument has been deprecated. Use group_by() or split instead.")

R/plotly_build.R

@@ -132,7 +132,7 @@ plotly_build.plotly <- function(p, registerFrames = TRUE) {
     )
 
     # attach crosstalk info, if necessary
-    if (crosstalk_key() %in% names(dat)) {
+    if (crosstalk_key() %in% names(dat) && isTRUE(trace[["inherit"]])) {
       trace[["key"]] <- trace[["key"]] %||% dat[[crosstalk_key()]]
       trace[["set"]] <- trace[["set"]] %||% attr(dat, "set")
     }
@@ -310,7 +310,7 @@ plotly_build.plotly <- function(p, registerFrames = TRUE) {
     mappingAttrs <- c(
       "alpha", "alpha_stroke", npscales(), paste0(npscales(), "s"),
       ".plotlyGroupIndex", ".plotlyMissingIndex",
-      ".plotlyTraceIndex", ".plotlyVariableMapping"
+      ".plotlyTraceIndex", ".plotlyVariableMapping", "inherit"
     )
     for (j in mappingAttrs) {
       traces[[i]][[j]] <- NULL

tests/testthat/test-animate-highlight.R

@@ -24,6 +24,32 @@ test_that("SharedData produces key/set in ggplotly", {
   expect_false(tr$`_isSimpleKey` %||% FALSE)
 })
 
+
+
+test_that("crosstalk keys are inherited in a layer with inherit = FALSE", {
+  
+  p <- txhousing %>%
+    group_by(city) %>%
+    crosstalk::SharedData$new(~city, "Select a city") %>%
+    plot_ly(x = ~date, y = ~median) %>%
+    add_lines(alpha = 0.2) %>%
+    add_ribbons(
+      x = c(2016, 2017), ymin = c(150000, 160000), ymax = c(200000, 190000),
+      inherit = FALSE
+    )
+  
+  b <- plotly_build(p)
+  # second trace should have key/set info
+  expect_null(b$x$data[[2]][["key"]])
+  expect_null(b$x$data[[2]][["set"]])
+  # first trace should
+  k <- unique(b$x$data[[1]]$key)
+  expect_equal(sort(k[!is.na(k)]), sort(unique(txhousing$city)))
+  expect_true(b$x$data[[1]][["set"]] == "Select a city")
+})
+
+
+
 # Ignore for now https://github.com/ggobi/ggally/issues/264
 #test_that("SharedData produces key/set in ggpairs", {
 #  p <- GGally::ggpairs(m, columns = 1:3)