Project

ChartForgeX

Render deterministic charts, dashboards, topology, hierarchy, and report visuals directly from .NET.

Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

MermaidRenderer

Namespace ChartForgeX.Mermaid
Assembly ChartForgeX.Mermaid
Modifiers static

Parses Mermaid source and renders every supported family through the canonical static engine.

Inheritance

  • Object
  • MermaidRenderer

Methods

public static MermaidRenderResult Render(String source, MermaidRenderOptions? options = null) #
Returns: MermaidRenderResult

Produces a reusable artifact and located diagnostics. Source with errors never produces an artifact.

Parameters

source System.String requiredposition: 0
options ChartForgeX.Mermaid.MermaidRenderOptions? = null optionalposition: 1
public static Byte[] ToPng(MermaidDocument document, MermaidRenderOptions? options = null) #
Returns: Byte[]

Renders an already parsed document to PNG.

Parameters

document ChartForgeX.Mermaid.MermaidDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidRenderOptions? = null optionalposition: 1
public static String ToSvg(MermaidDocument document, MermaidRenderOptions? options = null) #
Returns: String

Renders an already parsed document to SVG.

Parameters

document ChartForgeX.Mermaid.MermaidDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidRenderOptions? = null optionalposition: 1
public static VisualArtifact ToVisualArtifact(MermaidDocument document, MermaidRenderOptions? options = null) #
Returns: VisualArtifact

Converts an already parsed document into its typed artifact; unsupported families throw a located render error through Render.

Parameters

document ChartForgeX.Mermaid.MermaidDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidRenderOptions? = null optionalposition: 1