API Reference
Class
MermaidRenderer
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:
MermaidRenderResultProduces a reusable artifact and located diagnostics. Source with errors never produces an artifact.
Parameters
- source System.String
- options ChartForgeX.Mermaid.MermaidRenderOptions? = null
public static Byte[] ToPng(MermaidDocument document, MermaidRenderOptions? options = null) #Returns:
Byte[]Renders an already parsed document to PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidDocument
- options ChartForgeX.Mermaid.MermaidRenderOptions? = null
public static String ToSvg(MermaidDocument document, MermaidRenderOptions? options = null) #Returns:
StringRenders an already parsed document to SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidDocument
- options ChartForgeX.Mermaid.MermaidRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidDocument document, MermaidRenderOptions? options = null) #Returns:
VisualArtifactConverts an already parsed document into its typed artifact; unsupported families throw a located render error through Render.
Parameters
- document ChartForgeX.Mermaid.MermaidDocument
- options ChartForgeX.Mermaid.MermaidRenderOptions? = null
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?