Class MermaidExportOptions<TVertex, TEdge>

Namespace

Graph1x.Serialization

Assembly

Graph1x.dll

Options controlling ToMermaid<TVertex, TEdge>(IReadOnlyGraph<TVertex, TEdge>, MermaidExportOptions<TVertex, TEdge>).

public sealed record MermaidExportOptions<TVertex, TEdge> : IEquatable<MermaidExportOptions<TVertex, TEdge>> where TVertex : notnull where TEdge : IEdge<TVertex>

Type Parameters

TVertex

The vertex type.

TEdge

The edge type.

Inheritance

object

MermaidExportOptions<TVertex, TEdge>

Implements

IEquatable<MermaidExportOptions<TVertex, TEdge>>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Direction

Gets the flow direction emitted in the flowchart header. Defaults to TopDown.

public MermaidDirection Direction { get; init; }

Property Value

MermaidDirection

EdgeLabel

Gets the function producing an edge's label. When null, edges are emitted without labels.

public Func<TEdge, string>? EdgeLabel { get; init; }

Property Value

Func<TEdge, string>

VertexLabel

Gets the function producing a vertex's display label. Defaults to ToString(). Node identifiers are always synthetic (v0, v1, …); this selector only affects the label text.

public Func<TVertex, string>? VertexLabel { get; init; }

Property Value

Func<TVertex, string>