SVGPattern: SVGPattern Class

In coolbutuseless/minisvg: SVG Document Builder

Description

SVGPattern Class

SVGPattern Class

Details

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

SVGPattern objects may also have their own 'filter_def' filter definition.

Super classes

minisvg::SVGNode -> minisvg::SVGElement -> SVGPattern

Public fields

filter_def

A filter definition to accompany this pattern

Methods

Public methods

• SVGPattern$new()

• SVGPattern$as_full_svg()

• SVGPattern$save_full_svg()

• SVGPattern$as_character()

• SVGPattern$show()

• SVGPattern$clone()

Inherited methods

• minisvg::SVGNode$add_css()

• minisvg::SVGNode$add_css_url()

• minisvg::SVGNode$add_js_code()

• minisvg::SVGNode$add_js_url()

• minisvg::SVGNode$get_css_decls()

• minisvg::SVGNode$get_css_style()

• minisvg::SVGNode$get_css_urls()

• minisvg::SVGNode$get_js_code()

• minisvg::SVGNode$get_js_style()

• minisvg::SVGNode$get_js_urls()

• minisvg::SVGNode$print()

• minisvg::SVGElement$a()

• minisvg::SVGElement$add()

• minisvg::SVGElement$animate()

• minisvg::SVGElement$animateMotion()

• minisvg::SVGElement$animateTransform()

• minisvg::SVGElement$append()

• minisvg::SVGElement$as_character_inner()

• minisvg::SVGElement$circle()

• minisvg::SVGElement$clipPath()

• minisvg::SVGElement$copy()

• minisvg::SVGElement$defs()

• minisvg::SVGElement$desc()

• minisvg::SVGElement$discard()

• minisvg::SVGElement$ellipse()

• minisvg::SVGElement$feBlend()

• minisvg::SVGElement$feColorMatrix()

• minisvg::SVGElement$feComponentTransfer()

• minisvg::SVGElement$feComposite()

• minisvg::SVGElement$feConvolveMatrix()

• minisvg::SVGElement$feDiffuseLighting()

• minisvg::SVGElement$feDisplacementMap()

• minisvg::SVGElement$feFlood()

• minisvg::SVGElement$feFuncA()

• minisvg::SVGElement$feFuncB()

• minisvg::SVGElement$feFuncG()

• minisvg::SVGElement$feFuncR()

• minisvg::SVGElement$feGaussianBlur()

• minisvg::SVGElement$feImage()

• minisvg::SVGElement$feMerge()

• minisvg::SVGElement$feMergeNode()

• minisvg::SVGElement$feMorphology()

• minisvg::SVGElement$feOffset()

• minisvg::SVGElement$feSpecularLighting()

• minisvg::SVGElement$feTile()

• minisvg::SVGElement$feTurbulence()

• minisvg::SVGElement$filter()

• minisvg::SVGElement$find()

• minisvg::SVGElement$foreignObject()

• minisvg::SVGElement$g()

• minisvg::SVGElement$has_attribs()

• minisvg::SVGElement$image()

• minisvg::SVGElement$line()

• minisvg::SVGElement$linearGradient()

• minisvg::SVGElement$marker()

• minisvg::SVGElement$mask()

• minisvg::SVGElement$matrix()

• minisvg::SVGElement$mpath()

• minisvg::SVGElement$path()

• minisvg::SVGElement$pattern()

• minisvg::SVGElement$polygon()

• minisvg::SVGElement$polyline()

• minisvg::SVGElement$radialGradient()

• minisvg::SVGElement$rebuild_child_list()

• minisvg::SVGElement$rect()

• minisvg::SVGElement$remove()

• minisvg::SVGElement$reset_transform()

• minisvg::SVGElement$rotate()

• minisvg::SVGElement$save()

• minisvg::SVGElement$scale()

• minisvg::SVGElement$script()

• minisvg::SVGElement$set()

• minisvg::SVGElement$skewX()

• minisvg::SVGElement$skewY()

• minisvg::SVGElement$stop()

• minisvg::SVGElement$style()

• minisvg::SVGElement$switch()

• minisvg::SVGElement$symbol()

• minisvg::SVGElement$text()

• minisvg::SVGElement$textPath()

• minisvg::SVGElement$title()

• minisvg::SVGElement$translate()

• minisvg::SVGElement$update()

• minisvg::SVGElement$update_child_list()

• minisvg::SVGElement$use()

---

Method new()

Initialise an SVGPattern object

Usage

SVGPattern$new(..., name = "pattern")

Arguments

...

Further arguments passed to SVGElement$new()

name

defaults to 'pattern', but some gradients may also be used here

---

Method as_full_svg()

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

Usage

SVGPattern$as_full_svg(width = 400, height = width)

Arguments

height, width

dimensions of SVG wrapper around this pattern

---

Method save_full_svg()

Save the SVG for this pattern in a full SVG document

Usage

SVGPattern$save_full_svg(filename, include_declaration = TRUE, ...)

Arguments

filename

filename for output

include_declaration

Include leading XML declaration. default: TRUE

...

Further arguments passed to SVGPattern$as_full_svg()

---

Method as_character()

Recursively convert this SVGElement and children to text

Usage

SVGPattern$as_character(..., depth = 0, include_declaration = FALSE)

Arguments

...

ignored

depth

recursion depth. default: 0

include_declaration

Include the leading XML declaration? default: FALSE

Returns

single character string

---

Method show()

Render this pattern in the context of a complete SVG document

Usage

SVGPattern$show(..., viewer = getOption("viewer", utils::browseURL))

Arguments

...

Further arguments passed to SVGPattern$save_full_svg()

viewer

viewer.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SVGPattern$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
a <- SVGPattern$new()
f <- stag$filter(id = "turbulence-filter", stag$feTurbulence(...))
a$filter_def <- f

## End(Not run)

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