visualize

Documentation

Index

• func RenderGraphvizDOT(res *wt.Result, sch *schema.Schema) (string, error)
• func RenderHTML(res *wt.Result, sch *schema.Schema, opts Options) ([]byte, error)
• func RenderMermaid(res *wt.Result, sch *schema.Schema) (string, error)
• func RenderSVG(res *wt.Result, sch *schema.Schema, opts Options) ([]byte, error)
• func WriteFile(path string, res *wt.Result, sch *schema.Schema, opts Options) error
• func WriteMermaid(path string, res *wt.Result, sch *schema.Schema) error
• type Options

Functions

func RenderGraphvizDOT

func RenderGraphvizDOT(res *wt.Result, sch *schema.Schema) (string, error)

RenderGraphvizDOT builds a simple Graphviz digraph (optional companion to Mermaid).

func RenderHTML

func RenderHTML(res *wt.Result, sch *schema.Schema, opts Options) ([]byte, error)

RenderHTML wraps SVG in a minimal HTML document (no JS required).

func RenderMermaid

func RenderMermaid(res *wt.Result, sch *schema.Schema) (string, error)

RenderMermaid builds a Mermaid flowchart from a schema (preferred) or High/Medium hypotheses.

func RenderSVG

func RenderSVG(res *wt.Result, sch *schema.Schema, opts Options) ([]byte, error)

RenderSVG builds a pure-SVG annotated byte lane from a report and/or schema.

func WriteFile

func WriteFile(path string, res *wt.Result, sch *schema.Schema, opts Options) error

WriteFile writes SVG or HTML based on extension.

func WriteMermaid

func WriteMermaid(path string, res *wt.Result, sch *schema.Schema) error

WriteMermaid writes a .mmd file.

Types

type Options

type Options struct {
	Width      int
	BytesShown int // max bytes on the lane (0 = auto from max length / schema)
	Title      string
}

Options for SVG field map rendering.