Class

Diagram

ConsoleMonster.Widgets

Namespace: ConsoleMonster.Widgets
Assembly: ConsoleMonster
Source: Diagram.cs:18
Base: LiveWidget
Implements: IWidget ILiveTarget
Modifiers: sealed

A live diagram with a dependency-free tree view and an optional Graphics topology renderer.

Inheritance

LiveWidget
Diagram

Remarks

Configure collections before sharing the diagram with a session. Use Handle for concurrent live updates; direct collection edits are intended for sequential configuration, not concurrent writers.

Usage

Explore 84 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 46

Method DiagramExtensions.ToDiagram
Method Ui.Diagram
Extension method Diagram.AddGroup
Extension method Diagram.AddGroups
Extension method Diagram.AddLink
Extension method Diagram.AddLinks
Extension method Diagram.AddNode
Extension method Diagram.AddNodes
Extension method Diagram.AddUseCase
Extension method Diagram.AddUseCases
Extension method Diagram.Direction
Extension method Diagram.MaxPayloadLines
Extension method Diagram.MaxStepLines
Extension method Diagram.Scenario
Extension method Diagram.ShowDetails
Extension method Diagram.ShowKeys
Extension method Diagram.ShowLegend
Extension method Diagram.ShowStepPanel
Extension method Diagram.ShowSummary
Extension method Diagram.Title
Method Diagram.FromLinks``1
Method Diagram.Group
Method Diagram.Link
Method Diagram.Load
Method Diagram.Node
Method Diagram.SelectScenario
Method Diagram.Summary
Method Diagram.UseCase
Method WidgetsFluent.AddGroup
Method WidgetsFluent.AddGroups
Method WidgetsFluent.AddLink
Method WidgetsFluent.AddLinks
Method WidgetsFluent.AddNode
Method WidgetsFluent.AddNodes
Method WidgetsFluent.AddUseCase
Method WidgetsFluent.AddUseCases
Method WidgetsFluent.Direction
Method WidgetsFluent.MaxPayloadLines
Method WidgetsFluent.MaxStepLines
Method WidgetsFluent.Scenario
Method WidgetsFluent.ShowDetails
Method WidgetsFluent.ShowKeys
Method WidgetsFluent.ShowLegend
Method WidgetsFluent.ShowStepPanel
Method WidgetsFluent.ShowSummary
Method WidgetsFluent.Title

Accepted by parameters 38

Method ContentBuilder.Diagram parameter configure
Method ContentBuilder.Diagram parameter diagram
Extension method Diagram.AddGroup parameter diagram
Extension method Diagram.AddGroups parameter diagram
Extension method Diagram.AddLink parameter diagram
Extension method Diagram.AddLinks parameter diagram
Extension method Diagram.AddNode parameter diagram
Extension method Diagram.AddNodes parameter diagram
Extension method Diagram.AddUseCase parameter diagram
Extension method Diagram.AddUseCases parameter diagram
Extension method Diagram.Direction parameter diagram
Extension method Diagram.MaxPayloadLines parameter diagram
Extension method Diagram.MaxStepLines parameter diagram
Extension method Diagram.Scenario parameter diagram
Extension method Diagram.ShowDetails parameter diagram
Extension method Diagram.ShowKeys parameter diagram
Extension method Diagram.ShowLegend parameter diagram
Extension method Diagram.ShowStepPanel parameter diagram
Extension method Diagram.ShowSummary parameter diagram
Extension method Diagram.Title parameter diagram
Method WidgetsFluent.AddGroup parameter diagram
Method WidgetsFluent.AddGroups parameter diagram
Method WidgetsFluent.AddLink parameter diagram
Method WidgetsFluent.AddLinks parameter diagram
Method WidgetsFluent.AddNode parameter diagram
Method WidgetsFluent.AddNodes parameter diagram
Method WidgetsFluent.AddUseCase parameter diagram
Method WidgetsFluent.AddUseCases parameter diagram
Method WidgetsFluent.Direction parameter diagram
Method WidgetsFluent.MaxPayloadLines parameter diagram
Method WidgetsFluent.MaxStepLines parameter diagram
Method WidgetsFluent.Scenario parameter diagram
Method WidgetsFluent.ShowDetails parameter diagram
Method WidgetsFluent.ShowKeys parameter diagram
Method WidgetsFluent.ShowLegend parameter diagram
Method WidgetsFluent.ShowStepPanel parameter diagram
Method WidgetsFluent.ShowSummary parameter diagram
Method WidgetsFluent.Title parameter diagram

