grid.pattern_placeholder {gridpattern} | R Documentation |
Placeholder image patterned grobs
Description
grid.pattern_placeholder()
draws a placeholder image pattern onto the graphic device.
names_placeholder
are character vectors of supported placeholder types.
Usage
grid.pattern_placeholder(
x = c(0, 0, 1, 1),
y = c(1, 0, 0, 1),
id = 1L,
...,
type = "bear",
alpha = gp$alpha %||% NA_real_,
aspect_ratio = 1,
key_scale_factor = 1,
res = getOption("ggpattern_res", 72),
default.units = "npc",
name = NULL,
gp = gpar(),
draw = TRUE,
vp = NULL
)
names_placeholder
Arguments
x |
A numeric vector or unit object specifying x-locations of the pattern boundary. |
y |
A numeric vector or unit object specifying y-locations of the pattern boundary. |
id |
A numeric vector used to separate locations in x, y into multiple boundaries.
All locations within the same |
... |
Currently ignored. |
type |
Image source. |
alpha |
Alpha (between 0 and 1) or |
aspect_ratio |
Override aspect ratio. |
key_scale_factor |
Additional scale factor for legend. |
res |
Assumed resolution (in pixels per graphic device inch) to use when creating array pattern. |
default.units |
A string indicating the default units to use if |
name |
A character identifier. |
gp |
An object of class |
draw |
A logical value indicating whether graphics output should be produced. |
vp |
A Grid viewport object (or NULL). |
Format
An object of class character
of length 22.
Value
A grid grob object invisibly. If draw
is TRUE
then also draws to the graphic device as a side effect.
See Also
reset_image_cache()
resets the image cache used by grid.pattern_image()
and grid.pattern_placeholder()
.
Examples
if (requireNamespace("magick")) {
x_hex <- 0.5 + 0.5 * cos(seq(2 * pi / 4, by = 2 * pi / 6, length.out = 6))
y_hex <- 0.5 + 0.5 * sin(seq(2 * pi / 4, by = 2 * pi / 6, length.out = 6))
# requires internet connection to download from placeholder image websites
try(grid.pattern_placeholder(x_hex, y_hex, type="bear"))
}
print(names_placeholder)