package visualizer

Import Path
	github.com/pancsta/asyncmachine-go/tools/visualizer (on go.dev)

Dependency Relation
	imports 34 packages, and imported by 2 packages

Involved Source Files

	    d2.go
	    visualizer.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Fragment (struct)

		Fields (total 3)
			Active am.S
			MachId string
			States am.S
		As Inputs Of (at least one exported)
			func UpdateCache(ctx context.Context, filepath string, dom *goquery.Document, fragments ...*Fragment) error

	 type Renderer (struct)

		Fields (total 30)
			OutputD2 bool
				Output a D2 diagram (default)

			OutputD2Svg bool
				Render a D2 SVG in addition to the plain text version.

			OutputElk bool
				Render edges using ELK.

			OutputFilename string
				Filename without an extension.

			OutputMermaid bool
				Output a Mermaid diagram (basic support only).

			OutputMermaidSvg bool
				Render a Mermaid SVG in addition to the plain text version.

			RenderActive bool
				Style currently active states. TODO style errors red

			RenderAllowlist am.S
				Render only these states

			RenderConns bool
				Render RPC connections

			RenderDepth int
				How deep to render from starting machines. Same as RenderDistance, but only
				for submachines.

			RenderDetailedPipes bool
				Render detailed pipes as state -> state

			RenderDistance int
				TODO RenderSkipMachsRe       []regexp.Regexp
				Distance to render from starting machines.

			RenderException bool
				With RenderStates, false will hide Exception, and without RenderStates true
				will render Exception.

			RenderHalfConns bool
				Render RPC connections to non-rendered machines.

			RenderHalfHierarchy bool
				Render a parent relation to and from non-rendered machines.

			RenderHalfPipes bool
				Render pipes to non-rendered machines / states.

			RenderInherited bool
				Render inherited states.

			RenderMachs []string
				Render only these machines as starting points.

			RenderMachsRe []*regexp.Regexp
				Render only machines matching the regular expressions as starting points.

			RenderMarkInherited bool
				Mark inherited states. TODO refac to RenderMarkOwnStates

			RenderNestSubmachines bool
				Render submachines nested inside their parents. See also RenderDepth.

			RenderParentRel bool
				Render the parent relation. Ignored when RenderNestSubmachines.

			RenderPipeStates bool
				Render states which have pipes being rendered, even if the state should
				not be rendered.

			RenderPipes bool
				Render group of pipes as mach->mach

			RenderReady bool
				With RenderStates, false will hide Ready, and without RenderStates true
				will render Ready.

			RenderRelations bool
				Render relation between states. TODO After relation
				TODO specific relations

			RenderSkipMachs []string
				Skip rendering of these machines.

			RenderStart bool
				With RenderStates, false will hide Start, and without RenderStates true
				will render Start.

			RenderStates bool
				Render states bubbles.

			RenderTags bool
				Render a tags box for machines having some.

		Methods (total 2)
			(*Renderer) GenDiagrams(ctx context.Context) error
			(*Renderer) RenderDefaults()
		As Outputs Of (at least one exported)
			func NewRenderer(graph *amgraph.Graph, logger func(msg string, args ...any)) *Renderer
		As Inputs Of (at least 3)
			func PresetBird(r *Renderer)
			func PresetMap(r *Renderer)
			func PresetSingle(r *Renderer)

	 type Visualizer (struct)

		Fields (total 2)
			Mach *am.Machine
			R *Renderer
		Methods (total 8)
			(*Visualizer) ClientMsgEnter(e *am.Event) bool
			(*Visualizer) ClientMsgState(e *am.Event)
			(*Visualizer) Clients() map[string]amgraph.Client
			(*Visualizer) ConnectEventEnter(e *am.Event) bool
			(*Visualizer) ConnectEventState(e *am.Event)
			(*Visualizer) GoToMachAddrState(e *am.Event)
			(*Visualizer) HImportData(filename string) error
			(*Visualizer) InitClientState(e *am.Event)
		As Outputs Of (at least one exported)
			func New(ctx context.Context, name string) (*Visualizer, error)


Package-Level Functions (total 6)

	 func New(ctx context.Context, name string) (*Visualizer, error)
		New creates a new Visualizer - state machine, RPC server, and a renderer.

	 func NewRenderer(graph *amgraph.Graph, logger func(msg string, args ...any)) *Renderer
	 func PresetBird(r *Renderer)
	 func PresetMap(r *Renderer)
	 func PresetSingle(r *Renderer)
	 func UpdateCache(ctx context.Context, filepath string, dom *goquery.Document, fragments ...*Fragment) error
		UpdateCache updates [dom] according to [fragments], and saves to [filepath].


Package-Level Variables (only one)

	  var HtmlDiagram []byte

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.