Constructors

public Diagram(string title = "", string widgetId = "diagram") #

Diagram.cs:18

Creates a diagram with a title and a live-update identity.

Parameters

title string = "" optional
widgetId string = "diagram" optional

Methods

public override void Apply(LiveEvent liveEvent) #

Diagram.cs:144

Applies an event to the widget's state.

Parameters

liveEvent ConsoleMonster.Live.LiveEvent required: The event.

public void ClearStep() #

Diagram.cs:113

Clears the active step.

public override string? Describe(LiveEvent liveEvent) #

Diagram.cs:155

Returns a line describing the event for line-based outputs (Stream/Plain), or null when the event is not worth a line (for example a single counter increment). Called after ILiveTarget.Apply.

Parameters

liveEvent ConsoleMonster.Live.LiveEvent required: The event that was applied.

Returns

string? A plain line or null.

public void FirstStep() #

Diagram.cs:109

Selects the first step.

public void FocusNext(int delta = 1) #

Diagram.cs:123

Moves focus in reading order.

Parameters

delta int = 1 optional

public void FocusNode(string? id) #

Diagram.cs:121

Focuses a component, or clears focus with null.

Parameters

id string? required

public static Diagram FromLinks<T>(IEnumerable<T?> rows, Func<T?, string> from, Func<T?, string> to, Func<T?, string?>? label = null, Func<T?, StatusKind>? status = null, Func<T?, string?>? group = null)

Diagram.cs:68

Creates a diagram from connection rows. Endpoints are created automatically; group selects the source's group.

Type Parameters

T

Parameters

rows System.Collections.Generic.IEnumerable<T?> required
from System.Func<T?, string> required
to System.Func<T?, string> required
label System.Func<T?, string?>? = null optional
status System.Func<T?, ConsoleMonster.Styling.StatusKind>? = null optional
group System.Func<T?, string?>? = null optional

Returns

Diagram

public Diagram Group(string label, Action<DiagramGroupBuilder> configure) #

Diagram.Fluent.cs:24

Adds a group and returns this diagram.

Parameters

label string required
configure System.Action<ConsoleMonster.Widgets.DiagramGroupBuilder> required

Returns

Diagram

public DiagramHandle Handle(ILiveDispatcher dispatcher) #

Diagram.cs:88

Posts live updates through a session.

Parameters

dispatcher ConsoleMonster.Live.ILiveDispatcher required

Returns

DiagramHandle

public bool HandleInput(InputEvent input) #

Diagram.cs:125

Handles a diagram key; false lets the host handle it.

Parameters

input ConsoleMonster.Input.InputEvent required

Returns

bool

public void LastStep() #

Diagram.cs:111

Selects the last step.

public Diagram Link(string from, string to, Action<DiagramLinkBuilder>? configure = null) #

Diagram.Fluent.cs:16

Adds a connection and returns this diagram.

Parameters

from string required
to string required
configure System.Action<ConsoleMonster.Widgets.DiagramLinkBuilder>? = null optional

Returns

Diagram

public static Diagram Load(string path, string? diagramId = null) #

Diagram.cs:65

Loads a ChartForgeX file using the registered Graphics provider.

Parameters

path string required
diagramId string? = null optional

Returns

Diagram

public override Size Measure(Constraints constraints, RenderContext context) #

