registerClipPath: Create the definition of a non-rectangular clipping path.

Description Usage Arguments Details Value Author(s) See Also

View source: R/clipmask.R

Description

A feature of SVG is that elements can be clipped to by more than just a rectangular region. Most graphical elements can be drawn. The purpose of these functions is to define a more sophisticated clipping path that will be applied until the current viewport (or context, see popContext) is popped.

Usage

1
2
clipPath(grob)
registerClipPath(label, clippath)

Arguments

grob

A grid grob.

label

A character identifier that will be used to reference this definition.

clippath

A clipPath object produced by clipPath that defines a clipping path region.

Details

A clipping path will be drawn within the current viewport at the time of definition (if the grob has no vp specified).

Most grobs can be used for clipping but there are some limitations on what will actually be used for clipping. In general though, anything that is drawn as the clipping path will have the union of its drawn regions become the new region that the current viewport (or grob) will clip to.

The limitations are as follows:

Value

None

Author(s)

Simon Potter

See Also

popContext, grid.clipPath, pushClipPath, grid.clip


gridSVG documentation built on April 28, 2020, 9:05 a.m.