dot

Documentation

Index

• type BasicEdge
  • func (r BasicEdge) Render() string
• type BasicGraph
  • func NewBasicGraph(graph graph.Graph, orientation Orientation) BasicGraph
  • func NewColoredGraph(graph graph.Graph, orientation Orientation, colorer Colorer) BasicGraph
  • func (r BasicGraph) Render() string
• type BasicNodeLabel
  • func (r BasicNodeLabel) Render() string
• type Color
  • func (s Color) Render() string
• type ColoredNodeLabel
  • func (r ColoredNodeLabel) Render() string
• type Colorer
• type Node
  • func (r Node) Render() string
• type NodeShape
• type Orientation
• type Renderable
• type Value
  • func (r Value) Render() string

Types

type BasicEdge

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

func (BasicEdge) Render

func (r BasicEdge) Render() string

type BasicGraph

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

BasicGraph renders graph to Dot without colors with simples syntax without HTML. TODO: consider adding colors in background https://stackoverflow.com/questions/17765301/-dot-how-to-change-the-colour-of-one-record-in-multi-record-shape

func NewBasicGraph

func NewBasicGraph(
	graph graph.Graph,
	orientation Orientation,
) BasicGraph

NewBasicGraph creates renderable graph from graph data

func NewColoredGraph

func NewColoredGraph(
	graph graph.Graph,
	orientation Orientation,
	colorer Colorer,
) BasicGraph

NewColoredGraph creates renderable colored graph from graph data

func (BasicGraph) Render

func (r BasicGraph) Render() string

type BasicNodeLabel

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

BasicNodeLabel is label content for non-colorized Graphviz node

func (BasicNodeLabel) Render

func (r BasicNodeLabel) Render() string

type Color

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

Color transforms Go color to Graphviz RGBA format which is slightly odd

func (Color) Render

func (s Color) Render() string

type ColoredNodeLabel

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

ColoredNodeLabel is label content for colorized Graphviz node

func (ColoredNodeLabel) Render

func (r ColoredNodeLabel) Render() string

type Colorer

type Colorer interface {
	Color(k string, v interface{}) color.Color
}

type Node

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

func (Node) Render

func (r Node) Render() string

type NodeShape

type NodeShape string

NodeShape should match Graphviz values

const (
	NoneShape   NodeShape = "none"
	RecordShape NodeShape = "record"
)

type Orientation

type Orientation string

Orientation should match Graphviz allowed values

const (
	LR Orientation = "LR"
	TB Orientation = "TB"
)

type Renderable

type Renderable interface {
	Render() string
}

type Value

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

Value coerces to json.Number and tries to avoid adding decimal points to integers

func (Value) Render

func (r Value) Render() string