Skip to content
ChartForgeX

API Reference

Class

MermaidFlowchartRendering

Edit on GitHub
Namespace ChartForgeX.Mermaid
Assembly ChartForgeX.Mermaid
Source MermaidFlowchartRendering.cs:21
Modifiers static

Provides ChartForgeX rendering adapters for parsed Mermaid flowcharts.

Inheritance

  • Object
  • MermaidFlowchartRendering

Methods

public static Byte[] ToPng(MermaidFlowchartDocument document, MermaidFlowchartRenderOptions? options = null) #
MermaidFlowchartRendering.cs:182
Returns: Byte[]

Renders a Mermaid flowchart document to static PNG through ChartForgeX topology rendering.

Parameters

document ChartForgeX.Mermaid.MermaidFlowchartDocument requiredposition: 0
The parsed Mermaid flowchart document.
options ChartForgeX.Mermaid.MermaidFlowchartRenderOptions? = null optionalposition: 1
Optional conversion and rendering defaults.

Returns

PNG bytes.

public static String ToSvg(MermaidFlowchartDocument document, MermaidFlowchartRenderOptions? options = null) #
MermaidFlowchartRendering.cs:171
Returns: String

Renders a Mermaid flowchart document to static SVG through ChartForgeX topology rendering.

Parameters

document ChartForgeX.Mermaid.MermaidFlowchartDocument requiredposition: 0
The parsed Mermaid flowchart document.
options ChartForgeX.Mermaid.MermaidFlowchartRenderOptions? = null optionalposition: 1
Optional conversion and rendering defaults.

Returns

SVG markup.

public static TopologyChart ToTopologyChart(MermaidFlowchartDocument document, MermaidFlowchartRenderOptions? options = null) #
MermaidFlowchartRendering.cs:21
Returns: TopologyChart

Converts a Mermaid flowchart document into a renderer-independent topology chart.

Parameters

document ChartForgeX.Mermaid.MermaidFlowchartDocument requiredposition: 0
The parsed Mermaid flowchart document.
options ChartForgeX.Mermaid.MermaidFlowchartRenderOptions? = null optionalposition: 1
Optional conversion and rendering defaults.

Returns

A topology chart that can render to ChartForgeX SVG, HTML, PNG, and raster outputs.

public static VisualArtifact ToVisualArtifact(MermaidFlowchartDocument document, MermaidFlowchartRenderOptions? options = null) #
MermaidFlowchartRendering.cs:144
Returns: VisualArtifact

Wraps a Mermaid flowchart document in a product-neutral visual artifact envelope backed by a topology chart.

Parameters

document ChartForgeX.Mermaid.MermaidFlowchartDocument requiredposition: 0
The parsed Mermaid flowchart document.
options ChartForgeX.Mermaid.MermaidFlowchartRenderOptions? = null optionalposition: 1
Optional conversion and rendering defaults.

Returns

A visual artifact envelope.