1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
unname_vp <- function(x) {
if (inherits(x, 'vpTree')) {
x$parent <- unname_vp(x$parent)
x$children <- lapply(x$children, unname_vp)
} else if (inherits(x, 'viewport')) {
x$name <- ''
if (!is.null(x$layout$widths)) {
x$layout$widths <- absolute.size(x$layout$widths)
}
if (!is.null(x$layout$heights)) {
x$layout$heights <- absolute.size(x$layout$heights)
}
}
unit_elements <- vapply(x, is.unit, logical(1))
x[unit_elements] <- lapply(.subset(x, unit_elements), absolute.size)
x
}
#' @importFrom grid is.grob is.unit absolute.size
#' @importFrom gtable is.gtable
#' @importFrom farver set_channel get_channel
unname_grob <- function(x) {
if (is.gtable(x)) {
x$name <- ''
x$rownames <- NULL
x$vp <- unname_vp(x$vp)
names(x$grobs) <- NULL
x$grobs <- lapply(x$grobs, unname_grob)
} else if (is.grob(x)) {
x$name <- ''
x$vp <- unname_vp(x$vp)
x$children <- unname(lapply(x$children, unname_grob))
x$childrenOrder <- rep_len('', length(x$childrenOrder))
}
unit_elements <- vapply(x, is.unit, logical(1))
x[unit_elements] <- lapply(.subset(x, unit_elements), absolute.size)
if (!is.null(x$gp)) {
if (is.character(x$gp$col)) x$gp$col <- set_channel(x$gp$col, "r", get_channel(x$gp$col, "r"))
if (is.character(x$gp$fill)) x$gp$fill <- set_channel(x$gp$fill, "r", get_channel(x$gp$fill, "r"))
if (is.numeric(x$gp$lty)) x$gp$lty <- c("blank", "solid", "dashed", "dotted", "dotdash", "longdash", "twodash")[x$gp$lty + 1]
if (is.character(x$gp$lty)) {
rename <- match(x$gp$lty, c("44", "13", "1343", "73", "2262"))
matched <- !is.na(rename)
x$gp$lty[matched] <- c("dashed", "dotted", "dotdash", "longdash", "twodash")[rename[matched]]
}
if (is.numeric(x$gp$lineend)) x$gp$lineend <- c("round", "butt", "square")[x$gp$lineend]
if (is.numeric(x$gp$linejoin)) x$gp$linejoin <- c("round", "mitre", "bevel")[x$gp$linejoin]
}
x
}
collapse_guides <- function(guides) {
unnamed <- lapply(guides, unname_grob)
for (i in rev(seq_along(unnamed)[-1])) {
for (j in seq_len(i - 1)) {
if (isTRUE(all.equal(unnamed[[i]], unnamed[[j]], check.names = FALSE, check.attributes = FALSE))) {
guides[i] <- NULL
break
}
}
}
guides
}
#' @importFrom gtable gtable_width gtable_height gtable gtable_add_grob
#' @importFrom grid editGrob heightDetails widthDetails valid.just unit.c unit
#' @importFrom ggplot2 margin element_grob element_blank calc_element element_render
guides_build <- function(guides, theme) {
legend.spacing.y <- calc_element(theme, "legend.spacing.y")
legend.spacing.x <- calc_element(theme, "legend.spacing.x")
legend.box.margin <- calc_element("legend.box.margin", theme) %||% margin()
widths <- exec(unit.c, !!!lapply(guides, gtable_width))
heights <- exec(unit.c, !!!lapply(guides, gtable_height))
just <- valid.just(calc_element("legend.box.just", theme))
xjust <- just[1]
yjust <- just[2]
vert <- identical(calc_element("legend.box", theme), "horizontal")
guides <- lapply(guides, function(g) {
editGrob(g, vp = viewport(x = xjust, y = yjust, just = c(xjust, yjust),
height = if (vert) heightDetails(g) else 1,
width = if (!vert) widthDetails(g) else 1))
})
guide_ind <- seq(by = 2, length.out = length(guides))
sep_ind <- seq(2, by = 2, length.out = length(guides) - 1)
if (vert) {
heights <- max(heights)
if (length(widths) != 1) {
w <- unit(rep_len(0, length(widths) * 2 - 1), 'mm')
w[guide_ind] <- widths
w[sep_ind] <- legend.spacing.x
widths <- w
}
} else {
widths <- max(widths)
if (length(heights) != 1) {
h <- unit(rep_len(0, length(heights) * 2 - 1), 'mm')
h[guide_ind] <- heights
h[sep_ind] <- legend.spacing.y
heights <- h
}
}
widths <- unit.c(legend.box.margin[4], widths, legend.box.margin[2])
heights <- unit.c(legend.box.margin[1], heights, legend.box.margin[3])
guides <- gtable_add_grob(
gtable(widths, heights, name = 'guide-box'),
guides,
t = 1 + if (!vert) guide_ind else 1,
l = 1 + if (vert) guide_ind else 1,
name = 'guides'
)
gtable_add_grob(
guides,
element_render(theme, "legend.box.background"),
t = 1, l = 1, b = -1, r = -1,
z = -Inf, clip = "off", name = "legend.box.background"
)
}
#' @importFrom ggplot2 calc_element
complete_guide_theme <- function(guide_pos, theme) {
if (guide_pos %in% c("top", "bottom")) {
theme$legend.box <- theme$legend.box %||% "horizontal"
theme$legend.direction <- theme$legend.direction %||% "horizontal"
theme$legend.box.just <- theme$legend.box.just %||% c("center", "top")
} else {
theme$legend.box <- theme$legend.box %||% "vertical"
theme$legend.direction <- theme$legend.direction %||% "vertical"
theme$legend.box.just <- theme$legend.box.just %||% c("left", "top")
}
theme
}
#' @importFrom utils getFromNamespace
#' @importFrom ggplot2 calc_element
assemble_guides <- function(guides, position, theme) {
# https://github.com/tidyverse/ggplot2/blob/57ba97fa04dadc6fd73db1904e39a09d57a4fcbe/R/guides-.R#L512
theme$legend.spacing <- theme$legend.spacing %||% unit(0.5, "lines")
theme$legend.spacing.y <- calc_element("legend.spacing.y", theme)
theme$legend.spacing.x <- calc_element("legend.spacing.x", theme)
# for every position, collect all individual guides and arrange them
# into a guide box which will be inserted into the main gtable
package_box <- try_fetch(
.subset2(getFromNamespace("Guides", "ggplot2"), "package_box"),
error = function(cnd) package_box
)
package_box(guides, position, theme)
}
#' @importFrom grid valid.just editGrob
package_box <- function(guides, guide_pos, theme) {
theme <- complete_guide_theme(guide_pos, theme)
guides <- guides_build(guides, theme)
# Set the justification of the legend box
# First value is xjust, second value is yjust
just <- valid.just(calc_element("legend.justification", theme))
xjust <- just[1]
yjust <- just[2]
guides <- editGrob(guides,
vp = viewport(x = xjust, y = yjust, just = c(xjust, yjust))
)
guides <- gtable_add_rows(guides, unit(yjust, 'null'))
guides <- gtable_add_rows(guides, unit(1 - yjust, 'null'), 0)
guides <- gtable_add_cols(guides, unit(xjust, 'null'), 0)
guides <- gtable_add_cols(guides, unit(1 - xjust, 'null'))
guides
}
#' @importFrom ggplot2 calc_element find_panel
#' @importFrom gtable gtable_width gtable_height
#' @importFrom grid unit.c
attach_guides <- function(table, guides, position, theme) {
guide_areas <- grepl("panel-guide_area", table$layout$name)
if (any(guide_areas)) {
area_ind <- which(guide_areas)
if (length(area_ind) != 1) {
warning("Only using the first guide area", call. = FALSE)
}
table$grobs[[area_ind[1]]] <- guides
return(table)
}
p_loc <- find_panel(table)
spacing <- calc_element("legend.box.spacing", theme) %||% unit(0.2, 'cm')
legend_width <- gtable_width(guides)
legend_height <- gtable_height(guides)
if (position == "left") {
table <- gtable_add_grob(table, guides, clip = "off", t = p_loc$t,
l = p_loc$l - 5, b = p_loc$b, name = "guide-box")
table <- set_border_sizes(table, l = unit.c(table$widths[seq_len(p_loc$l - 6)], legend_width, spacing))
} else if (position == "right") {
table <- gtable_add_grob(table, guides, clip = "off", t = p_loc$t,
l = p_loc$r + 5, b = p_loc$b, name = "guide-box")
table <- set_border_sizes(table, r = unit.c(spacing, legend_width, table$widths[seq(p_loc$r + 6, ncol(table))]))
} else if (position == "bottom") {
table <- gtable_add_grob(table, guides, clip = "off", t = p_loc$b + 5,
l = p_loc$l, r = p_loc$r, name = "guide-box")
table <- set_border_sizes(table, b = unit.c(spacing, legend_height, table$heights[seq(p_loc$b + 6, nrow(table))]))
} else if (position == "top") {
table <- gtable_add_grob(table, guides, clip = "off", t = p_loc$t - 5,
l = p_loc$l, r = p_loc$r, name = "guide-box")
table <- set_border_sizes(table, t = unit.c(table$heights[seq_len(p_loc$t - 6)], legend_height, spacing))
}
table
}
|
