/
internals_gggtable.R
256 lines (224 loc) · 13.2 KB
/
internals_gggtable.R
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# The gggtable() function mimics the behaviour of the ggplot_gtable()
# function (from version 3.3.0.9000). It is a direct copy of the source
# code from the original, with calls to internal ggplot2 functions
# namespaced via :::, and calls to grid and gtable functions namespaced with ::
#
# The only substantive modification from the original is that it maintains
# a list "all_states" that records the state of the gtable at various points in
# the rendering process in addition to the final gtable
#
# Lines that marked with # ****** are those that have been modified or inserted
gggtable <- function(data) {
`%||%` <- ggplot2:::`%||%` # ******
plot <- data$plot
layout <- data$layout
data <- data$data
theme <- ggplot2:::plot_theme(plot) # ******
geom_grobs <- Map(function(l, d) l$draw_geom(d, layout), plot$layers, data)
layout$setup_panel_guides(plot$guides, plot$layers, plot$mapping)
plot_table <- layout$render(geom_grobs, data, theme, plot$labels)
# Record the state after the panel layouts have done their job (I think!)
all_states <- list() # ******
all_states$panels <- plot_table # ******
# Legends
position <- theme$legend.position %||% "right"
if (length(position) == 2) {
position <- "manual"
}
legend_box <- if (position != "none") {
ggplot2:::build_guides(plot$scales, plot$layers, plot$mapping, position, theme, plot$guides, plot$labels) # ******
} else {
zeroGrob()
}
if (ggplot2:::is.zero(legend_box)) { # ******
position <- "none"
} else {
# these are a bad hack, since it modifies the contents of viewpoint directly...
legend_width <- gtable:::gtable_width(legend_box) # ******
legend_height <- gtable:::gtable_height(legend_box) # ******
# Set the justification of the legend box
# First value is xjust, second value is yjust
just <- grid::valid.just(theme$legend.justification) # ******
xjust <- just[1]
yjust <- just[2]
if (position == "manual") {
xpos <- theme$legend.position[1]
ypos <- theme$legend.position[2]
# x and y are specified via theme$legend.position (i.e., coords)
legend_box <- grid::editGrob(legend_box, # ******
vp = grid::viewport(x = xpos, y = ypos, just = c(xjust, yjust), # ******
height = legend_height, width = legend_width))
} else {
# x and y are adjusted using justification of legend box (i.e., theme$legend.justification)
legend_box <- grid::editGrob(legend_box, # ******
vp = grid::viewport(x = xjust, y = yjust, just = c(xjust, yjust))) # ******
legend_box <- gtable:::gtable_add_rows(legend_box, unit(yjust, 'null')) # ******
legend_box <- gtable:::gtable_add_rows(legend_box, unit(1 - yjust, 'null'), 0) # ******
legend_box <- gtable:::gtable_add_cols(legend_box, unit(xjust, 'null'), 0) # ******
legend_box <- gtable:::gtable_add_cols(legend_box, unit(1 - xjust, 'null')) # ******
}
}
panel_dim <- find_panel(plot_table)
# for align-to-device, use this:
# panel_dim <- summarise(plot_table$layout, t = min(t), r = max(r), b = max(b), l = min(l))
theme$legend.box.spacing <- theme$legend.box.spacing %||% unit(0.2, 'cm')
if (position == "left") {
plot_table <- gtable::gtable_add_cols(plot_table, theme$legend.box.spacing, pos = 0) # ******
plot_table <- gtable::gtable_add_cols(plot_table, legend_width, pos = 0) # ******
plot_table <- gtable::gtable_add_grob(plot_table, legend_box, clip = "off", # ******
t = panel_dim$t, b = panel_dim$b, l = 1, r = 1, name = "guide-box")
} else if (position == "right") {
plot_table <- gtable::gtable_add_cols(plot_table, theme$legend.box.spacing, pos = -1) # ******
plot_table <- gtable::gtable_add_cols(plot_table, legend_width, pos = -1) # ******
plot_table <- gtable::gtable_add_grob(plot_table, legend_box, clip = "off", # ******
t = panel_dim$t, b = panel_dim$b, l = -1, r = -1, name = "guide-box")
} else if (position == "bottom") {
plot_table <- gtable::gtable_add_rows(plot_table, theme$legend.box.spacing, pos = -1) # ******
plot_table <- gtable::gtable_add_rows(plot_table, legend_height, pos = -1) # ******
plot_table <- gtable::gtable_add_grob(plot_table, legend_box, clip = "off", # ******
t = -1, b = -1, l = panel_dim$l, r = panel_dim$r, name = "guide-box")
} else if (position == "top") {
plot_table <- gtable::gtable_add_rows(plot_table, theme$legend.box.spacing, pos = 0) # ******
plot_table <- gtable::gtable_add_rows(plot_table, legend_height, pos = 0) # ******
plot_table <- gtable::gtable_add_grob(plot_table, legend_box, clip = "off", # ******
t = 1, b = 1, l = panel_dim$l, r = panel_dim$r, name = "guide-box")
} else if (position == "manual") {
# should guide box expand whole region or region without margin?
plot_table <- gtable::gtable_add_grob(plot_table, legend_box, # ******
t = panel_dim$t, b = panel_dim$b, l = panel_dim$l, r = panel_dim$r,
clip = "off", name = "guide-box")
}
# Record the state of the gtable after the legends have been added
all_states$legend <- plot_table # ******
# Title
title <- element_render(theme, "plot.title", plot$labels$title, margin_y = TRUE)
title_height <- grid::grobHeight(title) # ******
# Subtitle
subtitle <- element_render(theme, "plot.subtitle", plot$labels$subtitle, margin_y = TRUE)
subtitle_height <- grid::grobHeight(subtitle) # ******
# Tag
tag <- element_render(theme, "plot.tag", plot$labels$tag, margin_y = TRUE, margin_x = TRUE)
tag_height <- grid::grobHeight(tag) # ******
tag_width <- grid::grobWidth(tag) # ******
# whole plot annotation
caption <- element_render(theme, "plot.caption", plot$labels$caption, margin_y = TRUE)
caption_height <- grid::grobHeight(caption) # ******
# positioning of title and subtitle is governed by plot.title.position
# positioning of caption is governed by plot.caption.position
# "panel" means align to the panel(s)
# "plot" means align to the entire plot (except margins and tag)
title_pos <- theme$plot.title.position %||% "panel"
if (!(title_pos %in% c("panel", "plot"))) {
abort('plot.title.position should be either "panel" or "plot".')
}
caption_pos <- theme$plot.caption.position %||% "panel"
if (!(caption_pos %in% c("panel", "plot"))) {
abort('plot.caption.position should be either "panel" or "plot".')
}
pans <- plot_table$layout[grepl("^panel", plot_table$layout$name), , drop = FALSE]
if (title_pos == "panel") {
title_l = min(pans$l)
title_r = max(pans$r)
} else {
title_l = 1
title_r = ncol(plot_table)
}
if (caption_pos == "panel") {
caption_l = min(pans$l)
caption_r = max(pans$r)
} else {
caption_l = 1
caption_r = ncol(plot_table)
}
plot_table <- gtable::gtable_add_rows(plot_table, subtitle_height, pos = 0) # ******
plot_table <- gtable::gtable_add_grob(plot_table, subtitle, name = "subtitle", # ******
t = 1, b = 1, l = title_l, r = title_r, clip = "off")
plot_table <- gtable::gtable_add_rows(plot_table, title_height, pos = 0) # ******
plot_table <- gtable::gtable_add_grob(plot_table, title, name = "title", # ******
t = 1, b = 1, l = title_l, r = title_r, clip = "off")
plot_table <- gtable::gtable_add_rows(plot_table, caption_height, pos = -1) # ******
plot_table <- gtable::gtable_add_grob(plot_table, caption, name = "caption", # ******
t = -1, b = -1, l = caption_l, r = caption_r, clip = "off")
plot_table <- gtable::gtable_add_rows(plot_table, unit(0, 'pt'), pos = 0) # ******
plot_table <- gtable::gtable_add_cols(plot_table, unit(0, 'pt'), pos = 0) # ******
plot_table <- gtable::gtable_add_rows(plot_table, unit(0, 'pt'), pos = -1) # ******
plot_table <- gtable::gtable_add_cols(plot_table, unit(0, 'pt'), pos = -1) # ******
tag_pos <- theme$plot.tag.position %||% "topleft"
if (length(tag_pos) == 2) tag_pos <- "manual"
valid_pos <- c("topleft", "top", "topright", "left", "right", "bottomleft",
"bottom", "bottomright")
if (!(tag_pos == "manual" || tag_pos %in% valid_pos)) {
abort(glue("plot.tag.position should be a coordinate or one of ",
glue_collapse(valid_pos, ', ', last = " or ")))
}
if (tag_pos == "manual") {
xpos <- theme$plot.tag.position[1]
ypos <- theme$plot.tag.position[2]
tag_parent <- justify_grobs(tag, x = xpos, y = ypos,
hjust = theme$plot.tag$hjust,
vjust = theme$plot.tag$vjust,
int_angle = theme$plot.tag$angle,
debug = theme$plot.tag$debug)
plot_table <- gtable_add_grob(plot_table, tag_parent, name = "tag", t = 1,
b = nrow(plot_table), l = 1,
r = ncol(plot_table), clip = "off")
} else {
# Widths and heights are reassembled below instead of assigning into them
# in order to avoid bug in grid 3.2 and below.
if (tag_pos == "topleft") {
plot_table$widths <- grid::unit.c(tag_width, plot_table$widths[-1]) # ******
plot_table$heights <- grid::unit.c(tag_height, plot_table$heights[-1]) # ******
plot_table <- gtable::gtable_add_grob(plot_table, tag, name = "tag", # ******
t = 1, l = 1, clip = "off")
} else if (tag_pos == "top") {
plot_table$heights <- grid::unit.c(tag_height, plot_table$heights[-1]) # ******
plot_table <- gtable::gtable_add_grob(plot_table, tag, name = "tag", # ******
t = 1, l = 1, r = ncol(plot_table),
clip = "off")
} else if (tag_pos == "topright") {
plot_table$widths <- grid::unit.c(plot_table$widths[-ncol(plot_table)], tag_width) # ******
plot_table$heights <- grid::unit.c(tag_height, plot_table$heights[-1]) # ******
plot_table <- gtable::gtable_add_grob(plot_table, tag, name = "tag", # ******
t = 1, l = ncol(plot_table), clip = "off")
} else if (tag_pos == "left") {
plot_table$widths <- grid::unit.c(tag_width, plot_table$widths[-1]) # ******
plot_table <- gtable::gtable_add_grob(plot_table, tag, name = "tag", # ******
t = 1, b = nrow(plot_table), l = 1,
clip = "off")
} else if (tag_pos == "right") {
plot_table$widths <- grid::unit.c(plot_table$widths[-ncol(plot_table)], tag_width) # ******
plot_table <- gtable::gtable_add_grob(plot_table, tag, name = "tag", # ******
t = 1, b = nrow(plot_table), l = ncol(plot_table),
clip = "off")
} else if (tag_pos == "bottomleft") {
plot_table$widths <- grid::unit.c(tag_width, plot_table$widths[-1]) # ******
plot_table$heights <- grid::unit.c(plot_table$heights[-nrow(plot_table)], tag_height) # ******
plot_table <- gtable::gtable_add_grob(plot_table, tag, name = "tag", # ******
t = nrow(plot_table), l = 1, clip = "off")
} else if (tag_pos == "bottom") {
plot_table$heights <- grid::unit.c(plot_table$heights[-nrow(plot_table)], tag_height) # ******
plot_table <- gtable::gtable_add_grob(plot_table, tag, name = "tag", # ******
t = nrow(plot_table), l = 1, r = ncol(plot_table), clip = "off")
} else if (tag_pos == "bottomright") {
plot_table$widths <- grid::unit.c(plot_table$widths[-ncol(plot_table)], tag_width) # ******
plot_table$heights <- grid::unit.c(plot_table$heights[-nrow(plot_table)], tag_height) # ******
plot_table <- gtable::gtable_add_grob(plot_table, tag, name = "tag", # ******
t = nrow(plot_table), l = ncol(plot_table), clip = "off")
}
}
# Margins
plot_table <- gtable::gtable_add_rows(plot_table, theme$plot.margin[1], pos = 0) # ******
plot_table <- gtable::gtable_add_cols(plot_table, theme$plot.margin[2]) # ******
plot_table <- gtable::gtable_add_rows(plot_table, theme$plot.margin[3]) # ******
plot_table <- gtable::gtable_add_cols(plot_table, theme$plot.margin[4], pos = 0) # ******
if (inherits(theme$plot.background, "element")) {
plot_table <- gtable::gtable_add_grob(plot_table, # ******
element_render(theme, "plot.background"),
t = 1, l = 1, b = -1, r = -1, name = "background", z = -Inf)
plot_table$layout <- plot_table$layout[c(nrow(plot_table$layout), 1:(nrow(plot_table$layout) - 1)),]
plot_table$grobs <- plot_table$grobs[c(nrow(plot_table$layout), 1:(nrow(plot_table$layout) - 1))]
}
# Record the final state of the gtable
all_states$final <- plot_table # ******
return(all_states) # ******
}