R: Apply a clipping context to the current viewport.

pushClipPath {gridSVG}

R Documentation

Apply a clipping context to the current viewport.

Description

This function is intended to be used similarly to grid.clip. The only difference is that a non-rectangular clipping region can be applied.

Usage

pushClipPath(clippath = NULL, label = NULL, name = NULL, draw = TRUE)
popClipPath()

Arguments

`clippath`	A graphics object, used as the definition of a clipping path.
`label`	A label for a defined reference.
`name`	A character identifier for the grob applying the clipping context.
`draw`	A logical value indicating whether graphics output should be produced.

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 new clipping context for the current viewport. If both are specified, it will attempt to define the clipping path with the given label, as well as adding the clipping path as a clipping context for the current viewport.

popClipPath is an alias for popContext

Value

A pushClipPath grob. The value is returned invisibly.

Author(s)

Simon Potter