graph

Documentation

Index

• Constants
• type Edge
• type Graph
  • func FromFile(path string) (*Graph, error)
  • func Parse(reader io.Reader) (*Graph, error)
  • func (gr *Graph) GetEdges(index int) []int
  • func (gr *Graph) GetNames() []string
  • func (gr Graph) GetView() view
  • func (gr *Graph) SetNodeName(name string, index int)
• type SubGraph

Constants

const (
	TB view = "TB" // top bottom
	BT view = "BT" // bottom top
	RL view = "RL" // right left
	LR view = "LR" // left right
	TD view = "TD" // same as TB
)

Types

type Edge

type Edge struct {
	LeftNode  string `@Ident[" "|"\t"]"-""-"["-"]`
	Directed  bool   `[@">"][" "|"\t"]`
	RightNode string `@Ident[";"]`
}

type Graph

type Graph struct {
	View      view        `"graph" @Ident`
	Edges     []*Edge     `@@*`
	SubGraphs []*SubGraph `@@*`
	// contains filtered or unexported fields
}

Graph implements semantics of markdown flowchart, aka graph, http://mermaid-js.github.io/mermaid/#/flowchart

func FromFile

func FromFile(path string) (*Graph, error)

func Parse

func Parse(reader io.Reader) (*Graph, error)

func (*Graph) GetEdges

func (gr *Graph) GetEdges(index int) []int

GetEdges assumes that SetNodeName was called for all nodes in the graphs

func (*Graph) GetNames

func (gr *Graph) GetNames() []string

func (Graph) GetView

func (gr Graph) GetView() view

func (*Graph) SetNodeName

func (gr *Graph) SetNodeName(name string, index int)

type SubGraph

type SubGraph struct {
	Name  string  `"subgraph" @Ident`
	Edges []*Edge `@@*"end"`
}