Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PresetMap ¶
func PresetMap(vis *Visualizer)
func PresetNeighbourhood ¶
func PresetNeighbourhood(vis *Visualizer)
func PresetSingle ¶
func PresetSingle(vis *Visualizer)
Types ¶
type Visualizer ¶
type Visualizer struct {
Mach *am.Machine
// Render only these machines as starting points.
RenderMachs []string
// Render only machines matching the regular expressions as starting points.
RenderMachsRe []*regexp.Regexp
// Skip rendering of these machines.
RenderSkipMachs []string
// TODO
// RenderSkipMachsRe []regexp.Regexp
// Distance to render from starting machines.
RenderDistance int
// How deep to render from starting machines. Same as RenderDistance, but only
// for submachines.
RenderDepth int
// Render states bubbles.
RenderStates bool
// With RenderStates, false will hide Start, and without RenderStates true
// will render Start.
RenderStart bool
// With RenderStates, false will hide Exception, and without RenderStates true
// will render Exception.
RenderException bool
// With RenderStates, false will hide Ready, and without RenderStates true
// will render Ready.
RenderReady bool
// Render states which have pipes being rendered, even if the state should
// not be rendered.
RenderPipeStates bool
// Render group of pipes as mach->mach
RenderPipes bool
// Render pipes to non-rendered machines / states.
RenderHalfPipes bool
// Render detailed pipes as state -> state
RenderDetailedPipes bool
// Render relation between states. TODO After relation
// TODO specific relations
RenderRelations bool
// Style currently active states. TODO style errors red
RenderActive bool
// Render the parent relation. Ignored when RenderNestSubmachines.
RenderParentRel bool
// Render submachines nested inside their parents. See also RenderDepth.
RenderNestSubmachines bool
// Render a tags box for machines having some.
RenderTags bool
// Render RPC connections
RenderConns bool
// Render RPC connections to non-rendered machines.
RenderHalfConns bool
// Render a parent relation to and from non-rendered machines.
RenderHalfHierarchy bool
// Render inherited states.
RenderInherited bool
// Mark inherited states. TODO refac to RenderMarkOwnStates
RenderMarkInherited bool
// Filename without an extension.
OutputFilename string
// Render a D2 SVG in addition to the plain text version.
OutputD2Svg bool
// Render a Mermaid SVG in addition to the plain text version.
OutputMermaidSvg bool
// Render edges using ELK.
OutputElk bool
// Output a D2 diagram (default)
OutputD2 bool
// Output a Mermaid diagram (basic support only).
OutputMermaid bool
// contains filtered or unexported fields
}
func (*Visualizer) GenDiagrams ¶
func (v *Visualizer) GenDiagrams() error
func (*Visualizer) RenderDefaults ¶
func (v *Visualizer) RenderDefaults()
Click to show internal directories.
Click to hide internal directories.