R: Associate a gradient fill with a grid grob

grid.gradientFill {gridSVG} | R Documentation

## Associate a gradient fill with a grid grob

### Description

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

### Usage

    grid.gradientFill(path, gradient = NULL, label = NULL,
                      alpha = 1, group = TRUE, redraw = FALSE,
                      strict = FALSE, grep = FALSE, global = FALSE)
    gradientFillGrob(x, gradient = NULL, label = NULL,
                     alpha = 1, group = TRUE)

### Arguments

`x` | A grob to add a pattern fill to.
`path` | A grob path specifying a drawn grob.
`gradient` | A `gradient` object, provided by the `linearGradient` and `radialGradient` functions. Provides the definition of a gradient fill that will be applied to `x` or `path`.
`label` | A label that is associated with a definition of a gradient fill. This is the label used to create a gradient fill definition with `registerGradientFill`.
`alpha` | The alpha channel for transparency. A value between 0 and 1.
`group` | A logical vector that indicates whether the gradient 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 gradient that has been supplied to `registerGradientFill`. If `gradient` is specified it will be used as the gradient fill applied to each grob. If both are specified, it will attempt to define the gradient with the given label, as well as applying a gradient fill to the appropriate grobs.

### Value

A `gradientFilled.grob` object (for `gradientFillGrob`).

### Author(s)

Simon Potter

### See Also

`linearGradient`, `radialGradient`, `registerGradientFill`

[Package gridSVG version 1.6-0 Index]