Diagram.cs:139

Returns the size the widget wants within the constraints.

Parameters

constraints ConsoleMonster.Layout.Constraints required: The space offered.
context ConsoleMonster.Canvas.RenderContext required: Profile, theme and glyphs.

Returns

Size The desired size, never larger than the constraints.

public void NextScenario(int delta = 1) #

Diagram.cs:101

Selects the next or previous use case.

Parameters

delta int = 1 optional

public void NextStep() #

Diagram.cs:105

Advances to the next step.

public Diagram Node(string label, Action<DiagramNodeBuilder>? configure = null) #

Diagram.Fluent.cs:10

Adds a component and returns this diagram.

Parameters

label string required
configure System.Action<ConsoleMonster.Widgets.DiagramNodeBuilder>? = null optional

Returns

Diagram

public void Pause() #

Diagram.cs:117

Pauses use-case playback.

public void Play() #

Diagram.cs:115

Starts use-case playback.

public void PreviousStep() #

Diagram.cs:107

Moves to the previous step.

public override void Render(Region region, RenderContext context) #

Diagram.cs:141

Renders into a region. The region may be smaller or larger than the measured size.

Parameters

region ConsoleMonster.Canvas.Region required: The target region.
context ConsoleMonster.Canvas.RenderContext required: Profile, theme and glyphs.

public AppState Run(ConsoleAppOptions? options = null, CancellationToken cancellationToken = default) #

Diagram.cs:128

Opens the Graphics keyboard view, or prints a tree snapshot without Graphics.

Parameters

options ConsoleMonster.Interactive.ConsoleAppOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

AppState

public Diagram SelectScenario(string? id) #

Diagram.cs:99

Selects a use case and clears its active step.

Parameters

id string? required

Returns

Diagram

public void SetValue(string node, string? value, StatusKind? status = null) #

Diagram.cs:91

Sets a component's third line and optionally its status.

Parameters

node string required
value string? required
status ConsoleMonster.Styling.StatusKind? = null optional

public void Step(int index) #

Diagram.cs:103

Selects a zero-based step.

Parameters

index int required

public Diagram Summary(bool show = true) #

Diagram.Fluent.cs:6

Controls the attention summary and returns this diagram.

Parameters

show bool = true optional

Returns

Diagram

public void TogglePlay() #

Diagram.cs:119

Toggles use-case playback.

public byte[] ToPng() #

Diagram.cs:137

Exports the topology as PNG through Graphics.

Returns

byte[]

public Diagram UseCase(string label, Action<DiagramUseCaseBuilder> configure) #

Diagram.Fluent.cs:32

Adds a use case and returns this diagram.

Parameters

label string required
configure System.Action<ConsoleMonster.Widgets.DiagramUseCaseBuilder> required

Returns

Diagram

Inherited Methods

Properties

public string Title { get; set; } #

Diagram.cs:22

The diagram title.

public DiagramDirection Direction { get; set; } #

Diagram.cs:24

The reading direction.

public List<DiagramNode> Nodes { get; } #

Diagram.cs:26

Ungrouped components.

public List<DiagramLink> Links { get; } #

Diagram.cs:28

Explicit connections.

public List<DiagramGroup> Groups { get; } #

Diagram.cs:30

Top-level groups.

public List<DiagramUseCase> UseCases { get; } #

Diagram.cs:32

Selectable sequences of interactions.

public bool ShowSummary { get; set; } #

Diagram.cs:34

Lists every node and link whose status is not Pass, with unabridged text.

public bool ShowLegend { get; set; } #

Diagram.cs:36

Whether status meanings are shown below the topology.

public bool ShowStepPanel { get; set; } #

Diagram.cs:38

Whether the selected use case's steps are shown.

public bool ShowDetails { get; set; } #

Diagram.cs:40

Whether focused-node details are shown.

public bool ShowKeys { get; set; } #

Diagram.cs:42

Whether keyboard hints are shown.

