API Reference
Class
MermaidSankeyDocument
Describes a parsed Mermaid Sankey diagram document.
Inheritance
- MermaidDocument
- MermaidSankeyDocument
Usage
Explore 9 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
- Method MermaidParser.ParseSankey
Accepted by parameters 8
- Extension method MermaidSankeyDocument.ToChart
- Extension method MermaidSankeyDocument.ToPng
- Extension method MermaidSankeyDocument.ToSvg
- Extension method MermaidSankeyDocument.ToVisualArtifact
- Method MermaidSankeyRendering.ToChart
- Method MermaidSankeyRendering.ToPng
- Method MermaidSankeyRendering.ToSvg
- Method MermaidSankeyRendering.ToVisualArtifact
Constructors
public MermaidSankeyDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
Inherited Properties
public MermaidDiagramKind Kind { get; set; } #Inherited from MermaidDocument
public Boolean IsDiagnosticOnly { get; } #Inherited from MermaidDocument
public String SourceText { get; set; } #Inherited from MermaidDocument
public MermaidSourceSpan HeaderSpan { get; set; } #Inherited from MermaidDocument
public String Header { get; set; } #Inherited from MermaidDocument
public String? FrontMatter { get; set; } #Inherited from MermaidDocument
public VisualAccessibility Accessibility { get; } #Inherited from MermaidDocument
public String? Theme { get; set; } #Inherited from MermaidDocument
public List<MermaidDirective> Directives { get; } #Inherited from MermaidDocument
public List<MermaidRawStatement> RawStatements { get; } #Inherited from MermaidDocument
Extension Methods
public static Chart ToChart(MermaidSankeyDocument document, MermaidSankeyRenderOptions? options = null) #Returns:
ChartConverts a Mermaid Sankey document into a renderer-independent ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidSankeyDocument
- options ChartForgeX.Mermaid.MermaidSankeyRenderOptions? = null
public static Byte[] ToPng(MermaidSankeyDocument document, MermaidSankeyRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid Sankey document to static PNG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidSankeyDocument
- options ChartForgeX.Mermaid.MermaidSankeyRenderOptions? = null
public static String ToSvg(MermaidSankeyDocument document, MermaidSankeyRenderOptions? options = null) #Returns:
StringRenders a Mermaid Sankey document to static SVG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidSankeyDocument
- options ChartForgeX.Mermaid.MermaidSankeyRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidSankeyDocument document, MermaidSankeyRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid Sankey document in a visual artifact envelope backed by a ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidSankeyDocument
- options ChartForgeX.Mermaid.MermaidSankeyRenderOptions? = null