API Reference
Class
MermaidVisualMarkupParser
Parses Markdown visual fences with built-in ChartForgeX support plus Mermaid artifact support.
Inheritance
- Object
- MermaidVisualMarkupParser
Constructors
MermaidVisualMarkupParser 2 overloads
public MermaidVisualMarkupParser() #Initializes a parser with default Mermaid flowchart rendering options.
public MermaidVisualMarkupParser(MermaidRenderOptions renderOptions) #Initializes a parser with Mermaid rendering options.
Parameters
- renderOptions ChartForgeX.Mermaid.MermaidRenderOptions
- Optional rendering defaults by Mermaid diagram kind.
Methods
Parse 2 overloads
public VisualMarkupParseResult Parse(String text) #Returns:
VisualMarkupParseResultParses Markdown visual fences into ChartForgeX visual artifacts, including Mermaid flowchart fences.
Parameters
- text System.String
- Markdown text.
Returns
The visual markup parse result.
public VisualMarkupParseResult Parse(VisualMarkupScanResult scan) #Returns:
VisualMarkupParseResultParses a visual scan result into ChartForgeX visual artifacts, including Mermaid, while preserving scanner diagnostics.
Parameters
- scan ChartForgeX.Markup.VisualMarkupScanResult
- A scan result produced by ChartForgeX or a host-discovered fence projection.
Returns
The visual markup parse result.
public VisualMarkupParseResult ParseBlocks(IEnumerable<VisualMarkupBlock> blocks) #Returns:
VisualMarkupParseResultParses visual blocks that were already discovered by another Markdown parser into ChartForgeX visual artifacts.
Parameters
- blocks System.Collections.Generic.IEnumerable<ChartForgeX.Markup.VisualMarkupBlock>
- Pre-scanned visual blocks, for example blocks discovered by a host Markdown pipeline.
Returns
The visual markup parse result.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?