merge conflicts

Author: cpsievert

NEWS.md

@@ -2,36 +2,60 @@
 
 ## NEW FEATURES & IMPROVEMENTS
 
-* Upgraded to plotly.js v1.38.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).
+### plotly.js and `plot_ly()` specific improvements
+
+* Upgraded to plotly.js v1.38.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 six new trace types (`cone`, `scatterpolar`, `scatterpolargl`, `splom`, `table`, & `violin`)! See [here](https://github.com/plotly/plotly.js/releases) for a complete list of plotly.js-specific improvements.
 * 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 `plot_ly()` 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")`).
-* The new `partial_bundle()` function makes it easy to leverage [partial bundles of plotly.js](https://github.com/plotly/plotly.js#partial-bundles) for reduced file sizes and faster render times.
-* The `config()` function gains a `locale` argument for easily changing localization defaults (see #1270). This makes it possible localize date axes, and in some cases, modebar buttons (see #1270)
+* Better control over the stroke (i.e., outline) appearance of various filled graphical marks via the new "special arguments" (`stroke`, `strokes`, `alpha_stroke`, `span`, and `spans`). 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")`).
+
+### `ggplotly()` specific improvements
+
+* `ggplotly()` now supports conversion of **ggplot2**'s `geom_sf()`.
 * 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")`.
-* 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)
+
+### Other improvements relevant for all **plotly** objects
+
 * 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.
-* The `highlight()` function gains a `debounce` argument for throttling the rate at which `on` events may be fired. This is mainly useful for improving user experience when `highlight(on = "plotly_hover")` and mousing over relevant markers at a rapid rate (see #1277)
-* 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).
+* The `highlight()` function gains a `debounce` argument for throttling the rate at which `on` events may be fired. This is mainly useful for improving user experience when `highlight(on = "plotly_hover")` and mousing over relevant markers at a rapid rate (#1277)
+* The new `partial_bundle()` function makes it easy to leverage [partial bundles of plotly.js](https://github.com/plotly/plotly.js#partial-bundles) for reduced file sizes and faster render times.
+* The `config()` function gains a `locale` argument for easily changing localization defaults (#1270). This makes it possible localize date axes, and in some cases, modebar buttons (#1270).
+* 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 (#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 (#1205).
+* Support for async rendering of inside **shiny** apps using the [promises](https://rstudio.github.io/promises/) package (#1209).
 
 ## CHANGES
 
+### `plot_ly()` specific changes
+
 * The `name` attribute is now a "special `plot_ly()` argument" and behaves similar to `split` (it ensures a different trace for every unique value supplied). Although this leads to a breaking change (`name` was previously appended to an automatically generated trace name), it leads to a more flexible and transparent API. Those that wish to have the old behavior back should provide relevant mappings to the `name` attributes (e.g. `plot_ly(mtcars, x = ~wt, y = ~mpg, color = ~factor(vs), name = "a")` should become `plot_ly(mtcars, x = ~wt, y = ~mpg, color = ~factor(vs), name = ~paste(vs, "\na"))`)
 * 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))`).
 * `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).
+
+### Other changes relevant for all **plotly** objects
+
+* The `elementId` field is no longer populated, which fixes the "Ignoring explicitly provided widget ID" warning in shiny applications (#985).
 
 ## BUG FIXES
 
+### `ggplotly()` specific 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).
-* `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).
+* In RStudio, `ggplotly()` was ignoring a specified `height`/`width` (#1190).
+* `ggplotly()` now uses fixed heights for facet strips meaning that their height is still correct after a window resize (#1265).
+
+### `plot_ly()` specific fixes
+
+* The `limits` argument of `colorbar()` wasn't being applied to `line.color`/`line.cmin`/`line.cmax` (#1236).
+
+### Other fixes relevant for all **plotly** objects
+
+* Bug fix for linking views with crosstalk where the source of the selection is an aggregated trace (#1218).
+* Fixed algorithm for coercing the proposed layout to the plot schema (#1156).
+* `add_*()` no longer inherits `crosstalk::SharedData` key information when `inherit = FALSE` (#1242).
+
+
 
 # 4.7.1
 

R/highlight.R

@@ -43,8 +43,9 @@
 #' @param opacityDim a number between 0 and 1 used to reduce the
 #' opacity of non-selected traces (by multiplying with the existing opacity).
 #' @param selected attributes of the selection, see [attrs_selected()].
-#' @param debounce amount of time to wait before firing an event (in milliseconds). 
-#' This is especially useful when `on = "plotly_hover"` to avoid firing too many events
+#' @param debounce amount of time to wait before firing an event (in milliseconds).
+#' The default of 0 means do not debounce at all. 
+#' Debouncing is mainly useful when `on = "plotly_hover"` to avoid firing too many events
 #' when users clickly move the mouse over relevant graphical marks.
 #' @param ... currently not supported.
 #' @export
@@ -83,7 +84,7 @@ highlight <- function(p, on = "plotly_click", off,
                       dynamic = FALSE, color = NULL,
                       selectize = FALSE, defaultValues = NULL,
                       opacityDim = getOption("opacityDim", 0.2), 
-                      selected = attrs_selected(), debounce = 1,
+                      selected = attrs_selected(), debounce = 0,
                       ...) {
 
   # currently ... is not-supported and will catch 

R/layers2traces.R

@@ -273,7 +273,8 @@ to_basic.GeomRect <- function(data, prestats_data, layout, params, p, ...) {
 #' @export
 to_basic.GeomSf <- function(data, prestats_data, layout, params, p, ...) {
 
-  data <- sf::st_as_sf(data)
+  data[["geometry"]] <- sf::st_sfc(data[["geometry"]])
+  data <- sf::st_as_sf(data, sf_column_name = "geometry")
   geom_type <- sf::st_geometry_type(data)
   # st_cast should "expand" a collection into multiple rows (one per feature)
   if ("GEOMETRYCOLLECTION" %in% geom_type) {

inst/htmlwidgets/plotly.js

@@ -471,8 +471,10 @@ HTMLWidgets.widget({
           }
         }
       };
-      
-      graphDiv.on(x.highlight.on, debounce(turnOn, x.highlight.debounce));
+      if (x.highlight.debounce > 0) {
+        turnOn = debounce(turnOn, x.highlight.debounce);
+      }
+      graphDiv.on(x.highlight.on, turnOn);
 
       graphDiv.on(x.highlight.off, function turnOff(e) {
         // remove any visual clues

man/highlight.Rd

@@ -368,3 +368,21 @@ test_that("animation button can be customized", {
   expect_true(menu$font$color == "white")
   expect_true(menu$buttons[[1]]$label == "Custom")
 })
+
+
+test_that("sf works with crosstalk", {
+  skip_if_not_installed("sf")
+  
+  nc <- sf::st_read(system.file("shape/nc.shp", package = "sf"))
+  # shared data will make the polygons "query-able"
+  ncsd <- SharedData$new(nc)
+  p <- ggplot(ncsd) +
+    geom_sf(aes(fill = AREA, text = paste0(NAME, "\n", "FIPS: ", FIPS))) +
+    ggthemes::theme_map()
+  gg <- ggplotly(p, tooltip = "text")
+  d <- gg$x$data
+  for (i in seq_along(d)) {
+    expect_false(is.null(d[[i]]$key))
+    expect_false(is.null(d[[i]]$set))
+  }
+})