API Reference
Class
MermaidBlockDocument
Describes a parsed Mermaid block diagram.
Inheritance
- MermaidDocument
- MermaidBlockDocument
Usage
Explore 9 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 1
- Method MermaidParser.ParseBlock
Accepted by parameters 8
- Extension method MermaidBlockDocument.ToBlockLayoutBlock
- Extension method MermaidBlockDocument.ToPng
- Extension method MermaidBlockDocument.ToSvg
- Extension method MermaidBlockDocument.ToVisualArtifact
- Method MermaidBlockRendering.ToBlockLayoutBlock
- Method MermaidBlockRendering.ToPng
- Method MermaidBlockRendering.ToSvg
- Method MermaidBlockRendering.ToVisualArtifact
Constructors
public MermaidBlockDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets block statements retained in source order.
public List<MermaidBlockItem> Items { get; } #Gets parsed block items in layout order.
public List<MermaidBlockEdge> Edges { get; } #Gets parsed block edges.
public List<MermaidRawStatement> StyleStatements { get; } #Gets style and class statements retained for future rendering support.
public Int32? Columns { get; set; } #Gets or sets the optional column count.
public String? Title { get; set; } #Gets or sets the optional title statement.
Inherited Properties
public MermaidDiagramKind Kind { get; set; } #Inherited from MermaidDocument
public Boolean IsDiagnosticOnly { get; } #Inherited from MermaidDocument
public String SourceText { get; set; } #Inherited from MermaidDocument
public MermaidSourceSpan HeaderSpan { get; set; } #Inherited from MermaidDocument
public String Header { get; set; } #Inherited from MermaidDocument
public String? FrontMatter { get; set; } #Inherited from MermaidDocument
public VisualAccessibility Accessibility { get; } #Inherited from MermaidDocument
public String? Theme { get; set; } #Inherited from MermaidDocument
public List<MermaidDirective> Directives { get; } #Inherited from MermaidDocument
public List<MermaidRawStatement> RawStatements { get; } #Inherited from MermaidDocument
Extension Methods
public static BlockLayoutBlock ToBlockLayoutBlock(MermaidBlockDocument document, MermaidBlockRenderOptions? options = null) #Returns:
BlockLayoutBlockConverts a Mermaid block document into a reusable block-layout visual block.
Parameters
- document ChartForgeX.Mermaid.MermaidBlockDocument
- options ChartForgeX.Mermaid.MermaidBlockRenderOptions? = null
public static Byte[] ToPng(MermaidBlockDocument document, MermaidBlockRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid block document to static PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidBlockDocument
- options ChartForgeX.Mermaid.MermaidBlockRenderOptions? = null
public static String ToSvg(MermaidBlockDocument document, MermaidBlockRenderOptions? options = null) #Returns:
StringRenders a Mermaid block document to static SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidBlockDocument
- options ChartForgeX.Mermaid.MermaidBlockRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidBlockDocument document, MermaidBlockRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid block document in a visual artifact envelope backed by a block-layout block.
Parameters
- document ChartForgeX.Mermaid.MermaidBlockDocument
- options ChartForgeX.Mermaid.MermaidBlockRenderOptions? = null