public int MaxPayloadLines { get; set; } #

Diagram.cs:44

The maximum visible payload lines.

public int MaxStepLines { get; set; } #

Diagram.cs:46

The maximum visible step lines.

public string? ScenarioId { get; } #

Diagram.cs:48

The selected use case id, or null.

public DiagramUseCase? Scenario { get; } #

Diagram.cs:50

The selected use case, or null.

public IReadOnlyDictionary<string, string> Values { get; } #

Diagram.cs:52

A snapshot of component values, keyed by their explicit id or label.

public int? StepIndex { get; } #

Diagram.cs:54

The active zero-based step, or null.

public string? FocusNodeId { get; } #

Diagram.cs:56

The focused component id, or null.

public bool Playing { get; } #

Diagram.cs:58

Whether the use case is playing.

Inherited Properties

Extension Methods

public static Diagram AddGroup(Diagram diagram, DiagramGroup item) #

Adds an item to Diagram.Groups: Top-level groups.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
item ConsoleMonster.Widgets.DiagramGroup required: The item.

Returns

Diagram The same instance.

AddGroups 2 overloads

public static Diagram AddGroups(Diagram diagram, params DiagramGroup[] items) #

Adds items to Diagram.Groups: Top-level groups.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
items ConsoleMonster.Widgets.DiagramGroup[] required: The items, in order.

Returns

Diagram The same instance.

public static Diagram AddGroups(Diagram diagram, IEnumerable<DiagramGroup> items) #

Adds items to Diagram.Groups: Top-level groups.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.DiagramGroup> required: The items, in order.

Returns

Diagram The same instance.

public static Diagram AddLink(Diagram diagram, DiagramLink item) #

Adds an item to Diagram.Links: Explicit connections.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
item ConsoleMonster.Widgets.DiagramLink required: The item.

Returns

Diagram The same instance.

AddLinks 2 overloads

public static Diagram AddLinks(Diagram diagram, params DiagramLink[] items) #

Adds items to Diagram.Links: Explicit connections.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
items ConsoleMonster.Widgets.DiagramLink[] required: The items, in order.

Returns

Diagram The same instance.

public static Diagram AddLinks(Diagram diagram, IEnumerable<DiagramLink> items) #

Adds items to Diagram.Links: Explicit connections.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.DiagramLink> required: The items, in order.

Returns

Diagram The same instance.

public static Diagram AddNode(Diagram diagram, DiagramNode item) #

Adds an item to Diagram.Nodes: Ungrouped components.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
item ConsoleMonster.Widgets.DiagramNode required: The item.

Returns

Diagram The same instance.

AddNodes 2 overloads

public static Diagram AddNodes(Diagram diagram, params DiagramNode[] items) #

Adds items to Diagram.Nodes: Ungrouped components.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
items ConsoleMonster.Widgets.DiagramNode[] required: The items, in order.

Returns

Diagram The same instance.

public static Diagram AddNodes(Diagram diagram, IEnumerable<DiagramNode> items) #

Adds items to Diagram.Nodes: Ungrouped components.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.DiagramNode> required: The items, in order.

Returns

Diagram The same instance.

public static Diagram AddUseCase(Diagram diagram, DiagramUseCase item) #

Adds an item to Diagram.UseCases: Selectable sequences of interactions.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
item ConsoleMonster.Widgets.DiagramUseCase required: The item.

Returns

Diagram The same instance.

AddUseCases 2 overloads

public static Diagram AddUseCases(Diagram diagram, params DiagramUseCase[] items) #

Adds items to Diagram.UseCases: Selectable sequences of interactions.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
items ConsoleMonster.Widgets.DiagramUseCase[] required: The items, in order.

Returns

Diagram The same instance.

public static Diagram AddUseCases(Diagram diagram, IEnumerable<DiagramUseCase> items) #

Adds items to Diagram.UseCases: Selectable sequences of interactions.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.DiagramUseCase> required: The items, in order.

