Skip to content

Strip clipping optional (re: #4125) #4223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Apr 19, 2022
Merged

Strip clipping optional (re: #4125) #4223

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9eae05e
Define strip clipping element
teunbrand Jul 9, 2020
90dda35
Add strip clipping as argument to theme()
teunbrand Jul 9, 2020
132f6aa
Add strip clipping to parental themes
teunbrand Jul 9, 2020
dd6919d
Derive strip clipping from theme in build_strip()
teunbrand Jul 9, 2020
8a18d97
Forgot to set strip clipping in theme_void()
teunbrand Jul 9, 2020
2c061c1
Switch strip.clip from logical to character
teunbrand Jul 11, 2020
efd83ad
Add unit test for strip clipping
teunbrand Apr 8, 2021
dac7afa
Merge branch 'tidyverse:main' into stripclip
teunbrand Mar 24, 2022
57620ce
Code styling in test
teunbrand Mar 24, 2022
765f030
Add NEWS bullet
teunbrand Mar 24, 2022
0fc16b2
Merge branch 'main' into stripclip
teunbrand Apr 19, 2022
647acea
Describe clipping options better
teunbrand Apr 19, 2022
4be095d
Merge branch 'stripclip' of https://github.com/teunbrand/ggplot2 into…
teunbrand Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions R/labeller.r
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,18 +502,23 @@ build_strip <- function(label_df, labeller, theme, horizontal) {
ncol <- ncol(labels)
nrow <- nrow(labels)

# Decide strip clipping
clip <- calc_element("strip.clip", theme)[[1]]
clip <- pmatch(clip, c("on", "off", "inherit"), nomatch = 3)
clip <- c("on", "off", "inherit")[clip]

if (horizontal) {
grobs_top <- lapply(labels, element_render, theme = theme,
element = "strip.text.x.top", margin_x = TRUE,
margin_y = TRUE)
grobs_top <- assemble_strips(matrix(grobs_top, ncol = ncol, nrow = nrow),
theme, horizontal, clip = "on")
theme, horizontal, clip = clip)

grobs_bottom <- lapply(labels, element_render, theme = theme,
element = "strip.text.x.bottom", margin_x = TRUE,
margin_y = TRUE)
grobs_bottom <- assemble_strips(matrix(grobs_bottom, ncol = ncol, nrow = nrow),
theme, horizontal, clip = "on")
theme, horizontal, clip = clip)

list(
top = grobs_top,
Expand All @@ -524,14 +529,14 @@ build_strip <- function(label_df, labeller, theme, horizontal) {
element = "strip.text.y.left", margin_x = TRUE,
margin_y = TRUE)
grobs_left <- assemble_strips(matrix(grobs_left, ncol = ncol, nrow = nrow),
theme, horizontal, clip = "on")
theme, horizontal, clip = clip)

grobs_right <- lapply(labels[, rev(seq_len(ncol(labels))), drop = FALSE],
element_render, theme = theme,
element = "strip.text.y.right", margin_x = TRUE,
margin_y = TRUE)
grobs_right <- assemble_strips(matrix(grobs_right, ncol = ncol, nrow = nrow),
theme, horizontal, clip = "on")
theme, horizontal, clip = clip)

list(
left = grobs_left,
Expand Down
3 changes: 3 additions & 0 deletions R/theme-defaults.r
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ theme_grey <- function(base_size = 11, base_family = "",
panel.ontop = FALSE,

strip.background = element_rect(fill = "grey85", colour = NA),
strip.clip = "inherit",
strip.text = element_text(
colour = "grey10",
size = rel(0.8),
Expand Down Expand Up @@ -484,6 +485,7 @@ theme_void <- function(base_size = 11, base_family = "",
legend.position = "right",
legend.text = element_text(size = rel(0.8)),
legend.title = element_text(hjust = 0),
strip.clip = "inherit",
strip.text = element_text(size = rel(0.8)),
strip.switch.pad.grid = unit(half_line / 2, "pt"),
strip.switch.pad.wrap = unit(half_line / 2, "pt"),
Expand Down Expand Up @@ -609,6 +611,7 @@ theme_test <- function(base_size = 11, base_family = "",
panel.ontop = FALSE,

strip.background = element_rect(fill = "grey85", colour = "grey20"),
strip.clip = "inherit",
strip.text = element_text(
colour = "grey10",
size = rel(0.8),
Expand Down
1 change: 1 addition & 0 deletions R/theme-elements.r
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,7 @@ el_def <- function(class = NULL, inherit = NULL, description = NULL) {
strip.background = el_def("element_rect", "rect"),
strip.background.x = el_def("element_rect", "strip.background"),
strip.background.y = el_def("element_rect", "strip.background"),
strip.clip = el_def("character"),
strip.text.x = el_def("element_text", "strip.text"),
strip.text.x.top = el_def("element_text", "strip.text.x"),
strip.text.x.bottom = el_def("element_text", "strip.text.x"),
Expand Down
4 changes: 4 additions & 0 deletions R/theme.r
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,9 @@
#' @param strip.placement placement of strip with respect to axes,
#' either "inside" or "outside". Only important when axes and strips are
#' on the same side of the plot.
#' @param strip.clip should strip background edges and strip labels be clipped
#' to the extend of the strip background? Options are `"on"`, `"off"` and
#' `"inherit"`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does inherit mean?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It means the same thing as for the clip argument in grid::viewport(): it inherits the clipping from the parent viewport. It was suggested to allow this in this comment.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain that in the docs?

#' @param strip.text,strip.text.x,strip.text.y facet labels ([element_text()];
#' inherits from `text`). Horizontal facet labels (`strip.text.x`) & vertical
#' facet labels (`strip.text.y`) inherit from `strip.text` or can be specified
Expand Down Expand Up @@ -350,6 +353,7 @@ theme <- function(line,
strip.background,
strip.background.x,
strip.background.y,
strip.clip,
strip.placement,
strip.text,
strip.text.x,
Expand Down
5 changes: 5 additions & 0 deletions man/theme.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions tests/testthat/test-facet-strips.r
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,16 @@ test_that("y strip labels are rotated when strips are switched", {

expect_doppelganger("switched facet strips", switched)
})

test_that("strip clipping can be set from the theme", {
labels <- data_frame(var1 = "a")

strip <- render_strips(labels, labeller = label_value,
theme = theme_test() + theme(strip.clip = "on"))
expect_equal(strip$x$top[[1]]$layout$clip, "on")

strip <- render_strips(labels, labeller = label_value,
theme = theme_test() + theme(strip.clip = "off"))
expect_equal(strip$x$top[[1]]$layout$clip, "off")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please style like https://style.tidyverse.org/syntax.html#long-lines ?

})