Class

DiagramLink

ConsoleMonster.Widgets

Edit on GitHub

Namespace: ConsoleMonster.Widgets
Assembly: ConsoleMonster
Source: DiagramModels.cs:83
Modifiers: sealed

A directed connection; undeclared endpoint ids create labelled nodes.

Inheritance

object
DiagramLink

Usage

Explore 29 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 13

Property Diagram.Links
Extension method DiagramLink.Both
Extension method DiagramLink.From
Extension method DiagramLink.Label
Extension method DiagramLink.Status
Extension method DiagramLink.Style
Extension method DiagramLink.To
Method WidgetsFluent.Both
Method WidgetsFluent.From
Method WidgetsFluent.Label
Method WidgetsFluent.Status
Method WidgetsFluent.Style
Method WidgetsFluent.To

Accepted by parameters 16

Extension method Diagram.AddLink parameter item
Extension method Diagram.AddLinks parameter items
Extension method DiagramLink.Both parameter diagramLink
Extension method DiagramLink.From parameter diagramLink
Extension method DiagramLink.Label parameter diagramLink
Extension method DiagramLink.Status parameter diagramLink
Extension method DiagramLink.Style parameter diagramLink
Extension method DiagramLink.To parameter diagramLink
Method WidgetsFluent.AddLink parameter item
Method WidgetsFluent.AddLinks parameter items
Method WidgetsFluent.Both parameter diagramLink
Method WidgetsFluent.From parameter diagramLink
Method WidgetsFluent.Label parameter diagramLink
Method WidgetsFluent.Status parameter diagramLink
Method WidgetsFluent.Style parameter diagramLink
Method WidgetsFluent.To parameter diagramLink

Constructors

public DiagramLink(string from, string to) #

DiagramModels.cs:83

Connects two node ids.

Parameters

from string required
to string required

Inherited Methods

Properties

public string From { get; set; } #

DiagramModels.cs:78

The source node id.

public string To { get; set; } #

DiagramModels.cs:80

The destination node id.

public string? Label { get; set; } #

DiagramModels.cs:82

The connection's literal label.

public StatusKind Status { get; set; } #

DiagramModels.cs:86

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

public DiagramLinkStyle Style { get; set; } #

DiagramModels.cs:88

The connection's stroke.

public bool Both { get; set; } #

DiagramModels.cs:90

Whether arrows point in both directions.

Extension Methods

Both 2 overloads

public static DiagramLink Both(DiagramLink diagramLink, bool value) #

Sets DiagramLink.Both: Whether arrows point in both directions.

Parameters

diagramLink ConsoleMonster.Widgets.DiagramLink required: The instance.
value bool required: The value.

Returns

DiagramLink The same instance.

Examples

// C# initializer or property    // C# fluent
diagramLink.Both = value;        diagramLink.Both(value);

public static DiagramLink Both(DiagramLink diagramLink) #

Sets DiagramLink.Both to true.

Parameters

diagramLink ConsoleMonster.Widgets.DiagramLink required: The instance to configure.

Returns

DiagramLink The same instance.

public static DiagramLink From(DiagramLink diagramLink, string value) #

Sets DiagramLink.From: The source node id.

Parameters

diagramLink ConsoleMonster.Widgets.DiagramLink required: The instance.
value string required: The value.

Returns

DiagramLink The same instance.

Examples

// C# initializer or property    // C# fluent
diagramLink.From = value;        diagramLink.From(value);

public static DiagramLink Label(DiagramLink diagramLink, string? value) #

Sets DiagramLink.Label: The connection's literal label.

Parameters

diagramLink ConsoleMonster.Widgets.DiagramLink required: The instance.
value string? required: The value.

Returns

DiagramLink The same instance.

Examples

// C# initializer or property    // C# fluent
diagramLink.Label = value;       diagramLink.Label(value);

public static DiagramLink Status(DiagramLink diagramLink, StatusKind value) #

Sets DiagramLink.Status: The connection's health. Omit it to show no status marker.

Parameters

diagramLink ConsoleMonster.Widgets.DiagramLink required: The instance.
value ConsoleMonster.Styling.StatusKind required: The value.

Returns

DiagramLink The same instance.

Examples

// C# initializer or property    // C# fluent
diagramLink.Status = value;      diagramLink.Status(value);

public static DiagramLink Style(DiagramLink diagramLink, DiagramLinkStyle value) #

Sets DiagramLink.Style: The connection's stroke.

Parameters

diagramLink ConsoleMonster.Widgets.DiagramLink required: The instance.
value ConsoleMonster.Widgets.DiagramLinkStyle required: The value.

Returns

DiagramLink The same instance.

Examples

// C# initializer or property    // C# fluent
diagramLink.Style = value;       diagramLink.Style(value);

public static DiagramLink To(DiagramLink diagramLink, string value) #

Sets DiagramLink.To: The destination node id.

Parameters

diagramLink ConsoleMonster.Widgets.DiagramLink required: The instance.
value string required: The value.

Returns

DiagramLink The same instance.

Examples

// C# initializer or property    // C# fluent
diagramLink.To = value;          diagramLink.To(value);