Skip to content
ChartForgeX

API Reference

Class

MermaidBlockRendering

Edit on GitHub
Namespace ChartForgeX.Mermaid
Assembly ChartForgeX.Mermaid
Source MermaidBlockRendering.cs:16
Modifiers static

Provides ChartForgeX rendering adapters for parsed Mermaid block diagrams.

Inheritance

  • Object
  • MermaidBlockRendering

Methods

public static BlockLayoutBlock ToBlockLayoutBlock(MermaidBlockDocument document, MermaidBlockRenderOptions? options = null) #
MermaidBlockRendering.cs:16
Returns: BlockLayoutBlock

Converts a Mermaid block document into a reusable block-layout visual block.

Parameters

document ChartForgeX.Mermaid.MermaidBlockDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidBlockRenderOptions? = null optionalposition: 1
public static Byte[] ToPng(MermaidBlockDocument document, MermaidBlockRenderOptions? options = null) #
MermaidBlockRendering.cs:65
Returns: Byte[]

Renders a Mermaid block document to static PNG.

Parameters

document ChartForgeX.Mermaid.MermaidBlockDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidBlockRenderOptions? = null optionalposition: 1
public static String ToSvg(MermaidBlockDocument document, MermaidBlockRenderOptions? options = null) #
MermaidBlockRendering.cs:61
Returns: String

Renders a Mermaid block document to static SVG.

Parameters

document ChartForgeX.Mermaid.MermaidBlockDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidBlockRenderOptions? = null optionalposition: 1
public static VisualArtifact ToVisualArtifact(MermaidBlockDocument document, MermaidBlockRenderOptions? options = null) #
MermaidBlockRendering.cs:40
Returns: VisualArtifact

Wraps a Mermaid block document in a visual artifact envelope backed by a block-layout block.

Parameters

document ChartForgeX.Mermaid.MermaidBlockDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidBlockRenderOptions? = null optionalposition: 1