API Reference Vectored v#0.4.0

Copy Markdown View Source

Modules

Vectored is a library for creating and rendering SVG documents using a functional API.

The <circle> element is an SVG basic shape used to draw circles.

The <clipPath> element defines a shape that is used to "cut out" parts of other elements.

The <defs> element is a storage container for graphical objects that are not intended to be rendered directly.

The <desc> element provides a detailed text description of an element.

Core macros and helpers for defining SVG elements.

The <ellipse> element is an SVG basic shape used to draw ellipses.

The <g> element is a container used to group other SVG elements.

The <image> element allows including external images (raster or SVG) inside an SVG document.

The <line> element is an SVG basic shape used to draw a straight line between two points.

The <linearGradient> element defines a linear transition between colors.

The <marker> element defines graphics (like arrowheads) that can be attached to the start, middle, or end of a path or line.

The <mask> element defines an alpha mask for compositing objects into the background.

The <path> element is the most versatile SVG shape, capable of defining any shape.

The <pattern> element defines a graphic that can be repeated (tiled) to fill an area.

The <polygon> element defines a closed shape consisting of a set of connected straight line segments.

The <polyline> element is an SVG basic shape that creates straight lines connecting several points.

The <radialGradient> element defines a transition between colors that radiates from a central point.

The <rect> element is an SVG basic shape used to create rectangles.

The <stop> element defines a color and its opacity at a fixed offset along a gradient.

The <svg> element is a container that defines a new coordinate system and viewport.

The <symbol> element defines a graphical template that can be instantiated multiple times using the <use> element.

The <text> element renders a graphics element consisting of text.

The <title> element provides a short, human-readable name for an element.

The <tspan> element defines a subtext within a <text> element.

The <use> element duplicates a graphical object defined elsewhere in the SVG.

Protocol for rendering data structures to SVG internal representations.