Skip to content
ChartForgeX

API Reference

Class

MermaidRequirementRendering

Namespace ChartForgeX.Mermaid
Assembly ChartForgeX.Mermaid
Modifiers static

Provides ChartForgeX rendering adapters for parsed Mermaid requirement diagrams.

Inheritance

  • Object
  • MermaidRequirementRendering

Methods

public static Byte[] ToPng(MermaidRequirementDocument document, MermaidTopologyRenderOptions? options = null) #
Returns: Byte[]

Renders a Mermaid requirement document to static PNG.

Parameters

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

Renders a Mermaid requirement document to static SVG.

Parameters

document ChartForgeX.Mermaid.MermaidRequirementDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null optionalposition: 1
public static TopologyChart ToTopologyChart(MermaidRequirementDocument document, MermaidTopologyRenderOptions? options = null) #
Returns: TopologyChart

Converts a Mermaid requirement document into a renderer-independent ChartForgeX topology chart.

Parameters

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

Wraps a Mermaid requirement document in a visual artifact envelope backed by a ChartForgeX topology chart.

Parameters

document ChartForgeX.Mermaid.MermaidRequirementDocument requiredposition: 0
options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null optionalposition: 1