API Reference
MermaidDocument
Describes a parsed Mermaid document.
Inheritance
- Object
- MermaidDocument
Usage
Explore 8 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 2
- Method MermaidParser.Parse
- Property MermaidRenderResult.Document
Accepted by parameters 6
- Extension method MermaidDocument.ToPng
- Extension method MermaidDocument.ToSvg
- Extension method MermaidDocument.ToVisualArtifact
- Method MermaidRenderer.ToPng
- Method MermaidRenderer.ToSvg
- Method MermaidRenderer.ToVisualArtifact
Constructors
public MermaidDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public MermaidDiagramKind Kind { get; set; } #Gets or sets the Mermaid diagram family.
public Boolean IsDiagnosticOnly { get; } #Gets whether the recognized family retains source without a semantic parser or native renderer.
public String SourceText { get; set; } #Gets or sets the full Mermaid source text.
public MermaidSourceSpan HeaderSpan { get; set; } #Gets or sets the source span for the diagram header line.
public String Header { get; set; } #Gets or sets the diagram header line.
public String? FrontMatter { get; set; } #Gets or sets optional YAML frontmatter text.
public VisualAccessibility Accessibility { get; } #Gets the text alternative declared by accTitle and accDescr statements.
public String? Theme { get; set; } #Gets or sets the theme declared in source configuration.
public List<MermaidDirective> Directives { get; } #Gets parsed Mermaid directives.
public List<MermaidRawStatement> RawStatements { get; } #Gets unclassified body statements retained for recognized families that do not have a semantic parser yet.
Extension Methods
public static Byte[] ToPng(MermaidDocument document, MermaidRenderOptions? options = null) #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) #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) #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