Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit c35a44e

Browse filesBrowse files
cpsievertcpsievert
authored
add_area() now uses barpolar instead of area (#2041)
1 parent 1889ca6 commit c35a44e
Copy full SHA for c35a44e

File tree

10 files changed

+44
-15
lines changed
Filter options

10 files changed

+44
-15
lines changed

‎NEWS.md

Copy file name to clipboardExpand all lines: NEWS.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Breaking changes in JavaScript API
44

5-
* This version of the R package upgrades the version of the underlying plotly.js library from v1.57.1 to v2.5.1. This includes many breaking changes, bug fixes, and improvements to the underlying JavaScript library. The [plotly.js release page](https://github.com/plotly/plotly.js/releases) has the full list of changes.
5+
* This version of the R package upgrades the version of the underlying plotly.js library from v1.57.1 to v2.5.1. This includes many breaking changes, bug fixes, and improvements to the underlying JavaScript library. Most of the breaking changes are summarized in [this announcement of the 2.0 release](https://community.plotly.com/t/announcing-plotly-js-2-0/53675), but [see here](https://github.com/plotly/plotly.js/blob/HEAD/CHANGELOG.md) for the full changelog.
66

77
## Breaking changes in R API
88

‎R/add.R

Copy file name to clipboardExpand all lines: R/add.R
+24-10Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,14 @@ add_data <- function(p, data = NULL) {
130130
#' layout(title = "Basic Pie Chart using Plotly")
131131
#'
132132
#' data(wind)
133-
#' plot_ly(wind, r = ~r, t = ~t) %>%
133+
#' plot_ly(wind, r = ~r, theta = ~t) %>%
134134
#' add_area(color = ~nms) %>%
135-
#' layout(radialaxis = list(ticksuffix = "%"), orientation = 270)
135+
#' layout(
136+
#' polar = list(
137+
#' radialaxis = list(ticksuffix = "%"),
138+
#' angularaxis = list(rotation = 90)
139+
#' )
140+
#' )
136141
#'
137142
#' # ------------------------------------------------------------
138143
#' # 3D chart types
@@ -432,20 +437,29 @@ add_image <- function(p, z = NULL, colormodel = NULL, ..., data = NULL, inherit
432437

433438
#' @inheritParams add_trace
434439
#' @rdname add_trace
435-
#' @param r For polar chart only. Sets the radial coordinates.
436-
#' @param t For polar chart only. Sets the radial coordinates.
440+
#' @param r Sets the radial coordinates.
441+
#' @param theta Sets the angular coordinates.
442+
#' @param t Deprecated. Use `theta` instead.
437443
#' @export
438-
add_area <- function(p, r = NULL, t = NULL, ...,
444+
add_area <- function(p, r = NULL, theta = NULL, t = NULL, ...,
439445
data = NULL, inherit = TRUE) {
446+
if (!is.null(t)) {
447+
message(
448+
"Since `add_area()` now uses the barpolar instead of the area trace, ",
449+
"the `t` argument is now deprecated. Use the `theta` argument instead."
450+
)
451+
}
452+
theta <- theta %||% t
440453
if (inherit) {
441-
r <- t %||% p$x$attrs[[1]][["r"]]
442-
t <- t %||% p$x$attrs[[1]][["t"]]
454+
attrs <- p$x$attrs[[1]]
455+
r <- r %||% attrs[["r"]]
456+
theta <- theta %||% (attrs[["theta"]] %||% attrs[["t"]])
443457
}
444-
if (is.null(r) || is.null(t)) {
445-
stop("Must supply `r`/`t` attributes", call. = FALSE)
458+
if (is.null(r) || is.null(theta)) {
459+
stop("Must supply `r`/`theta` attributes", call. = FALSE)
446460
}
447461
add_trace_classed(
448-
p, class = "plotly_area", r = r, t = t, type = "area",
462+
p, class = "plotly_area", r = r, theta = theta, type = "barpolar",
449463
..., data = data, inherit = inherit
450464
)
451465
}

‎inst/examples/shiny/event_data/tests/shinytest/mytest-expected/001.png

Copy file name to clipboard
5 Bytes
Loading

‎inst/examples/shiny/event_data/tests/shinytest/mytest-expected/002.png

Copy file name to clipboard
4 Bytes
Loading

‎inst/examples/shiny/event_data/tests/shinytest/mytest-expected/003.png

Copy file name to clipboard
5 Bytes
Loading

‎inst/examples/shiny/event_data/tests/shinytest/mytest-expected/004.png

Copy file name to clipboard
5 Bytes
Loading

‎man/add_trace.Rd

Copy file name to clipboardExpand all lines: man/add_trace.Rd
+5-3Lines changed: 5 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/testthat/_snaps/plotly-area/add-area.svg

Copy file name to clipboardExpand all lines: tests/testthat/_snaps/plotly-area/add-area.svg
+1Lines changed: 1 addition & 0 deletions
Loading

‎tests/testthat/_snaps/plotly-subplot/subplot-reposition-shape-fixed.svg

Copy file name to clipboardExpand all lines: tests/testthat/_snaps/plotly-subplot/subplot-reposition-shape-fixed.svg
+1-1Lines changed: 1 addition & 1 deletion
Loading

‎tests/testthat/test-plotly-area.R

Copy file name to clipboard
+12Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
test_that("add_area() works", {
2+
data(wind)
3+
p <- plot_ly(wind, r = ~r, theta = ~t) %>%
4+
add_area(color = ~nms) %>%
5+
layout(
6+
polar = list(
7+
radialaxis = list(ticksuffix = "%"),
8+
angularaxis = list(rotation = 90)
9+
)
10+
)
11+
expect_doppelganger_built(p, "add-area")
12+
})

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.