draw

README

draw - package for writing software design diagrams

• Cross platform
• No external dependencies
• SVG output
• Diagrams: Sequence, Activity, Class and more...

Documentation

Overview

Package draw provides svg writing features.

s := NewSvg()
s.WriteSvg(os.Stdout)

<svg
  xmlns="http://www.w3.org/2000/svg"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  width="100" height="100" font-family="Arial, Helvetica, sans-serif"></svg>

Index

• type SVG
  • func NewSvg() *SVG
  • func (s *SVG) Append(w ...SVGWriter)
  • func (s *SVG) Height() int
  • func (s *SVG) Prepend(w ...SVGWriter)
  • func (s *SVG) SetHeight(h int)
  • func (s *SVG) SetSize(w, h int)
  • func (s *SVG) SetWidth(w int)
  • func (s *SVG) Width() int
  • func (s *SVG) WriteSVG(out io.Writer) error
• type SVGWriter
• type TagWriter
  • func NewTagWriter(w io.Writer) (*TagWriter, *error)
  • func (t *TagWriter) Print(args ...interface{})
  • func (t *TagWriter) Printf(format string, args ...interface{})
  • func (t *TagWriter) Write(b []byte) (int, error)

Examples

• NewSvg
• NewTagWriter

Types

type SVG

type SVG struct {
	Content []SVGWriter
	// contains filtered or unexported fields
}

func NewSvg

func NewSvg() *SVG

NewSvg returns an empty Svg of size 100x100

Example

s := NewSvg()
s.WriteSVG(os.Stdout)

Output:
<svg
  xmlns="http://www.w3.org/2000/svg"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  width="100" height="100" font-family="Arial, Helvetica, sans-serif"></svg>

func (*SVG) Append

func (s *SVG) Append(w ...SVGWriter)

func (*SVG) Height

func (s *SVG) Height() int

func (*SVG) Prepend

func (s *SVG) Prepend(w ...SVGWriter)

func (*SVG) SetHeight

func (s *SVG) SetHeight(h int)

func (*SVG) SetSize

func (s *SVG) SetSize(w, h int)

func (*SVG) SetWidth

func (s *SVG) SetWidth(w int)

func (*SVG) Width

func (s *SVG) Width() int

func (*SVG) WriteSVG

func (s *SVG) WriteSVG(out io.Writer) error

type SVGWriter

type SVGWriter interface {
	WriteSVG(io.Writer) error
}

type TagWriter

type TagWriter struct {
	// contains filtered or unexported fields
}

func NewTagWriter

func NewTagWriter(w io.Writer) (*TagWriter, *error)

NewTagWriter returns a writer nexus. The referenced error is set by all methods if an error occurs.

Example

w, err := NewTagWriter(os.Stdout)
w.Print("hello")
*err = fmt.Errorf("stop subsequent calls")
w.Printf("cruel %s", "world")

Output:
hello

func (*TagWriter) Print

func (t *TagWriter) Print(args ...interface{})

Print prints arguments using the underlying writer. Does nothing if TagWriter has failed.

func (*TagWriter) Printf

func (t *TagWriter) Printf(format string, args ...interface{})

Printf prints a formated string using the underlying writer. Does nothing if TagWriter has failed.

func (*TagWriter) Write

func (t *TagWriter) Write(b []byte) (int, error)

Write writes the bytes using the underlying writer. Does nothing if TagWriter has failed.