dot

Documentation

Index

• func Marshal(g graph.Graph) []byte
• func Unmarshal(b []byte) *simple.DirectedGraph
• type Graph
  • func (g Graph) GetNodeByDOTID(DOTID string) graph.Node
  • func (g Graph) NewEdge(from, to graph.Node) graph.Edge
  • func (g Graph) NewNode() graph.Node
• type Node
  • func (n *Node) Attribute(key string) (string, error)
  • func (n *Node) Attributes() []encoding.Attribute
  • func (n *Node) DOTID() string
  • func (n *Node) SetAttribute(attr encoding.Attribute) error
  • func (n *Node) SetDOTID(id string)

Functions

func Marshal

func Marshal(g graph.Graph) []byte

Marshal returns the DOT encoding for the graph g

func Unmarshal

func Unmarshal(b []byte) *simple.DirectedGraph

Unmarshal reads a slice of bytes containing a dot encoded graph and returns a *simple.DirectedGraph with edges and nodes containing attributes

Types

type Graph

type Graph struct {
	*simple.DirectedGraph
}

Graph ensures dotEdge and Node types are created when needed.

func (Graph) GetNodeByDOTID

func (g Graph) GetNodeByDOTID(DOTID string) graph.Node

GetNodeByDOTID gets a Node by it's DOT ID.

func (Graph) NewEdge

func (g Graph) NewEdge(from, to graph.Node) graph.Edge

NewNode returns a new Edge to be added to g. The Edge contains the attributes.

func (Graph) NewNode

func (g Graph) NewNode() graph.Node

NewNode returns a new Node to be added to g. The Node contains the attributes.

type Node

type Node struct {
	graph.Node
	// contains filtered or unexported fields
}

Node handles basic DOT serialisation and deserialisation

func (*Node) Attribute

func (n *Node) Attribute(key string) (string, error)

Attribute gets a DOT attribute.

func (*Node) Attributes

func (n *Node) Attributes() []encoding.Attribute

Attributes gets the slice of attributes defined for the node.

func (*Node) DOTID

func (n *Node) DOTID() string

DOTID gets the DOT attribute.

func (*Node) SetAttribute

func (n *Node) SetAttribute(attr encoding.Attribute) error

SetAttribute sets a DOT attribute.

func (*Node) SetDOTID

func (n *Node) SetDOTID(id string)

SetDOTID sets the DOT ID.