grid.pattern_stripe: Stripe patterned grobs

Description Usage Arguments Value See Also Examples

View source: R/pattern-geometry-stripe.R

Description

grid.pattern_stripe() draws a stripe pattern onto the graphic device.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
grid.pattern_stripe(
  x = c(0, 0, 1, 1),
  y = c(1, 0, 0, 1),
  id = 1L,
  ...,
  colour = gp$col %||% "grey20",
  fill = gp$fill %||% "grey80",
  angle = 30,
  density = 0.2,
  spacing = 0.05,
  xoffset = 0,
  yoffset = 0,
  alpha = gp$alpha %||% NA_real_,
  linetype = gp$lty %||% 1,
  size = gp$lwd %||% 1,
  grid = "square",
  default.units = "npc",
  name = NULL,
  gp = gpar(),
  draw = TRUE,
  vp = NULL
)

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 id belong to the same boundary.

...

Currently ignored

colour

Stroke colour

fill

Fill colour

angle

Rotation angle in degrees

density

Approx. fraction of area the pattern fills.

spacing

Spacing between repetitions of pattern ('snpc' units between 0 and 1).

xoffset

Shift pattern along x axis ('snpc' units between 0 and 1).

yoffset

Shift pattern along y axis ('snpc' units between 0 and 1).

alpha

Alpha (between 0 and 1) or NA (default, preserves colors' alpha value).

linetype

Stroke linetype

size

Stroke linewidth

grid

Adjusts placement and density of certain graphical elements. "square" (default) is a square grid. "hex" is a hexagonal grid suitable for hexagonal and triangular tiling. "hex_circle" is a hexagonal grid suitable for circle packing.

default.units

A string indicating the default units to use if x or y are only given as numeric vectors.

name

A character identifier.

gp

An object of class "gpar", typically the output from a call to the function gpar. This is basically a list of graphical parameter settings.

draw

A logical value indicating whether graphics output should be produced.

vp

A Grid viewport object (or NULL).

Value

A grid grob object invisibly. If draw is TRUE then also draws to the graphic device as a side effect.

See Also

[grid.pattern_crosshatch()] and [grid.pattern_weave()] for overlaying stripes as well as the ggpattern documentation: https://coolbutuseless.github.io/package/ggpattern/articles/pattern-stripe.html

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
  if (require("grid")) {
    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))
    grid.pattern_stripe(x_hex, y_hex, colour = "black",
                        fill = c("red", "blue"), density = 0.4)

    # Can alternatively use "gpar()" to specify colour and line attributes
    grid.newpage()
    grid.pattern_stripe(x_hex, y_hex, density = 0.3,
                        gp = gpar(col = "blue", fill = "yellow"))
  }

gridpattern documentation built on July 17, 2021, 9:07 a.m.