gridSVG (version 1.5-0)

grid.clipPath: Apply a clipping path to a grid grob.

Description

Creates a pathClipped.grob object which is a normal grid grob, with a clipping path applied to it. Used in conjunction with registerClipPath, to produce an SVG document containing graphical elements with masked content.

Usage

grid.clipPath(path, clippath = NULL, label = NULL, group = TRUE, redraw = FALSE, strict = FALSE, grep = FALSE, global = FALSE)
clipPathGrob(x, clippath = NULL, label = NULL, group = TRUE)

Arguments

x

A grob to clip.

path

A grob path specifying a drawn grob.

clippath

A grob defining a clipping region.

label

A label that is associated with a definition of a clipping path. This is the label used to make a clipping path definition with registerClipPath.

group

A logical vector that indicates whether the opacity mask 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.

Value

A pathClipped.grob object (for clipPathGrob).

Details

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

See Also

registerClipPath, pushClipPath.