SVGFilter: SVGFilter Class

Description Details Super classes Methods Examples

Description

SVGFilter Class

SVGFilter Class

Details

This is a slightly specialized subclass of SVGElement which has methods to specifically handle SVG <filter> nodes

Super classes

minisvg::SVGNode -> minisvg::SVGElement -> SVGFilter

Methods

Public methods

Inherited methods

Method new()

Initialise an SVGFilter object

Usage
SVGFilter$new(..., name = "filter")
Arguments
...

Further arguments passed to SVGElement$new()

name

defaults to 'filter'


Method as_full_svg()

Wrap the SVG for this filter in a full SVG document and return the text

Usage
SVGFilter$as_full_svg(width = 400, height = width)
Arguments
height, width

dimensions of SVG wrapper around this filter


Method save_full_svg()

Save the SVG for this filter in a full SVG document

Usage
SVGFilter$save_full_svg(filename, include_declaration = TRUE, ...)
Arguments
filename

filename for output

include_declaration

Include leading XML declaration. default: TRUE

...

Further arguments passed to SVGFilter$as_full_svg()


Method show()

Render this filter in the context of a complete SVG document

Usage
SVGFilter$show(..., viewer = getOption("viewer", utils::browseURL))
Arguments
...

Further arguments passed to SVGFilter$save_full_svg()

viewer

viewer.


Method clone()

The objects of this class are cloneable with this method.

Usage
SVGFilter$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

1
2
3
4
## Not run: 
f <- SVGFilter$new(id = "turbulence-filter", stag$feTurbulence(...))

## End(Not run)

coolbutuseless/minisvg documentation built on May 2, 2020, 3:15 a.m.