/
default.R
205 lines (190 loc) · 7.14 KB
/
default.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
#' @include girafe_options.R fonts.R utils_css.R
girafe_global <- new.env(parent = emptyenv())
css_default_hover <- girafe_css_bicolor(primary = "orange", secondary = "black")
css_default_selection <- girafe_css_bicolor(primary = "red", secondary = "black")
default_girafe_settings <- list(
fonts = default_fontname(),
opts_sizing = opts_sizing(width = 1),
opts_tooltip = opts_tooltip(
css = "padding:5px;background:black;color:white;border-radius:2px;text-align:left;",
offx = 10, offy = 10),
opts_hover = opts_hover(css = css_default_hover, reactive = TRUE),
opts_hover_key = opts_hover_key(css = css_default_hover, reactive = TRUE),
opts_hover_theme = opts_hover_theme(css = css_default_hover, reactive = TRUE),
opts_hover_inv = opts_hover_inv(css = ""),
opts_selection = opts_selection(css = css_default_selection),
opts_selection_inv = opts_selection_inv(),
opts_selection_key = opts_selection_key(css = css_default_selection),
opts_selection_theme = opts_selection_theme(css = css_default_selection),
opts_zoom = opts_zoom(),
opts_toolbar = opts_toolbar()
)
girafe_global$defaults <- default_girafe_settings
#' @export
#' @title Modify defaults girafe animation options
#'
#' @description girafe animation options (see [girafe_defaults()])
#' are automatically applied to every girafe you produce.
#' Use `set_girafe_defaults()` to override them. Use `init_girafe_defaults()`
#' to re-init all values with the package defaults.
#' @family girafe animation options
#' @param fonts default values for `fonts`, see argument `fonts`
#' of [dsvg()] function.
#' @param opts_sizing default values for [opts_sizing()] used
#' in argument `options` of `girafe()` function.
#' @param opts_tooltip default values for [opts_tooltip()] used
#' in argument `options` of `girafe()` function.
#' @param opts_hover default values for [opts_hover()] used in argument `options` of `girafe()` function.
#' @param opts_hover_key default values for [opts_hover_key()] used in argument `options` of `girafe()` function.
#' @param opts_hover_inv default values for [opts_hover_inv()] used in argument `options` of `girafe()` function.
#' @param opts_hover_theme default values for [opts_hover_theme()] used in argument `options` of `girafe()` function.
#' @param opts_selection default values for [opts_selection()] used in argument `options` of `girafe()` function.
#' @param opts_selection_inv default values for [opts_selection_inv()] used in argument `options` of `girafe()` function.
#' @param opts_selection_key default values for [opts_selection_key()] used in argument `options` of `girafe()` function.
#' @param opts_selection_theme default values for [opts_selection_theme()] used in argument `options` of `girafe()` function.
#' @param opts_zoom default values for [opts_zoom()] used in argument `options` of `girafe()` function.
#' @param opts_toolbar default values for [opts_toolbar()] used in argument `options` of `girafe()` function.
#' @examples
#' library(ggplot2)
#'
#' set_girafe_defaults(
#' opts_hover = opts_hover(css = "r:10px;"),
#' opts_hover_inv = opts_hover_inv(),
#' opts_sizing = opts_sizing(rescale = FALSE, width = .8),
#' opts_tooltip = opts_tooltip(opacity = .7,
#' offx = 20, offy = -10,
#' use_fill = TRUE, use_stroke = TRUE,
#' delay_mouseout = 1000),
#' opts_toolbar = opts_toolbar(position = "top", saveaspng = FALSE),
#' opts_zoom = opts_zoom(min = .8, max = 7)
#' )
#'
#' init_girafe_defaults()
set_girafe_defaults <- function(
fonts = NULL,
opts_sizing = NULL,
opts_tooltip = NULL,
opts_hover = NULL,
opts_hover_key = NULL,
opts_hover_inv = NULL,
opts_hover_theme = NULL,
opts_selection = NULL,
opts_selection_inv = NULL,
opts_selection_key = NULL,
opts_selection_theme = NULL,
opts_zoom = NULL,
opts_toolbar = NULL){
x <- list()
if( !is.null(fonts) ){
x$fonts <- fonts
}
if( !is.null(opts_sizing) ){
x$opts_sizing <- opts_sizing
}
if( !is.null(opts_tooltip) ){
x$opts_tooltip <- opts_tooltip
}
if( !is.null(opts_hover) ){
x$opts_hover <- opts_hover
}
if( !is.null(opts_hover_inv) ){
x$opts_hover_inv <- opts_hover_inv
}
if( !is.null(opts_hover_key) ){
x$opts_hover_key <- opts_hover_key
}
if( !is.null(opts_hover_theme) ){
x$opts_hover_theme <- opts_hover_theme
}
if( !is.null(opts_selection) ){
x$opts_selection <- opts_selection
}
if( !is.null(opts_selection_inv) ){
x$opts_selection_inv <- opts_selection_inv
}
if( !is.null(opts_selection_key) ){
x$opts_selection_key <- opts_selection_key
}
if( !is.null(opts_selection_theme) ){
x$opts_selection_theme <- opts_selection_theme
}
if( !is.null(opts_zoom) ){
x$opts_zoom <- opts_zoom
}
if( !is.null(opts_toolbar) ){
x$opts_toolbar <- opts_toolbar
}
girafe_defaults <- girafe_defaults()
girafe_new_defaults <- modifyList(girafe_defaults, x)
girafe_global$defaults <- girafe_new_defaults
invisible(girafe_defaults)
}
#' @export
#' @title Re-init animation defaults options
#'
#' @description Re-init all defaults options with the package defaults.
#' @family girafe animation options
init_girafe_defaults <- function(){
x <- default_girafe_settings
girafe_global$defaults <- x
class(x) <- "girafe_defaults"
invisible(x)
}
#' @export
#' @title Get girafe defaults formatting properties
#'
#' @description The current formatting properties
#' are automatically applied to every girafe you produce.
#' These default values are returned by this function.
#' @param name optional, option's name to return, one of
#' 'fonts', 'opts_sizing', 'opts_tooltip', 'opts_hover', 'opts_hover_key',
#' 'opts_hover_inv', 'opts_hover_theme', 'opts_selection',
#' 'opts_selection_inv', 'opts_selection_key', 'opts_selection_theme',
#' 'opts_zoom', 'opts_toolbar'.
#' @examples
#' girafe_defaults()
#' @return a list containing default values or an
#' element selected with argument `name`.
#' @family girafe animation options
girafe_defaults <- function(name = NULL){
x <- girafe_global$defaults
if (!is.null(name) && !is_valid_string_non_empty(name)) {
abort("`name` must be a non-empty scalar character", call = NULL)
} else if (!is.null(name) && is_valid_string_non_empty(name)) {
x[[name]]
} else {
x
}
}
default_width <- function(default = 6){
if (isTRUE(getOption('knitr.in.progress'))) {
knitr::opts_current$get("fig.width")
} else default
}
default_height <- function(default = 5){
if (isTRUE(getOption('knitr.in.progress'))) {
knitr::opts_current$get("fig.height")
} else default
}
modifyList <- function (x, val, keep.null = FALSE) {
stopifnot(is.list(x), is.list(val))
xnames <- names(x)
vnames <- names(val)
vnames <- vnames[nzchar(vnames)]
if (keep.null) {
for (v in vnames) {
x[v] <- if (v %in% xnames && is.list(x[[v]]) && is.list(val[[v]]))
list(modifyList(x[[v]], val[[v]], keep.null = keep.null))
else val[v]
}
}
else {
for (v in vnames) {
x[[v]] <- if (v %in% xnames && is.list(x[[v]]) &&
is.list(val[[v]]))
modifyList(x[[v]], val[[v]], keep.null = keep.null)
else val[[v]]
}
}
x
}