visualize

Documentation

Index

• Constants
• func RenderWorkflow(w *core.CompiledWorkflowClosure) (string, error)
• type FlyteGraph
  • func (g FlyteGraph) DoesEdgeExist(src, dest string) bool
  • func (g FlyteGraph) GetEdge(src, dest string) *graphviz.Edge
  • func (g FlyteGraph) GetNode(key string) *graphviz.Node
• type Graphvizer

Constants

const (
	// node identifiers
	StartNode string = "start-node"
	EndNode   string = "end-node"

	// subgraph attributes
	SubgraphPrefix string = "cluster_"

	// shape attributes
	DoubleCircleShape string = "doublecircle"
	BoxShape          string = "box"
	DiamondShape      string = "diamond"
	ShapeType         string = "shape"

	// color attributes
	ColorAttr string = "color"
	Red       string = "red"
	Green     string = "green"

	// structural attributes
	LabelAttr string = "label"
	LHeadAttr string = "lhead"
	LTailAttr string = "ltail"

	// conditional
	ElseFail string = "orElse - Fail"
	Else     string = "orElse"
)

Functions

func RenderWorkflow

func RenderWorkflow(w *core.CompiledWorkflowClosure) (string, error)

RenderWorkflow Renders the workflow graph on the console

Types

type FlyteGraph

type FlyteGraph struct {
	*graphviz.Graph
}

func (FlyteGraph) DoesEdgeExist

func (g FlyteGraph) DoesEdgeExist(src, dest string) bool

DoesEdgeExist checks if an edge exists in the graph from src to dest

func (FlyteGraph) GetEdge

func (g FlyteGraph) GetEdge(src, dest string) *graphviz.Edge

GetEdge gets the edge in the graph from src to dest

func (FlyteGraph) GetNode

func (g FlyteGraph) GetNode(key string) *graphviz.Node

GetNode given the key to the node

type Graphvizer

type Graphvizer interface {
	AddEdge(src, dst string, directed bool, attrs map[string]string) error
	AddNode(parentGraph string, name string, attrs map[string]string) error
	AddSubGraph(parentGraph string, name string, attrs map[string]string) error
	AddAttr(parentGraph string, field string, value string) error
	SetName(name string) error
	GetEdge(src, dest string) *graphviz.Edge
	GetNode(key string) *graphviz.Node
	DoesEdgeExist(src, dest string) bool
}