Skip to content
ConsoleMonster
Class

DiagramNode

ConsoleMonster.Widgets

Edit on GitHub
Namespace
ConsoleMonster.Widgets
Assembly
ConsoleMonster
Source
DiagramModels.cs:63
Modifiers
sealed

One component. Its label is also its identity unless Id is explicitly set.

Inheritance

  • object
  • DiagramNode

Usage

Explore 36 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 16

Accepted by parameters 20

Constructors

public DiagramNode(string label) #
DiagramModels.cs:63

Creates a component with a literal label.

Parameters

label string required

Properties

public string Id { get; set; } #
DiagramModels.cs:56

The connection and live-update key; defaults to Label.

public string Label { get; set; } #
DiagramModels.cs:58

The name on the first line.

public DiagramNodeKind Kind { get; set; } #
DiagramModels.cs:60

The component kind and icon.

public string? Subtitle { get; set; } #
DiagramModels.cs:62

The second line, retained when a live value is present.

public StatusKind Status { get; set; } #
DiagramModels.cs:66

The component's health. Omit it to show no status marker.

public string? Value { get; set; } #
DiagramModels.cs:68

The third line, independent of Subtitle.

public List<string> To { get; } #
DiagramModels.cs:70

Destination ids for unlabelled outgoing connections.

Extension Methods

AddTo 3 overloads
public static DiagramNode AddTo(DiagramNode diagramNode, string item) #

Adds an item to DiagramNode.To: Destination ids for unlabelled outgoing connections.

Parameters

diagramNode ConsoleMonster.Widgets.DiagramNode required
The instance.
item string required
The item.

Returns

DiagramNode The same instance.
public static DiagramNode AddTo(DiagramNode diagramNode, params string[] items) #

Adds items to DiagramNode.To: Destination ids for unlabelled outgoing connections.

Parameters

diagramNode ConsoleMonster.Widgets.DiagramNode required
The instance.
items string[] required
The items, in order.

Returns

DiagramNode The same instance.
public static DiagramNode AddTo(DiagramNode diagramNode, IEnumerable<string> items) #

Adds items to DiagramNode.To: Destination ids for unlabelled outgoing connections.

Parameters

diagramNode ConsoleMonster.Widgets.DiagramNode required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

DiagramNode The same instance.
public static DiagramNode Id(DiagramNode diagramNode, string value) #

Sets DiagramNode.Id: The connection and live-update key; defaults to Label.

Parameters

diagramNode ConsoleMonster.Widgets.DiagramNode required
The instance.
value string required
The value.

Returns

DiagramNode The same instance.

Examples

// C# initializer or property    // C# fluent
diagramNode.Id = value;          diagramNode.Id(value);
public static DiagramNode Kind(DiagramNode diagramNode, DiagramNodeKind value) #

Sets DiagramNode.Kind: The component kind and icon.

Parameters

diagramNode ConsoleMonster.Widgets.DiagramNode required
The instance.
value ConsoleMonster.Widgets.DiagramNodeKind required
The value.

Returns

DiagramNode The same instance.

Examples

// C# initializer or property    // C# fluent
diagramNode.Kind = value;        diagramNode.Kind(value);
public static DiagramNode Label(DiagramNode diagramNode, string value) #

Sets DiagramNode.Label: The name on the first line.

Parameters

diagramNode ConsoleMonster.Widgets.DiagramNode required
The instance.
value string required
The value.

Returns

DiagramNode The same instance.

Examples

// C# initializer or property    // C# fluent
diagramNode.Label = value;       diagramNode.Label(value);
public static DiagramNode Status(DiagramNode diagramNode, StatusKind value) #

Sets DiagramNode.Status: The component's health. Omit it to show no status marker.

Parameters

diagramNode ConsoleMonster.Widgets.DiagramNode required
The instance.
value ConsoleMonster.Styling.StatusKind required
The value.

Returns

DiagramNode The same instance.

Examples

// C# initializer or property    // C# fluent
diagramNode.Status = value;      diagramNode.Status(value);
public static DiagramNode Subtitle(DiagramNode diagramNode, string? value) #

Sets DiagramNode.Subtitle: The second line, retained when a live value is present.

Parameters

diagramNode ConsoleMonster.Widgets.DiagramNode required
The instance.
value string? required
The value.

Returns

DiagramNode The same instance.

Examples

// C# initializer or property    // C# fluent
diagramNode.Subtitle = value;    diagramNode.Subtitle(value);
public static DiagramNode Value(DiagramNode diagramNode, string? value) #

Sets DiagramNode.Value: The third line, independent of Subtitle.

Parameters

diagramNode ConsoleMonster.Widgets.DiagramNode required
The instance.
value string? required
The value.

Returns

DiagramNode The same instance.

Examples

// C# initializer or property    // C# fluent
diagramNode.Value = value;       diagramNode.Value(value);