API Reference
Class
MermaidClassDocument
Describes a parsed Mermaid class diagram.
Inheritance
- MermaidDocument
- MermaidClassDocument
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.ParseClass
Accepted by parameters 8
- Extension method MermaidClassDocument.ToPng
- Extension method MermaidClassDocument.ToSvg
- Extension method MermaidClassDocument.ToTopologyChart
- Extension method MermaidClassDocument.ToVisualArtifact
- Method MermaidTopologyRendering.ToPng
- Method MermaidTopologyRendering.ToSvg
- Method MermaidTopologyRendering.ToTopologyChart
- Method MermaidTopologyRendering.ToVisualArtifact
Constructors
public MermaidClassDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public List<MermaidClassNode> Classes { get; } #Gets classes in source order.
public List<MermaidClassRelationship> Relationships { get; } #Gets class relationships in source order.
public List<MermaidClassStyleStatement> StyleStatements { get; } #Gets class definition statements retained from source.
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(MermaidClassDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid class diagram to PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidClassDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static String ToSvg(MermaidClassDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
StringRenders a Mermaid class diagram to SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidClassDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static TopologyChart ToTopologyChart(MermaidClassDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
TopologyChartConverts a Mermaid class diagram to a topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidClassDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidClassDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid class diagram in a visual artifact envelope.
Parameters
- document ChartForgeX.Mermaid.MermaidClassDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null