Merge pull request #496 from ropensci/fix/tooManyLegendEntries

don't show duplicated legendgroups

Author: cpsievert

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: plotly
 Title: Create Interactive Web Graphics via Plotly's JavaScript Graphing Library
-Version: 3.2.1
+Version: 3.3.1
 Authors@R: c(person("Carson", "Sievert", role = c("aut", "cre"),
     email = "cpsievert1@gmail.com"),
     person("Chris", "Parmer", role = c("aut", "cph"),

NEWS

@@ -1,3 +1,13 @@
+3.3.1 -- 10 Mar 2015
+
+CHANGES:
+
+* Changed the mapping argument name to tooltip (which seems like a better name).
+
+BUGFIX:
+
+* Redundant legend entries are no longer shown.
+
 3.2.1 -- 10 Mar 2015
 
 BUGFIX:

R/ggplotly.R

@@ -6,11 +6,11 @@
 #' @param p a ggplot object.
 #' @param width Width of the plot in pixels (optional, defaults to automatic sizing).
 #' @param height Height of the plot in pixels (optional, defaults to automatic sizing).
-#' @param mapping a character vector specifying which aesthetic mappings to show
+#' @param tooltip a character vector specifying which aesthetic mappings to show
 #' in the tooltip. The default, "all", means show all the aesthetic mappings
 #' (including the unofficial "text" aesthetic). The order of variables here will
 #' also control the order they appear. For example, use
-#' \code{mapping = c("y", "x", "colour")} if you want y first, x second, and
+#' \code{tooltip = c("y", "x", "colour")} if you want y first, x second, and
 #' colour last.
 #' @param source Only relevant for \link{event_data}.
 #' @seealso \link{signup}, \link{plot_ly}
@@ -31,22 +31,22 @@
 #' }
 #'
 ggplotly <- function(p = ggplot2::last_plot(), width = NULL, height = NULL,
-                     mapping = "all", source = "A") {
-  l <- gg2list(p, width = width, height = height, mapping = mapping, source = source)
+                     tooltip = "all", source = "A") {
+  l <- gg2list(p, width = width, height = height, tooltip = tooltip, source = source)
   hash_plot(p$data, l)
 }
 
 #' Convert a ggplot to a list.
 #' @param p ggplot2 plot.
 #' @param width Width of the plot in pixels (optional, defaults to automatic sizing).
 #' @param height Height of the plot in pixels (optional, defaults to automatic sizing).
-#' @param mapping a character vector specifying which aesthetic mappings to show in the
-#' tooltip. The default, "all", means show all the aesthetic mappings
+#' @param tooltip a character vector specifying which aesthetic tooltips to show in the
+#' tooltip. The default, "all", means show all the aesthetic tooltips
 #' (including the unofficial "text" aesthetic).
 #' @param source Only relevant for \link{event_data}.
 #' @return a 'built' plotly object (list with names "data" and "layout").
 #' @export
-gg2list <- function(p, width = NULL, height = NULL, mapping = "all", source = "A") {
+gg2list <- function(p, width = NULL, height = NULL, tooltip = "all", source = "A") {
   # ------------------------------------------------------------------------
   # Our internal version of ggplot2::ggplot_build(). Modified from
   # https://github.com/hadley/ggplot2/blob/0cd0ba/R/plot-build.r#L18-L92
@@ -190,8 +190,8 @@ gg2list <- function(p, width = NULL, height = NULL, mapping = "all", source = "A
     # remove leading/trailing dots in "hidden" stat aes
     map <- sub("^\\.\\.", "", sub("\\.\\.$", "", map))
     # TODO: allow users to specify a _list_ of mappings?
-    if (!identical(mapping, "all")) {
-      map <- map[names(map) %in% mapping]
+    if (!identical(tooltip, "all")) {
+      map <- map[names(map) %in% tooltip]
     }
     # tooltips for discrete positional scales are misleading
     if (scales$get_scales("x")$is_discrete()) {
@@ -240,6 +240,12 @@ gg2list <- function(p, width = NULL, height = NULL, mapping = "all", source = "A
     tr$hoverinfo <- tr$hoverinfo %||%"text" 
     tr 
   })
+  # show only one legend entry per legendgroup
+  grps <- sapply(traces, "[[", "legendgroup")
+  traces <- Map(function(x, y) { 
+    x$showlegend <- isTRUE(x$showlegend) && y 
+    x
+  }, traces, !duplicated(grps))
 
   # ------------------------------------------------------------------------
   # axis/facet/margin conversion
@@ -587,6 +593,9 @@ gg2list <- function(p, width = NULL, height = NULL, mapping = "all", source = "A
       if (all(modes[idx] %in% c("lines", "markers"))) {
         mergedTraces[[i]] <- Reduce(modifyList, traces[idx])
         mergedTraces[[i]]$mode <- "markers+lines"
+        if (any(sapply(traces[idx], "[[", "showlegend"))) {
+          mergedTraces[[i]]$showlegend <- TRUE
+        }
       }
     }
     traces <- mergedTraces

man/gg2list.Rd

@@ -7,6 +7,14 @@ test_that("6 facets becomes 6 panels", {
     theme_bw() +
     theme(panel.margin = grid::unit(0, "cm"))
   info <- save_outputs(gg, "barley")
+  # two legend entries, but two groups
+  expect_equal(sum(sapply(info$data, "[[", "showlegend")), 2)
+  expect_identical(
+    sort(unique(sapply(info$data, "[[", "legendgroup"))), c("1931", "1932")
+  )
+  expect_identical(
+    sort(unique(sapply(info$data, "[[", "name"))), c("1931", "1932")
+  )
 })
 
 test_that("3 facets becomes 3 panels", {

man/ggplotly.Rd

@@ -24,7 +24,7 @@ test_that("geom_violin with fill aes works", {
 })
 
 test_that("can hide x values in tooltip", {
-  p <- ggplotly(gg2, mapping = "y")
+  p <- ggplotly(gg2, tooltip = "y")
   l <- plotly_build(p)
   expect_equal(sum(grepl("cyl", l$data[[1]]$text)), 0)
 })