Returns

Diagram The same instance.

public static Diagram Direction(Diagram diagram, DiagramDirection value) #

Sets Diagram.Direction: The reading direction.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
value ConsoleMonster.Widgets.DiagramDirection required: The value.

Returns

Diagram The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.Diagram { Direction = value };    Ui.Diagram().Direction(value);

public static Diagram MaxPayloadLines(Diagram diagram, int value) #

Sets Diagram.MaxPayloadLines: The maximum visible payload lines.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
value int required: The value.

Returns

Diagram The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.Diagram { MaxPayloadLines = value };    Ui.Diagram().MaxPayloadLines(value);

public static Diagram MaxStepLines(Diagram diagram, int value) #

Sets Diagram.MaxStepLines: The maximum visible step lines.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
value int required: The value.

Returns

Diagram The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.Diagram { MaxStepLines = value };    Ui.Diagram().MaxStepLines(value);

public static Diagram Scenario(Diagram diagram, Action<DiagramUseCase> configure) #

Configures Diagram.Scenario in place: The selected use case, or null.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
configure System.Action<ConsoleMonster.Widgets.DiagramUseCase> required: Configures the value.

Returns

Diagram The same instance.

ShowDetails 2 overloads

public static Diagram ShowDetails(Diagram diagram, bool value) #

Sets Diagram.ShowDetails: Whether focused-node details are shown.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
value bool required: The value.

Returns

Diagram The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Diagram { ShowDetails = value };    Ui.Diagram().ShowDetails(value);

public static Diagram ShowDetails(Diagram diagram) #

Sets Diagram.ShowDetails to true.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance to configure.

Returns

Diagram The same instance.

ShowKeys 2 overloads

public static Diagram ShowKeys(Diagram diagram, bool value) #

Sets Diagram.ShowKeys: Whether keyboard hints are shown.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
value bool required: The value.

Returns

Diagram The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Diagram { ShowKeys = value };    Ui.Diagram().ShowKeys(value);

public static Diagram ShowKeys(Diagram diagram) #

Sets Diagram.ShowKeys to true.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance to configure.

Returns

Diagram The same instance.

ShowLegend 2 overloads

public static Diagram ShowLegend(Diagram diagram, bool value) #

Sets Diagram.ShowLegend: Whether status meanings are shown below the topology.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
value bool required: The value.

Returns

Diagram The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Diagram { ShowLegend = value };    Ui.Diagram().ShowLegend(value);

public static Diagram ShowLegend(Diagram diagram) #

Sets Diagram.ShowLegend to true.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance to configure.

Returns

Diagram The same instance.

ShowStepPanel 2 overloads

public static Diagram ShowStepPanel(Diagram diagram, bool value) #

Sets Diagram.ShowStepPanel: Whether the selected use case's steps are shown.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
value bool required: The value.

Returns

Diagram The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.Diagram { ShowStepPanel = value };    Ui.Diagram().ShowStepPanel(value);

public static Diagram ShowStepPanel(Diagram diagram) #

Sets Diagram.ShowStepPanel to true.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance to configure.

Returns

Diagram The same instance.

ShowSummary 2 overloads

public static Diagram ShowSummary(Diagram diagram, bool value) #

Sets Diagram.ShowSummary: Lists every node and link whose status is not Pass, with unabridged text.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
value bool required: The value.

Returns

Diagram The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Diagram { ShowSummary = value };    Ui.Diagram().ShowSummary(value);

public static Diagram ShowSummary(Diagram diagram) #

Sets Diagram.ShowSummary to true.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance to configure.

Returns

Diagram The same instance.

public static Diagram Title(Diagram diagram, string value) #

Sets Diagram.Title: The diagram title.

Parameters

diagram ConsoleMonster.Widgets.Diagram required: The instance.
value string required: The value.

Returns

Diagram The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Widgets.Diagram { Title = value };    Ui.Diagram().Title(value);