Meziantou.Framework

SankeyLink Class

Namespace
Meziantou.Framework.Mermaid
Assembly
Meziantou.Framework.Mermaid.dll
Package
Meziantou.Framework.Mermaid 1.0.1
Source
SankeyLink.cs
Available in package assets
net10.0net11.0

A link of a sankey diagram: a flow of a quantity from a source node to a target node.

public sealed class SankeyLink

Constructors

NameDescription
SankeyLink(string, string, double)Initializes a new instance of the SankeyLink class.

SankeyLink(string, string, double)

SankeyLink.cs

Initializes a new instance of the SankeyLink class.

public SankeyLink(string source, string target, double value)

Parameters

source string
The name of the node the flow comes from.
target string
The name of the node the flow goes to.
value double
The quantity, which gives the width of the link.

Exceptions

ArgumentOutOfRangeException
value is negative, not finite or larger than 1E+300.

Properties

NameDescription
SourceGets or sets the name of the node the flow comes from.
TargetGets or sets the name of the node the flow goes to.
ValueGets or sets the quantity, which gives the width of the link.

Source

SankeyLink.cs

Gets or sets the name of the node the flow comes from.

public string Source { get; set; }

Property value

string

Target

SankeyLink.cs

Gets or sets the name of the node the flow goes to.

public string Target { get; set; }

Property value

string

Value

SankeyLink.cs

Gets or sets the quantity, which gives the width of the link.

public double Value { get; set; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is negative, not finite or larger than 1E+300.