API Reference
Class
MermaidArchitectureDocument
Describes a parsed Mermaid architecture diagram.
Inheritance
- MermaidDocument
- MermaidArchitectureDocument
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
Accepted by parameters 8
- Extension method MermaidArchitectureDocument.ToPng
- Extension method MermaidArchitectureDocument.ToSvg
- Extension method MermaidArchitectureDocument.ToTopologyChart
- Extension method MermaidArchitectureDocument.ToVisualArtifact
- Method MermaidArchitectureRendering.ToPng
- Method MermaidArchitectureRendering.ToSvg
- Method MermaidArchitectureRendering.ToTopologyChart
- Method MermaidArchitectureRendering.ToVisualArtifact
Constructors
public MermaidArchitectureDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets raw architecture statements retained with source spans.
public List<MermaidArchitectureGroup> Groups { get; } #Gets parsed architecture groups in source order.
public List<MermaidArchitectureService> Services { get; } #Gets parsed architecture services in source order.
public List<MermaidArchitectureJunction> Junctions { get; } #Gets parsed architecture junctions in source order.
public List<MermaidArchitectureEdge> Edges { get; } #Gets parsed architecture edges in source order.
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 Byte[] ToPng(MermaidArchitectureDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid architecture document to static PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidArchitectureDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static String ToSvg(MermaidArchitectureDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
StringRenders a Mermaid architecture document to static SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidArchitectureDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static TopologyChart ToTopologyChart(MermaidArchitectureDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
TopologyChartConverts a Mermaid architecture document into a renderer-independent ChartForgeX topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidArchitectureDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidArchitectureDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid architecture document in a visual artifact envelope backed by a ChartForgeX topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidArchitectureDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null