API Reference
MermaidRequirementDocument
Describes a parsed Mermaid requirement diagram.
Inheritance
- MermaidDocument
- MermaidRequirementDocument
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 MermaidRequirementDocument.ToPng
- Extension method MermaidRequirementDocument.ToSvg
- Extension method MermaidRequirementDocument.ToTopologyChart
- Extension method MermaidRequirementDocument.ToVisualArtifact
- Method MermaidRequirementRendering.ToPng
- Method MermaidRequirementRendering.ToSvg
- Method MermaidRequirementRendering.ToTopologyChart
- Method MermaidRequirementRendering.ToVisualArtifact
Constructors
public MermaidRequirementDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets raw requirement statements retained with source spans.
public String? Direction { get; set; } #Gets or sets the optional Mermaid layout direction token.
public List<MermaidRequirementNode> Requirements { get; } #Gets parsed requirement nodes in source order.
public List<MermaidRequirementElement> Elements { get; } #Gets parsed external element nodes in source order.
public List<MermaidRequirementRelationship> Relationships { get; } #Gets parsed requirement relationships in source order.
public List<MermaidRawStatement> StyleStatements { get; } #Gets retained style and class statements that are not rendered exactly by the static topology preview.
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(MermaidRequirementDocument document, MermaidTopologyRenderOptions? options = null) #Byte[]Renders a Mermaid requirement document to static PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidRequirementDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static String ToSvg(MermaidRequirementDocument document, MermaidTopologyRenderOptions? options = null) #StringRenders a Mermaid requirement document to static SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidRequirementDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static TopologyChart ToTopologyChart(MermaidRequirementDocument document, MermaidTopologyRenderOptions? options = null) #TopologyChartConverts a Mermaid requirement document into a renderer-independent ChartForgeX topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidRequirementDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidRequirementDocument document, MermaidTopologyRenderOptions? options = null) #VisualArtifactWraps a Mermaid requirement document in a visual artifact envelope backed by a ChartForgeX topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidRequirementDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null