svg

package
v0.0.0-...-0df215e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 7, 2016 License: MIT, CC-BY-3.0 Imports: 4 Imported by: 0

README

#SVGo: A Go library for SVG generation#

The library generates SVG as defined by the Scalable Vector Graphics 1.1 Specification (http://www.w3.org/TR/SVG11/). Output goes to the specified io.Writer.

Supported SVG elements and functions

Shapes, lines, text

circle, ellipse, polygon, polyline, rect (including roundrects), line, text

Paths

general, arc, cubic and quadratic bezier paths,

Image and Gradients

image, linearGradient, radialGradient,

Transforms

translate, rotate, scale, skewX, skewY

Filter Effects

filter, feBlend, feColorMatrix, feColorMatrix, feComponentTransfer, feComposite, feConvolveMatrix, feDiffuseLighting, feDisplacementMap, feDistantLight, feFlood, feGaussianBlur, feImage, feMerge, feMorphology, feOffset, fePointLight, feSpecularLighting, feSpotLight,feTile, feTurbulence

Metadata elements

desc, defs, g (style, transform, id), marker, mask, pattern, title, (a)ddress, link, script, use

Building and Usage

See svgdef.[svg|png|pdf] for a graphical view of the function calls

Usage: (assuming GOPATH is set)

go get github.com/ajstarks/svgo
go install github.com/ajstarks/svgo/...

You can use godoc to browse the documentation from the command line:

$ godoc github.com/ajstarks/svgo

a minimal program, to generate SVG to standard output.

package main

import (
	"github.com/ajstarks/svgo"
	"os"
)

func main() {
	width := 500
	height := 500
	canvas := svg.New(os.Stdout)
	canvas.Start(width, height)
	canvas.Circle(width/2, height/2, 100)
	canvas.Text(width/2, height/2, "Hello, SVG", "text-anchor:middle;font-size:30px;fill:white")
	canvas.End()
}

Drawing in a web server: (http://localhost:2003/circle)

package main

import (
	"log"
	"github.com/ajstarks/svgo"
	"net/http"
)

func main() {
	http.Handle("/circle", http.HandlerFunc(circle))
	err := http.ListenAndServe(":2003", nil)
	if err != nil {
		log.Fatal("ListenAndServe:", err)
	}
}

func circle(w http.ResponseWriter, req *http.Request) {
  w.Header().Set("Content-Type", "image/svg+xml")
  s := svg.New(w)
  s.Start(500, 500)
  s.Circle(250, 250, 125, "fill:none;stroke:black")
  s.End()
}

You may view the SVG output with a browser that supports SVG (tested on Chrome, Opera, Firefox and Safari), or any other SVG user-agent such as Batik Squiggle.

Graphics Sketching with SVGo and svgplay

Combined with the svgplay command, SVGo can be used to "sketch" with code in a browser.

To use svgplay and SVGo, first go to a directory with your code, and run:

$ svgplay
2014/06/25 22:05:28 ☠ ☠ ☠ Warning: this server allows a client connecting to 127.0.0.1:1999 to execute code on this computer ☠ ☠ ☠

Next open your browser to the svgplay server you just started. svgplay only listens on localhost, and uses port 1999 (guess which year SVG was first introduced) by default

http://localhost:1999/

Enter your code in the textarea, and when you are ready to run press Shift--Enter. The code will be compiled, with the results on the right. To update, change the code and repeat. Note that compilation errors are shown in red under the code. In order for svgplay/SVGo to work, make sure that the io.Writer specified with the New function is os.Stdout.

If you want to sketch with an existing file, enter its URL:

http://localhost:1999/foo.go

SVGplay

SVGo Papers and presentations

Tutorial Video

A video describing how to use the package can be seen on YouTube at http://www.youtube.com/watch?v=ze6O2Dj5gQ4

Package contents

  • svg.go: Library
  • newsvg: Coding template command
  • svgdef: Creates a SVG representation of the API
  • android: The Android logo
  • bubtrail: Bubble trails
  • bulletgraph: Bullet Graphs (via Stephen Few)
  • colortab: Display SVG named colors with RGB values
  • compx: Component diagrams
  • flower: Random "flowers"
  • fontcompare: Compare two fonts
  • f50: Get 50 photos from Flickr based on a query
  • fe: Filter effects
  • funnel: Funnel from transparent circles
  • gradient: Linear and radial gradients
  • html5logo: HTML5 logo with draggable elements
  • imfade: Show image fading
  • lewitt: Version of Sol Lewitt's Wall Drawing 91
  • ltr: Layer Tennis Remixes
  • marker: Test markers
  • paths: Demonstrate SVG paths
  • pattern: Test patterns
  • planets: Show the scale of the Solar system
  • pmap: Proportion maps
  • randcomp: Compare random number generators
  • richter: Gerhard Richter's 256 colors
  • rl: Random lines (port of a Processing demo)
  • skewabc: Skew ABC
  • stockproduct: Visualize product and stock prices
  • svgopher: SVGo Mascot
  • svgplay: SVGo sketching server
  • svgplot: Plot data
  • svgrid: Compose SVG files in a grid
  • tsg: Twitter Search Grid
  • tumblrgrid: Tumblr picture grid
  • turbulence: Turbulence filter effect
  • vismem: Visualize data from files
  • webfonts: "Hello, World" with Google Web Fonts
  • websvg: Generate SVG as a web server

Functions and types

Many functions use x, y to specify an object's location, and w, h to specify the object's width and height. Where applicable, a final optional argument specifies the style to be applied to the object. The style strings follow the SVG standard; name:value pairs delimited by semicolons, or a series of name="value" pairs. For example: "fill:none; opacity:0.3" or fill="none" opacity="0.3" (see: http://www.w3.org/TR/SVG11/styling.html)

The Offcolor type:

type Offcolor struct {
	Offset  uint8
	Color   string
	Opacity float
}

is used to specify the offset, color, and opacity of stop colors in linear and radial gradients

The Filterspec type:

type Filterspec struct {
	In string
	In2 string
	Result string
}

is used to specify inputs and results for filter effects

New(w io.Writer) *SVG

Constructor, Specify the output destination.

Start(w int, h int, attributes ...string)

begin the SVG document with the width w and height h. Optionally add additional elememts (such as additional namespaces or scripting events) http://www.w3.org/TR/SVG11/struct.html#SVGElement

Startview(w, h, minx, miny, vw, vh int)

begin the SVG document with the width w, height h, with a viewBox at minx, miny, vw, vh. http://www.w3.org/TR/SVG11/struct.html#SVGElement

Startunit(w int, h int, unit string, ns ...string)

begin the SVG document, with width and height in the specified units. Optionally add additional elememts (such as additional namespaces or scripting events) http://www.w3.org/TR/SVG11/struct.html#SVGElement

Startpercent(w int, h int, ns ...string)

begin the SVG document, with width and height in percent. Optionally add additional elememts (such as additional namespaces or scripting events) http://www.w3.org/TR/SVG11/struct.html#SVGElement

StartviewUnit(w, h int, unit string, minx, miny, vw, vh int)

begin the SVG document with the width w, height h, in the specified unit, with a viewBox at minx, miny, vw, vh. http://www.w3.org/TR/SVG11/struct.html#SVGElement

End()

end the SVG document

Script(scriptype string, data ...string)

Script defines a script with a specified type, (for example "application/javascript"). if the first variadic argument is a link, use only the link reference. Otherwise, treat variadic arguments as the text of the script (marked up as CDATA). if no data is specified, simply close the script element. http://www.w3.org/TR/SVG/script.html

Group(s ...string)

begin a group, with arbitrary attributes http://www.w3.org/TR/SVG11/struct.html#GElement

Gstyle(s string)

begin a group, with the specified style. http://www.w3.org/TR/SVG11/struct.html#GElement

Gid(s string)

begin a group, with the specified id.

Gtransform(s string)

begin a group, with the specified transform, end with Gend(). http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

Translate(x, y int)

begins coordinate translation to (x,y), end with Gend(). http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

Scale(n float64)

scales the coordinate system by n, end with Gend(). http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

ScaleXY(x, y float64)

scales the coordinate system by x, y. End with Gend(). http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

SkewX(a float64)

SkewX skews the x coordinate system by angle a, end with Gend(). http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

SkewY(a float64)

SkewY skews the y coordinate system by angle a, end with Gend(). http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

SkewXY(ax, ay float64)

SkewXY skews x and y coordinate systems by ax, ay respectively, end with Gend(). http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

Rotate(r float64)

rotates the coordinate system by r degrees, end with Gend(). http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

TranslateRotate(x, y int, r float64)

translates the coordinate system to (x,y), then rotates to r degrees, end with Gend().

RotateTranslate(x, y int, r float64)

rotates the coordinate system r degrees, then translates to (x,y), end with Gend().

Gend()

end the group (must be paired with Gstyle, Gtransform, Gid).

ClipPath(s ...string)

Begin a ClipPath http://www.w3.org/TR/SVG/masking.html#ClippingPaths

ClipEnd()

End a ClipPath http://www.w3.org/TR/SVG/masking.html#ClippingPaths

Def()

begin a definition block. http://www.w3.org/TR/SVG11/struct.html#DefsElement

DefEnd()

end a definition block.

Marker(id string, x, y, w, h int, s ...string)

define a marker http://www.w3.org/TR/SVG11/painting.html#MarkerElement

MarkerEnd()

end a marker

Mask(id string, x int, y int, w int, h int, s ...string)

creates a mask with a specified id, dimension, and optional style. http://www.w3.org/TR/SVG/masking.html

MaskEnd()

ends the Mask element.

Pattern(id string, x, y, width, height int, putype string, s ...string)

define a Pattern with the specified dimensions, the putype can be either "user" or "obj", which sets the patternUnits attribute to be either userSpaceOnUse or objectBoundingBox. http://www.w3.org/TR/SVG11/pservers.html#Patterns

Desc(s string)

specify the text of the description. http://www.w3.org/TR/SVG11/struct.html#DescElement

Title(s string)

specify the text of the title. http://www.w3.org/TR/SVG11/struct.html#TitleElement

Link(href string, title string)

begin a link named "href", with the specified title. http://www.w3.org/TR/SVG11/linking.html#Links

LinkEnd()

end the link.

Use(x int, y int, link string, s ...string)

place the object referenced at link at the location x, y. http://www.w3.org/TR/SVG11/struct.html#UseElement

Shapes

Circle(x int, y int, r int, s ...string)

draw a circle, centered at x,y with radius r. http://www.w3.org/TR/SVG11/shapes.html#CircleElement

Circle

Ellipse(x int, y int, w int, h int, s ...string)

draw an ellipse, centered at x,y with radii w, and h. http://www.w3.org/TR/SVG11/shapes.html#EllipseElement

Ellipse

Polygon(x []int, y []int, s ...string)

draw a series of line segments using an array of x, y coordinates. http://www.w3.org/TR/SVG11/shapes.html#PolygonElement

Polygon

Rect(x int, y int, w int, h int, s ...string)

draw a rectangle with upper left-hand corner at x,y, with width w, and height h. http://www.w3.org/TR/SVG11/shapes.html#RectElement

Rect

CenterRect(x int, y int, w int, h int, s ...string)

draw a rectangle with its center at x,y, with width w, and height h.

Roundrect(x int, y int, w int, h int, rx int, ry int, s ...string)

draw a rounded rectangle with upper the left-hand corner at x,y, with width w, and height h. The radii for the rounded portion is specified by rx (width), and ry (height).

Roundrect

Square(x int, y int, s int, style ...string)

draw a square with upper left corner at x,y with sides of length s.

Square

Paths

Path(p string, s ...style)

draw the arbitrary path as specified in p, according to the style specified in s. http://www.w3.org/TR/SVG11/paths.html

Arc(sx int, sy int, ax int, ay int, r int, large bool, sweep bool, ex int, ey int, s ...string)

draw an elliptical arc beginning coordinate at sx,sy, ending coordinate at ex, ey width and height of the arc are specified by ax, ay, the x axis rotation is r

if sweep is true, then the arc will be drawn in a "positive-angle" direction (clockwise), if false, the arc is drawn counterclockwise.

if large is true, the arc sweep angle is greater than or equal to 180 degrees, otherwise the arc sweep is less than 180 degrees. http://www.w3.org/TR/SVG11/paths.html#PathDataEllipticalArcCommands

Arc

Bezier(sx int, sy int, cx int, cy int, px int, py int, ex int, ey int, s ...string)

draw a cubic bezier curve, beginning at sx,sy, ending at ex,ey with control points at cx,cy and px,py. http://www.w3.org/TR/SVG11/paths.html#PathDataCubicBezierCommands

Bezier

Qbezier(sx int, sy int, cx int, cy int, ex int, ey int, tx int, ty int, s ...string)

draw a quadratic bezier curve, beginning at sx, sy, ending at tx,ty with control points are at cx,cy, ex,ey. http://www.w3.org/TR/SVG11/paths.html#PathDataQuadraticBezierCommands

Qbezier

Qbez(sx int, sy int, cx int, cy int, ex int, ey int, s...string)

draws a quadratic bezier curver, with optional style beginning at sx,sy, ending at ex, sy with the control point at cx, cy. http://www.w3.org/TR/SVG11/paths.html#PathDataQuadraticBezierCommands

Qbez

Lines

Line(x1 int, y1 int, x2 int, y2 int, s ...string)

draw a line segment between x1,y1 and x2,y2. http://www.w3.org/TR/SVG11/shapes.html#LineElement

Line

Polyline(x []int, y []int, s ...string)

draw a polygon using coordinates specified in x,y arrays. http://www.w3.org/TR/SVG11/shapes.html#PolylineElement

Polyline

Image and Text

Image(x int, y int, w int, h int, link string, s ...string)

place at x,y (upper left hand corner), the image with width w, and height h, referenced at link. http://www.w3.org/TR/SVG11/struct.html#ImageElement

Image

Text(x int, y int, t string, s ...string)

Place the specified text, t at x,y according to the style specified in s. http://www.w3.org/TR/SVG11/text.html#TextElement

Textlines(x, y int, s []string, size, spacing int, fill, align string)

Places lines of text in s, starting at x,y, at the specified size, fill, and alignment, and spacing.

Textpath(t string, pathid string, s ...string)

places optionally styled text along a previously defined path. http://www.w3.org/TR/SVG11/text.html#TextPathElement Image

Color

RGB(r int, g int, b int) string

creates a style string for the fill color designated by the (r)ed, g(reen), (b)lue components. http://www.w3.org/TR/css3-color/

RGBA(r int, g int, b int, a float64) string

as above, but includes the color's opacity as a value between 0.0 (fully transparent) and 1.0 (opaque).

Gradients

LinearGradient(id string, x1, y1, x2, y2 uint8, sc []Offcolor)

constructs a linear color gradient identified by id, along the vector defined by (x1,y1), and (x2,y2). The stop color sequence defined in sc. Coordinates are expressed as percentages. http://www.w3.org/TR/SVG11/pservers.html#LinearGradients LinearGradient

RadialGradient(id string, cx, cy, r, fx, fy uint8, sc []Offcolor)

constructs a radial color gradient identified by id, centered at (cx,cy), with a radius of r. (fx, fy) define the location of the focal point of the light source. The stop color sequence defined in sc. Coordinates are expressed as percentages. http://www.w3.org/TR/SVG11/pservers.html#RadialGradients

RadialGradient

Filter Effects

Filter(id string, s ...string)

Filter begins a filter set Standard reference: http://www.w3.org/TR/SVG11/filters.html#FilterElement

Fend()

Fend ends a filter set Standard reference: http://www.w3.org/TR/SVG11/filters.html#FilterElement

FeBlend(fs Filterspec, mode string, s ...string)

FeBlend specifies a Blend filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feBlendElement

FeColorMatrix(fs Filterspec, values [20]float64, s ...string)

FeColorMatrix specifies a color matrix filter primitive, with matrix values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feColorMatrixElement

FeColorMatrixHue(fs Filterspec, value float64, s ...string)

FeColorMatrix specifies a color matrix filter primitive, with hue values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feColorMatrixElement

FeColorMatrixSaturate(fs Filterspec, value float64, s ...string)

FeColorMatrix specifies a color matrix filter primitive, with saturation values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feColorMatrixElement

FeColorMatrixLuminence(fs Filterspec, s ...string)

FeColorMatrix specifies a color matrix filter primitive, with luminence values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feColorMatrixElement

FeComponentTransfer()

FeComponentTransfer begins a feComponent filter Element> Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

FeCompEnd()

FeCompEnd ends a feComponent filter Element>

FeComposite(fs Filterspec, operator string, k1, k2, k3, k4 int, s ...string)

FeComposite specifies a feComposite filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feCompositeElement

FeConvolveMatrix(fs Filterspec, matrix [9]int, s ...string)

FeConvolveMatrix specifies a feConvolveMatrix filter primitive Standard referencd: http://www.w3.org/TR/SVG11/filters.html#feConvolveMatrixElement

 FeDiffuseLighting(fs Filterspec, scale, constant float64, s ...string)

FeDiffuseLighting specifies a diffuse lighting filter primitive, a container for light source Element>s, end with DiffuseEnd()

 FeDiffEnd()

FeDiffuseEnd ends a diffuse lighting filter primitive container Standard reference: http://www.w3.org/TR/SVG11/filters.html#feDiffuseLightingElement

 FeDisplacementMap(fs Filterspec, scale float64, xchannel, ychannel string, s ...string)

FeDisplacementMap specifies a feDisplacementMap filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feDisplacementMapElement

 FeDistantLight(fs Filterspec, azimuth, elevation float64, s ...string)

FeDistantLight specifies a feDistantLight filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feDistantLightElement

 FeFlood(fs Filterspec, color string, opacity float64, s ...string)

FeFlood specifies a flood filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feFloodElement

FeFuncLinear(channel string, slope, intercept float64)

FeFuncLinear is the linear form of feFunc Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

 FeFuncGamma(channel, amplitude, exponent, offset float64)

FeFuncGamma is the gamma curve form of feFunc Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

FeFuncTable(channel string, tv []float64)

FeFuncGamma is the form of feFunc using a table of values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

FeFuncDiscrete(channel string, tv []float64)

FeFuncGamma is the form of feFunc using discrete values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

 FeGaussianBlur(fs Filterspec, stdx, stdy float64, s ...string)

FeGaussianBlur specifies a Gaussian Blur filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feGaussianBlurElement

 FeImage(href string, result string, s ...string)

FeImage specifies a feImage filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feImageElement

 FeMerge(nodes []string, s ...string)

FeMerge specifies a feMerge filter primitive, containing feMerge Element>s Standard reference: http://www.w3.org/TR/SVG11/filters.html#feMergeElement

 FeMorphology(fs Filterspec, operator string, xradius, yradius float64, s ...string)

FeMorphologyLight specifies a feMorphologyLight filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feMorphologyElement

 FeOffset(fs Filterspec, dx, dy int, s ...string)

FeOffset specifies the feOffset filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feOffsetElement

 FePointLight(x, y, z float64, s ...string)

FePointLight specifies a fePpointLight filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#fePointLightElement

 FeSpecularLighting(fs Filterspec, scale, constant float64, exponent int, color string, s ...string)

FeSpecularLighting specifies a specular lighting filter primitive, a container for light source elements, end with SpecularEnd()

 FeSpecEnd()

FeSpecularEnd ends a specular lighting filter primitive container Standard reference: http://www.w3.org/TR/SVG11/filters.html#feSpecularLightingElement

 FeSpotLight(fs Filterspec, x, y, z, px, py, pz float64, s ...string)

FeSpotLight specifies a feSpotLight filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feSpotLightElement

 FeTile(fs Filterspec, in string, s ...string)

FeTile specifies the tile utility filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feTileElement

 FeTurbulence(fs Filterspec, ftype string, bfx, bfy float64, octaves int, seed int64, stitch bool, s ...string)

FeTurbulence specifies a turbulence filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feTurbulenceElement

Filter convenience functions (modeled on CSS filter effects)

Blur(p float64)

Blur function by standard deviation

Brightness(p float64)

Brightness function (0-100)

Grayscale()

Apply a grayscale filter to the image

HueRotate(a float64)

Rotate Hues (0-360 degrees)

Invert()

Invert the image's colors

Saturate(p float64)

Percent saturation, 0 is grayscale

Sepia()

Apply sepia tone

Utility

Grid(x int, y int, w int, h int, n int, s ...string)

draws a grid of straight lines starting at x,y, with a width w, and height h, and a size of n.

Grid

Credits

Thanks to Jonathan Wright for the io.Writer update.

Documentation

Overview

Package svg generates SVG as defined by the Scalable Vector Graphics 1.1 Specification (<http://www.w3.org/TR/SVG11/>). Output goes to the specified io.Writer.

Supported SVG elements and functions

Shapes, lines, text 

circle, ellipse, polygon, polyline, rect (including roundrects), line, text

Paths 

general, arc, cubic and quadratic bezier paths,

Image and Gradients 

image, linearGradient, radialGradient,

Transforms 

translate, rotate, scale, skewX, skewY

Filter Effects 

filter, feBlend, feColorMatrix, feColorMatrix, feComponentTransfer, feComposite, feConvolveMatrix, feDiffuseLighting,
feDisplacementMap, feDistantLight, feFlood, feGaussianBlur, feImage, feMerge, feMorphology, feOffset, fePointLight,
feSpecularLighting, feSpotLight,feTile, feTurbulence

Metadata elements 

desc, defs, g (style, transform, id), mask, marker, pattern, title, (a)ddress, link, script, use

Usage: (assuming GOPATH is set) 

go get github.com/ajstarks/svgo
go install github.com/ajstarks/svgo/...

You can use godoc to browse the documentation from the command line: 

$ godoc github.com/ajstarks/svgo

a minimal program, to generate SVG to standard output. 

package main

import (
	"github.com/ajstarks/svgo"
	"os"
)

func main() {
	width := 500
	height := 500
	canvas := svg.New(os.Stdout)
	canvas.Start(width, height)
	canvas.Circle(width/2, height/2, 100)
	canvas.Text(width/2, height/2, "Hello, SVG", "text-anchor:middle;font-size:30px;fill:white")
	canvas.End()
}

Drawing in a web server: (http://localhost:2003/circle) 

package main

import (
	"log"
	"github.com/ajstarks/svgo"
	"net/http"
)

func main() {
	http.Handle("/circle", http.HandlerFunc(circle))
	err := http.ListenAndServe(":2003", nil)
	if err != nil {
		log.Fatal("ListenAndServe:", err)
	}
}

func circle(w http.ResponseWriter, req *http.Request) {
  w.Header().Set("Content-Type", "image/svg+xml")
  s := svg.New(w)
  s.Start(500, 500)
  s.Circle(250, 250, 125, "fill:none;stroke:black")
  s.End()
}

Functions and types

Many functions use x, y to specify an object's location, and w, h to specify the object's width and height. Where applicable, a final optional argument specifies the style to be applied to the object. The style strings follow the SVG standard; name:value pairs delimited by semicolons, or a series of name="value" pairs. For example: `"fill:none; opacity:0.3"` or `fill="none" opacity="0.3"` (see: <http://www.w3.org/TR/SVG11/styling.html>)

The Offcolor type: 

type Offcolor struct {
	Offset  uint8
	Color   string
	Opacity float
}

is used to specify the offset, color, and opacity of stop colors in linear and radial gradients

The Filterspec type: 

type Filterspec struct {
	In string
	In2 string
	Result string
}

is used to specify inputs and results for filter effects

Package svg provides an API for generating Scalable Vector Graphics (SVG)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Filterspec 

type Filterspec struct {
	In, In2, Result string
}

Filterspec defines the specification of SVG filters

type Offcolor 

type Offcolor struct {
	Offset  uint8
	Color   string
	Opacity float64
}

Offcolor defines the offset and color for gradients

type SVG 

type SVG struct {
	Writer io.Writer
}

SVG defines the location of the generated SVG

func New 

func New(w io.Writer) *SVG

New is the SVG constructor, specifying the io.Writer where the generated SVG is written.

func (*SVG) Arc 

func (svg *SVG) Arc(sx int, sy int, ax int, ay int, r int, large bool, sweep bool, ex int, ey int, s ...string)

Arc draws an elliptical arc, with optional style, beginning coordinate at sx,sy, ending coordinate at ex, ey width and height of the arc are specified by ax, ay, the x axis rotation is r if sweep is true, then the arc will be drawn in a "positive-angle" direction (clockwise), if false, the arc is drawn counterclockwise. if large is true, the arc sweep angle is greater than or equal to 180 degrees, otherwise the arc sweep is less than 180 degrees http://www.w3.org/TR/SVG11/paths.html#PathDataEllipticalArcCommands

func (*SVG) Bezier 

func (svg *SVG) Bezier(sx int, sy int, cx int, cy int, px int, py int, ex int, ey int, s ...string)

Bezier draws a cubic bezier curve, with optional style, beginning at sx,sy, ending at ex,ey with control points at cx,cy and px,py. Standard Reference: http://www.w3.org/TR/SVG11/paths.html#PathDataCubicBezierCommands

func (*SVG) Blur 

func (svg *SVG) Blur(p float64)

Blur emulates the CSS blur filter

func (*SVG) Brightness 

func (svg *SVG) Brightness(p float64)

Brightness emulates the CSS brightness filter

func (*SVG) CenterRect 

func (svg *SVG) CenterRect(x int, y int, w int, h int, s ...string)

CenterRect draws a rectangle with its center at x,y, with width w, and height h, with optional style

func (*SVG) Circle 

func (svg *SVG) Circle(x int, y int, r int, s ...string)

Circle centered at x,y, with radius r, with optional style. Standard Reference: http://www.w3.org/TR/SVG11/shapes.html#CircleElement

func (*SVG) ClipEnd 

func (svg *SVG) ClipEnd()

ClipEnd ends a ClipPath

func (*SVG) ClipPath 

func (svg *SVG) ClipPath(s ...string)

ClipPath defines a clip path

func (*SVG) Def 

func (svg *SVG) Def()

Def begins a defintion block. Standard Reference: http://www.w3.org/TR/SVG11/struct.html#DefsElement

func (*SVG) DefEnd 

func (svg *SVG) DefEnd()

DefEnd ends a defintion block.

func (*SVG) Desc 

func (svg *SVG) Desc(s string)

Desc specified the text of the description tag. Standard Reference: http://www.w3.org/TR/SVG11/struct.html#DescElement

func (*SVG) Ellipse 

func (svg *SVG) Ellipse(x int, y int, w int, h int, s ...string)

Ellipse centered at x,y, centered at x,y with radii w, and h, with optional style. Standard Reference: http://www.w3.org/TR/SVG11/shapes.html#EllipseElement

func (*SVG) End 

func (svg *SVG) End()

End the SVG document

func (*SVG) FeBlend 

func (svg *SVG) FeBlend(fs Filterspec, mode string, s ...string)

FeBlend specifies a Blend filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feBlendElement

func (*SVG) FeColorMatrix 

func (svg *SVG) FeColorMatrix(fs Filterspec, values [20]float64, s ...string)

FeColorMatrix specifies a color matrix filter primitive, with matrix values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feColorMatrixElement

func (*SVG) FeColorMatrixHue 

func (svg *SVG) FeColorMatrixHue(fs Filterspec, value float64, s ...string)

FeColorMatrixHue specifies a color matrix filter primitive, with hue rotation values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feColorMatrixElement

func (*SVG) FeColorMatrixLuminence 

func (svg *SVG) FeColorMatrixLuminence(fs Filterspec, s ...string)

FeColorMatrixLuminence specifies a color matrix filter primitive, with luminence values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feColorMatrixElement

func (*SVG) FeColorMatrixSaturate 

func (svg *SVG) FeColorMatrixSaturate(fs Filterspec, value float64, s ...string)

FeColorMatrixSaturate specifies a color matrix filter primitive, with saturation values Standard reference: http://www.w3.org/TR/SVG11/filters.html#feColorMatrixElement

func (*SVG) FeCompEnd 

func (svg *SVG) FeCompEnd()

FeCompEnd ends a feComponent filter element Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

func (*SVG) FeComponentTransfer 

func (svg *SVG) FeComponentTransfer()

FeComponentTransfer begins a feComponent filter element Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

func (*SVG) FeComposite 

func (svg *SVG) FeComposite(fs Filterspec, operator string, k1, k2, k3, k4 int, s ...string)

FeComposite specifies a feComposite filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feCompositeElement

func (*SVG) FeConvolveMatrix 

func (svg *SVG) FeConvolveMatrix(fs Filterspec, matrix [9]int, s ...string)

FeConvolveMatrix specifies a feConvolveMatrix filter primitive Standard referencd: http://www.w3.org/TR/SVG11/filters.html#feConvolveMatrixElement

func (*SVG) FeDiffEnd 

func (svg *SVG) FeDiffEnd()

FeDiffEnd ends a diffuse lighting filter primitive container Standard reference: http://www.w3.org/TR/SVG11/filters.html#feDiffuseLightingElement

func (*SVG) FeDiffuseLighting 

func (svg *SVG) FeDiffuseLighting(fs Filterspec, scale, constant float64, s ...string)

FeDiffuseLighting specifies a diffuse lighting filter primitive, a container for light source elements, end with DiffuseEnd() Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

func (*SVG) FeDisplacementMap 

func (svg *SVG) FeDisplacementMap(fs Filterspec, scale float64, xchannel, ychannel string, s ...string)

FeDisplacementMap specifies a feDisplacementMap filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feDisplacementMapElement

func (*SVG) FeDistantLight 

func (svg *SVG) FeDistantLight(fs Filterspec, azimuth, elevation float64, s ...string)

FeDistantLight specifies a feDistantLight filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feDistantLightElement

func (*SVG) FeFlood 

func (svg *SVG) FeFlood(fs Filterspec, color string, opacity float64, s ...string)

FeFlood specifies a flood filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feFloodElement

func (*SVG) FeFuncDiscrete 

func (svg *SVG) FeFuncDiscrete(channel string, tv []float64)

FeFuncDiscrete specifies the discrete values for the feFunc{R|G|B|A} filter element Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

func (*SVG) FeFuncGamma 

func (svg *SVG) FeFuncGamma(channel string, amplitude, exponent, offset float64)

FeFuncGamma specifies the curve values for gamma correction for the feFunc{R|G|B|A} filter element Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

func (*SVG) FeFuncLinear 

func (svg *SVG) FeFuncLinear(channel string, slope, intercept float64)

FeFuncLinear specifies a linear style function for the feFunc{R|G|B|A} filter element Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

func (*SVG) FeFuncTable 

func (svg *SVG) FeFuncTable(channel string, tv []float64)

FeFuncTable specifies the table of values for the feFunc{R|G|B|A} filter element Standard reference: http://www.w3.org/TR/SVG11/filters.html#feComponentTransferElement

func (*SVG) FeGaussianBlur 

func (svg *SVG) FeGaussianBlur(fs Filterspec, stdx, stdy float64, s ...string)

FeGaussianBlur specifies a Gaussian Blur filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feGaussianBlurElement

func (*SVG) FeImage 

func (svg *SVG) FeImage(href string, result string, s ...string)

FeImage specifies a feImage filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feImageElement

func (*SVG) FeMerge 

func (svg *SVG) FeMerge(nodes []string, s ...string)

FeMerge specifies a feMerge filter primitive, containing feMerge elements Standard reference: http://www.w3.org/TR/SVG11/filters.html#feMergeElement

func (*SVG) FeMorphology 

func (svg *SVG) FeMorphology(fs Filterspec, operator string, xradius, yradius float64, s ...string)

FeMorphology specifies a feMorphologyLight filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feMorphologyElement

func (*SVG) FeOffset 

func (svg *SVG) FeOffset(fs Filterspec, dx, dy int, s ...string)

FeOffset specifies the feOffset filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feOffsetElement

func (*SVG) FePointLight 

func (svg *SVG) FePointLight(x, y, z float64, s ...string)

FePointLight specifies a fePpointLight filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#fePointLightElement

func (*SVG) FeSpecEnd 

func (svg *SVG) FeSpecEnd()

FeSpecEnd ends a specular lighting filter primitive container Standard reference: http://www.w3.org/TR/SVG11/filters.html#feSpecularLightingElement

func (*SVG) FeSpecularLighting 

func (svg *SVG) FeSpecularLighting(fs Filterspec, scale, constant float64, exponent int, color string, s ...string)

FeSpecularLighting specifies a specular lighting filter primitive, a container for light source elements, end with SpecularEnd() Standard reference: http://www.w3.org/TR/SVG11/filters.html#feSpecularLightingElement

func (*SVG) FeSpotLight 

func (svg *SVG) FeSpotLight(fs Filterspec, x, y, z, px, py, pz float64, s ...string)

FeSpotLight specifies a feSpotLight filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feSpotLightElement

func (*SVG) FeTile 

func (svg *SVG) FeTile(fs Filterspec, in string, s ...string)

FeTile specifies the tile utility filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feTileElement

func (*SVG) FeTurbulence 

func (svg *SVG) FeTurbulence(fs Filterspec, ftype string, bfx, bfy float64, octaves int, seed int64, stitch bool, s ...string)

FeTurbulence specifies a turbulence filter primitive Standard reference: http://www.w3.org/TR/SVG11/filters.html#feTurbulenceElement

func (*SVG) Fend 

func (svg *SVG) Fend()

Fend ends a filter set Standard reference: http://www.w3.org/TR/SVG11/filters.html#FilterElement

func (*SVG) Filter 

func (svg *SVG) Filter(id string, s ...string)

Filter begins a filter set Standard reference: http://www.w3.org/TR/SVG11/filters.html#FilterElement

func (*SVG) Gend 

func (svg *SVG) Gend()

Gend ends a group (must be paired with Gsttyle, Gtransform, Gid).

func (*SVG) Gid 

func (svg *SVG) Gid(s string)

Gid begins a group, with the specified id

func (*SVG) Grayscale 

func (svg *SVG) Grayscale()

Grayscale eumulates the CSS grayscale filter

func (*SVG) Grid 

func (svg *SVG) Grid(x int, y int, w int, h int, n int, s ...string)

Grid draws a grid at the specified coordinate, dimensions, and spacing, with optional style.

func (*SVG) Group 

func (svg *SVG) Group(s ...string)

Group begins a group with arbitrary attributes

func (*SVG) Gstyle 

func (svg *SVG) Gstyle(s string)

Gstyle begins a group, with the specified style. Standard Reference: http://www.w3.org/TR/SVG11/struct.html#GElement

func (*SVG) Gtransform 

func (svg *SVG) Gtransform(s string)

Gtransform begins a group, with the specified transform Standard Reference: http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

func (*SVG) HueRotate 

func (svg *SVG) HueRotate(a float64)

HueRotate eumulates the CSS huerotate filter

func (*SVG) Image 

func (svg *SVG) Image(x int, y int, w int, h int, link string, s ...string)

Image places at x,y (upper left hand corner), the image with width w, and height h, referenced at link, with optional style. Standard Reference: http://www.w3.org/TR/SVG11/struct.html#ImageElement

func (*SVG) Invert 

func (svg *SVG) Invert()

Invert eumulates the CSS invert filter

func (*SVG) Line 

func (svg *SVG) Line(x1 int, y1 int, x2 int, y2 int, s ...string)

Line draws a straight line between two points, with optional style. Standard Reference: http://www.w3.org/TR/SVG11/shapes.html#LineElement

func (*SVG) LinearGradient 

func (svg *SVG) LinearGradient(id string, x1, y1, x2, y2 uint8, sc []Offcolor)

LinearGradient constructs a linear color gradient identified by id, along the vector defined by (x1,y1), and (x2,y2). The stop color sequence defined in sc. Coordinates are expressed as percentages. 

func (svg *SVG) Link(href string, title string)

Link begins a link named "name", with the specified title. Standard Reference: http://www.w3.org/TR/SVG11/linking.html#Links

func (*SVG) LinkEnd 

func (svg *SVG) LinkEnd()

LinkEnd ends a link.

func (*SVG) Marker 

func (svg *SVG) Marker(id string, x, y, width, height int, s ...string)

Marker defines a marker Standard reference: http://www.w3.org/TR/SVG11/painting.html#MarkerElement

func (*SVG) MarkerEnd 

func (svg *SVG) MarkerEnd()

MarkEnd ends a marker

func (*SVG) Mask 

func (svg *SVG) Mask(id string, x int, y int, w int, h int, s ...string)

Mask creates a mask with a specified id, dimension, and optional style.

func (*SVG) MaskEnd 

func (svg *SVG) MaskEnd()

MaskEnd ends a Mask.

func (*SVG) Path 

func (svg *SVG) Path(d string, s ...string)

Path draws an arbitrary path, the caller is responsible for structuring the path data

func (*SVG) Pattern 

func (svg *SVG) Pattern(id string, x, y, width, height int, putype string, s ...string)

Pattern defines a pattern with the specified dimensions. The putype can be either "user" or "obj", which sets the patternUnits attribute to be either userSpaceOnUse or objectBoundingBox Standard reference: http://www.w3.org/TR/SVG11/pservers.html#Patterns

func (*SVG) PatternEnd 

func (svg *SVG) PatternEnd()

PatternEnd ends a marker

func (*SVG) Polygon 

func (svg *SVG) Polygon(x []int, y []int, s ...string)

Polygon draws a series of line segments using an array of x, y coordinates, with optional style. Standard Reference: http://www.w3.org/TR/SVG11/shapes.html#PolygonElement

func (*SVG) Polyline 

func (svg *SVG) Polyline(x []int, y []int, s ...string)

Polyline draws connected lines between coordinates, with optional style. Standard Reference: http://www.w3.org/TR/SVG11/shapes.html#PolylineElement

func (*SVG) Qbez 

func (svg *SVG) Qbez(sx int, sy int, cx int, cy int, ex int, ey int, s ...string)

Qbez draws a quadratic bezier curver, with optional style beginning at sx,sy, ending at ex, sy with control points at cx, cy Standard Reference: http://www.w3.org/TR/SVG11/paths.html#PathDataQuadraticBezierCommands

func (*SVG) Qbezier 

func (svg *SVG) Qbezier(sx int, sy int, cx int, cy int, ex int, ey int, tx int, ty int, s ...string)

Qbezier draws a Quadratic Bezier curve, with optional style, beginning at sx, sy, ending at tx,ty with control points are at cx,cy, ex,ey. Standard Reference: http://www.w3.org/TR/SVG11/paths.html#PathDataQuadraticBezierCommands

func (*SVG) RGB 

func (svg *SVG) RGB(r int, g int, b int) string

RGB specifies a fill color in terms of a (r)ed, (g)reen, (b)lue triple. Standard reference: http://www.w3.org/TR/css3-color/

func (*SVG) RGBA 

func (svg *SVG) RGBA(r int, g int, b int, a float64) string

RGBA specifies a fill color in terms of a (r)ed, (g)reen, (b)lue triple and opacity.

func (*SVG) RadialGradient 

func (svg *SVG) RadialGradient(id string, cx, cy, r, fx, fy uint8, sc []Offcolor)

RadialGradient constructs a radial color gradient identified by id, centered at (cx,cy), with a radius of r. (fx, fy) define the location of the focal point of the light source. The stop color sequence defined in sc. Coordinates are expressed as percentages.

func (*SVG) Rect 

func (svg *SVG) Rect(x int, y int, w int, h int, s ...string)

Rect draws a rectangle with upper left-hand corner at x,y, with width w, and height h, with optional style Standard Reference: http://www.w3.org/TR/SVG11/shapes.html#RectElement

func (*SVG) Rotate 

func (svg *SVG) Rotate(r float64)

Rotate rotates the coordinate system by r degrees, end with Gend() Standard Reference: http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

func (*SVG) RotateTranslate 

func (svg *SVG) RotateTranslate(x, y int, r float64)

RotateTranslate rotates the coordinate system r degrees, then translates to (x,y), end with Gend()

func (*SVG) Roundrect 

func (svg *SVG) Roundrect(x int, y int, w int, h int, rx int, ry int, s ...string)

Roundrect draws a rounded rectangle with upper the left-hand corner at x,y, with width w, and height h. The radii for the rounded portion are specified by rx (width), and ry (height). Style is optional. Standard Reference: http://www.w3.org/TR/SVG11/shapes.html#RectElement

func (*SVG) Saturate 

func (svg *SVG) Saturate(p float64)

Saturate eumulates the CSS saturate filter

func (*SVG) Scale 

func (svg *SVG) Scale(n float64)

Scale scales the coordinate system by n, end with Gend() Standard Reference: http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

func (*SVG) ScaleXY 

func (svg *SVG) ScaleXY(dx, dy float64)

ScaleXY scales the coordinate system by dx and dy, end with Gend() Standard Reference: http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

func (*SVG) Script 

func (svg *SVG) Script(scriptype string, data ...string)

Script defines a script with a specified type, (for example "application/javascript"). if the first variadic argument is a link, use only the link reference. Otherwise, treat those arguments as the text of the script (marked up as CDATA). if no data is specified, just close the script element

func (*SVG) Sepia 

func (svg *SVG) Sepia()

Sepia applies a sepia tone, emulating the CSS sepia filter

func (*SVG) SkewX 

func (svg *SVG) SkewX(a float64)

SkewX skews the x coordinate system by angle a, end with Gend() Standard Reference: http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

func (*SVG) SkewXY 

func (svg *SVG) SkewXY(ax, ay float64)

SkewXY skews x and y coordinates by ax, ay respectively, end with Gend() Standard Reference: http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

func (*SVG) SkewY 

func (svg *SVG) SkewY(a float64)

SkewY skews the y coordinate system by angle a, end with Gend() Standard Reference: http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

func (*SVG) Square 

func (svg *SVG) Square(x int, y int, l int, s ...string)

Square draws a square with upper left corner at x,y with sides of length l, with optional style.

func (*SVG) Start 

func (svg *SVG) Start(w int, h int, ns ...string)

Start begins the SVG document with the width w and height h. Other attributes may be optionally added, for example viewbox or additional namespaces Standard Reference: http://www.w3.org/TR/SVG11/struct.html#SVGElement

func (*SVG) Startpercent 

func (svg *SVG) Startpercent(w int, h int, ns ...string)

Startpercent begins the SVG document, with width and height as percentages Other attributes may be optionally added, for example viewbox or additional namespaces

func (*SVG) Startraw 

func (svg *SVG) Startraw(ns ...string)

Startraw begins the SVG document, passing arbitrary attributes

func (*SVG) Startunit 

func (svg *SVG) Startunit(w int, h int, unit string, ns ...string)

Startunit begins the SVG document, with width and height in the specified units Other attributes may be optionally added, for example viewbox or additional namespaces

func (*SVG) Startview 

func (svg *SVG) Startview(w, h, minx, miny, vw, vh int)

Startview begins the SVG document, with the specified width, height, and viewbox Other attributes may be optionally added, for example viewbox or additional namespaces

func (*SVG) StartviewUnit 

func (svg *SVG) StartviewUnit(w, h int, unit string, minx, miny, vw, vh int)

func (*SVG) Text 

func (svg *SVG) Text(x int, y int, t string, s ...string)

Text places the specified text, t at x,y according to the style specified in s Standard Reference: http://www.w3.org/TR/SVG11/text.html#TextElement

func (*SVG) Textlines 

func (svg *SVG) Textlines(x, y int, s []string, size, spacing int, fill, align string)

Textlines places a series of lines of text starting at x,y, at the specified size, fill, and alignment. Each line is spaced according to the spacing argument

func (*SVG) Textpath 

func (svg *SVG) Textpath(t string, pathid string, s ...string)

Textpath places text optionally styled text along a previously defined path Standard Reference: http://www.w3.org/TR/SVG11/text.html#TextPathElement

func (*SVG) Title 

func (svg *SVG) Title(s string)

Title specified the text of the title tag. Standard Reference: http://www.w3.org/TR/SVG11/struct.html#TitleElement

func (*SVG) Translate 

func (svg *SVG) Translate(x, y int)

Translate begins coordinate translation, end with Gend() Standard Reference: http://www.w3.org/TR/SVG11/coords.html#TransformAttribute

func (*SVG) TranslateRotate 

func (svg *SVG) TranslateRotate(x, y int, r float64)

TranslateRotate translates the coordinate system to (x,y), then rotates to r degrees, end with Gend()

func (*SVG) Use 

func (svg *SVG) Use(x int, y int, link string, s ...string)

Use places the object referenced at link at the location x, y, with optional style. Standard Reference: http://www.w3.org/TR/SVG11/struct.html#UseElement

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.