API Reference
MermaidC4Document
Describes a parsed Mermaid C4 diagram.
Inheritance
- MermaidDocument
- MermaidC4Document
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.ParseC4
Accepted by parameters 8
- Extension method MermaidC4Document.ToPng
- Extension method MermaidC4Document.ToSvg
- Extension method MermaidC4Document.ToTopologyChart
- Extension method MermaidC4Document.ToVisualArtifact
- Method MermaidC4Rendering.ToPng
- Method MermaidC4Rendering.ToSvg
- Method MermaidC4Rendering.ToTopologyChart
- Method MermaidC4Rendering.ToVisualArtifact
Constructors
public MermaidC4Document() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String DiagramType { get; set; } #Gets or sets the concrete C4 header token such as C4Context.
public String? Title { get; set; } #Gets or sets the optional Mermaid title statement.
public String? Direction { get; set; } #Gets or sets an optional Mermaid direction statement.
public List<MermaidRawStatement> Statements { get; } #Gets raw C4 statements retained with source spans.
public List<MermaidC4Boundary> Boundaries { get; } #Gets parsed C4 boundaries and deployment nodes in source order.
public List<MermaidC4Element> Elements { get; } #Gets parsed C4 elements in source order.
public List<MermaidC4Relationship> Relationships { get; } #Gets parsed C4 relationships in source order.
public List<MermaidRawStatement> RetainedStatements { get; } #Gets retained C4 statements whose semantics are not rendered exactly yet.
Inherited Properties
public MermaidDiagramKind Kind { get; set; } #public Boolean IsDiagnosticOnly { get; } #public String SourceText { get; set; } #public MermaidSourceSpan HeaderSpan { get; set; } #public String Header { get; set; } #public String? FrontMatter { get; set; } #public VisualAccessibility Accessibility { get; } #public String? Theme { get; set; } #public List<MermaidDirective> Directives { get; } #public List<MermaidRawStatement> RawStatements { get; } #Extension Methods
public static Byte[] ToPng(MermaidC4Document document, MermaidTopologyRenderOptions? options = null) #Byte[]Renders a Mermaid C4 document to static PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidC4Document
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static String ToSvg(MermaidC4Document document, MermaidTopologyRenderOptions? options = null) #StringRenders a Mermaid C4 document to static SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidC4Document
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static TopologyChart ToTopologyChart(MermaidC4Document document, MermaidTopologyRenderOptions? options = null) #TopologyChartConverts a Mermaid C4 document into a renderer-independent ChartForgeX topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidC4Document
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidC4Document document, MermaidTopologyRenderOptions? options = null) #VisualArtifactWraps a Mermaid C4 document in a visual artifact envelope backed by a ChartForgeX topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidC4Document
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null