grid.patternFill: Associate a pattern fill with a grid grob

View source: R/patterns.R

grid.patternFillR Documentation

Associate a pattern fill with a grid grob

Description

Creates a patternFilled.grob object which is a normal grid grob, with a pattern fill used in place of a regular fill. Used in conjunction with registerPatternFill, to produce an SVG document containing graphical elements with pattern fills.

Usage

grid.patternFill(path, pattern = NULL, label = NULL,
                 alpha = 1, group = TRUE, redraw = FALSE,
                 strict = FALSE, grep = FALSE, global = FALSE)
patternFillGrob(x, pattern = NULL, label = NULL,
                alpha = 1, group = TRUE)

Arguments

x

A grob to add a pattern fill to.

pattern

A pattern object, provided by the pattern function. Provides the definition of a pattern fill that will be applied to x or path.

label

A label that is associated with a definition of a pattern fill. This is the label used to create a pattern fill definition with registerPatternFill.

path

A grob path specifying a drawn grob.

alpha

The alpha channel for transparency. A value between 0 and 1.

group

A logical vector that indicates whether the pattern fill should be applied to the overall parent group for the relevant SVG element, or to individual SVG elements.

redraw

A logical value to indicate whether to redraw the grob.

strict

A boolean indicating whether the path must be matched exactly.

grep

Whether the path should be treated as a regular expression.

global

A boolean indicating whether the function should affect just the first match of the path, or whether all matches should be affected.

Details

If label is specified, uses a pattern that has been supplied to registerPatternFill. If pattern is specified it will be used as the fill pattern applied to each grob. If both are specified, it will attempt to define the pattern with the given label, as well as applying a pattern fill to the appropriate grobs.

Value

A patternFilled.grob object (for patternFillGrob).

Author(s)

Simon Potter

See Also

registerPatternFill


gridSVG documentation built on March 18, 2022, 7:13 p.m.