godot

Documentation

Index

• type Direction
• type Dotter
  • func NewDotter(oType OutputType, gType GraphType, fname string) (*Dotter, error)
  • func NewDotterEx(oType OutputType, prog Program, gType GraphType, isStrict, writeToFile bool, ...) (*Dotter, error)
  • func (dotter *Dotter) Close() error
  • func (dotter *Dotter) CreateCluster(name string, nodes []string) error
  • func (dotter *Dotter) SetEdgeWeight(val float64) error
  • func (dotter *Dotter) SetLabel(node, label string) error
  • func (dotter *Dotter) SetLink(from, to string) error
  • func (dotter *Dotter) SetNodeSep(val float64) error
  • func (dotter *Dotter) SetNodeShape(node string, shape NodeShape) error
  • func (dotter *Dotter) SetRankDir(direction Direction) error
  • func (dotter *Dotter) SetRankSep(val float64) error
• type GraphType
• type NodeShape
• type OutputType
• type Program

Types

type Direction

type Direction string

const (
	DIR_LR Direction = "LR"
	DIR_RL Direction = "RL"
)

type Dotter

type Dotter struct {

	// If Debug is set to true, it will print out the dot outputs
	Debug bool
	// contains filtered or unexported fields
}

func NewDotter

func NewDotter(oType OutputType, gType GraphType, fname string) (*Dotter, error)

Convenience Wrapper for NewDotterEx(). Makes proper assumptions. For more see NewDotterEx().

func NewDotterEx

func NewDotterEx(oType OutputType, prog Program, gType GraphType,
	isStrict, writeToFile bool, fname string) (*Dotter, error)

Creates a New Dotter.

Parameters:

- isStrict: if true, multiple edges won't be displayed.

- writeToFile: if true, output will be written to fname. Otherwise to stdout.

- fname: filename. if fname equals "", dot will make up a filename - usally noname.dot.*

func (*Dotter) Close

func (dotter *Dotter) Close() error

func (*Dotter) CreateCluster

func (dotter *Dotter) CreateCluster(name string, nodes []string) error

func (*Dotter) SetEdgeWeight

func (dotter *Dotter) SetEdgeWeight(val float64) error

func (*Dotter) SetLabel

func (dotter *Dotter) SetLabel(node, label string) error

func (*Dotter) SetLink

func (dotter *Dotter) SetLink(from, to string) error

func (*Dotter) SetNodeSep

func (dotter *Dotter) SetNodeSep(val float64) error

func (*Dotter) SetNodeShape

func (dotter *Dotter) SetNodeShape(node string, shape NodeShape) error

func (*Dotter) SetRankDir

func (dotter *Dotter) SetRankDir(direction Direction) error

func (*Dotter) SetRankSep

func (dotter *Dotter) SetRankSep(val float64) error

type GraphType

type GraphType string

const (
	GRAPH_DIRECTED   GraphType = "digraph"
	GRAPH_UNDIRECTED GraphType = "graph"
)

type NodeShape

type NodeShape string

const (
	SHAPE_BOX       NodeShape = "BOX"
	SHAPE_CIRCLE    NodeShape = "CIRCLE"
	SHAPE_FOLDER    NodeShape = "FOLDER"
	SHAPE_PLAINTEXT NodeShape = "PLAINTEXT"
	SHAPE_TRIANGLE  NodeShape = "TRIANGLE"
)

type OutputType

type OutputType string

const (
	OUT_BMP OutputType = "bmp"
	OUT_DOT OutputType = "dot"
	OUT_JPG OutputType = "jpg"
	OUT_PDF OutputType = "pdf"
	OUT_PNG OutputType = "png"
	OUT_PS  OutputType = "ps"
	OUT_SVG OutputType = "svg"
)

type Program

type Program string

const (
	PROG_CIRCO Program = "circo"
	PROG_DOT   Program = "dot"
	PROG_FDP   Program = "fdp"
	PROG_NEATO Program = "neato"
	PROG_SFDP  Program = "sfdp"
	PROG_TWOPI Program = "twopi"
)