Skip to content
ConsoleMonster
Class

DiagramHandle

ConsoleMonster.Widgets

Edit on GitHub
Namespace
ConsoleMonster.Widgets
Assembly
ConsoleMonster
Source
DiagramHandle.cs:8
Base
LiveHandle
Modifiers
sealed

Posts diagram changes through the same live-update contract as PowerShell.

Inheritance

Usage

Explore 1 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 1

Constructors

public DiagramHandle(ILiveDispatcher dispatcher, string widgetId) #
DiagramHandle.cs:8

Creates a handle for a live diagram.

Parameters

dispatcher ConsoleMonster.Live.ILiveDispatcher required
widgetId string required

Methods

public void Focus(string? node) #
DiagramHandle.cs:25

Focuses a component.

Parameters

node string? required
public void Pause() #
DiagramHandle.cs:23

Pauses playback.

public void Play() #
DiagramHandle.cs:21

Starts playback.

public void Scenario(string? id) #
DiagramHandle.cs:17

Selects a use case.

Parameters

id string? required
public void Step(int index) #
DiagramHandle.cs:19

Selects a zero-based step.

Parameters

index int required
public void Value(string node, string? text, StatusKind? status = null) #
DiagramHandle.cs:12

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

Parameters

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

Exceptions

  • ArgumentException – The node key is null, empty or whitespace. Validation runs before the update is queued.