SVGDocument: SVGDocument Class

In coolbutuseless/minisvg: SVG Document Builder

Description

SVGDocument Class

SVGDocument Class

Details

This is a specialized subclass of SVGElement containing some methods specific to the top level SVG node.

Has only been tested with MacOS and Rstudio

Super classes

minisvg::SVGNode -> minisvg::SVGElement -> SVGDocument

Public fields

width, height

dimensions of document

Active bindings

width, height

dimensions of document

Methods

Public methods

• SVGDocument$new()

• SVGDocument$save_html()

• SVGDocument$show()

• SVGDocument$inline_css()

• SVGDocument$print()

• SVGDocument$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::SVGElement$a()

• minisvg::SVGElement$add()

• minisvg::SVGElement$animate()

• minisvg::SVGElement$animateMotion()

• minisvg::SVGElement$animateTransform()

• minisvg::SVGElement$append()

• minisvg::SVGElement$as_character()

• 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 a new SVG document

Usage

SVGDocument$new(
  ...,
  width = 400,
  height = 400,
  viewBox = NULL,
  preserveAspectRatio = NULL,
  xmlns = "http://www.w3.org/2000/svg",
  xmlns_xlink = "http://www.w3.org/1999/xlink"
)

Arguments

...

further arguments. Named arguments treated as attributes, unnamed arguments treated as child nodes

width, height

SVG dimensions. default: 400x400

viewBox

if NULL, then set to "0 0 width height"

preserveAspectRatio, xmlns, xmlns_xlink

standard SVG attributes

---

Method save_html()

Save a complete HTML document containing this SVG document

Usage

SVGDocument$save_html(filename)

Arguments

filename

HTML filename

---

Method show()

Render the SVG in the current viewer.

Usage

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

Arguments

viewer

which viewer to use?

---

Method inline_css()

Use the supplied string as the inline CSS for this document

Usage

SVGDocument$inline_css(css)

Arguments

css

string containing CSS

---

Method print()

Print the SVGDocument object

Usage

SVGDocument$print(include_declaration = TRUE, ...)

Arguments

include_declaration

Include the XML declaration? default: TRUE

...

other arguments passed to $as_character()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SVGDocument$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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