R: Associate a filter effect with a grid grob.

grid.filter {gridSVG} | R Documentation

## Associate a filter effect with a grid grob.

### Description

Creates a `filtered.grob` object which is a normal grid grob, with a filter effect applied to it Used in conjunction with `registerFilter`, to produce an SVG document containing graphical elements with filter effects.

### Usage

    grid.filter(path, filter = NULL, label = NULL,
                group = TRUE, redraw = FALSE,
                strict = FALSE, grep = FALSE, global = FALSE)
    filterGrob(x, filter = NULL, label = NULL, group = TRUE)

### Arguments

`x` | A grob to filter.
`path` | A grob path specifying a drawn grob.
`filter` | A `filter` object, provided by the `filterEffect` function. Provides the definition of a filter effect that will be applied to `x` or `path`.
`label` | A label that is associated with a definition of a filter effect. This is the label used to create a filter effect definition with `registerFilter`.
`group` | A logical vector that indicates whether the filter effect 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 filter effect that has been supplied to `registerFilter`. If `filter` is specified it will be used as the filter effect applied to each grob. If both are specified, it will attempt to define the filter effect with the given label, as well as applying the filter effect to the appropriate grobs.

### Value

A `filtered.grob` object (for `filterGrob`).

### Author(s)

Simon Potter

### See Also

`registerFilter`, `filterEffect`.

[Package gridSVG version 1.6-0 Index]