API Reference
MermaidFlowchartDocument
Describes a Mermaid flowchart or graph document.
Inheritance
- MermaidDocument
- MermaidFlowchartDocument
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.ParseFlowchart
Accepted by parameters 8
- Extension method MermaidFlowchartDocument.ToPng
- Extension method MermaidFlowchartDocument.ToSvg
- Extension method MermaidFlowchartDocument.ToTopologyChart
- Extension method MermaidFlowchartDocument.ToVisualArtifact
- Method MermaidFlowchartRendering.ToPng
- Method MermaidFlowchartRendering.ToSvg
- Method MermaidFlowchartRendering.ToTopologyChart
- Method MermaidFlowchartRendering.ToVisualArtifact
Constructors
public MermaidFlowchartDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public MermaidFlowchartDirection Direction { get; set; } #Gets or sets the declared flowchart direction.
public List<MermaidRawStatement> Statements { get; } #Gets raw flowchart statements retained with source spans.
public List<MermaidFlowchartNode> Nodes { get; } #Gets parsed flowchart node definitions and references.
public List<MermaidFlowchartEdge> Edges { get; } #Gets parsed flowchart edges.
public List<MermaidFlowchartSubgraph> Subgraphs { get; } #Gets parsed flowchart subgraphs.
public List<MermaidFlowchartClassDefinition> ClassDefinitions { get; } #Gets parsed flowchart class definitions.
public List<MermaidFlowchartLinkStyle> LinkStyles { get; } #Gets parsed flowchart link style declarations.
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(MermaidFlowchartDocument document, MermaidFlowchartRenderOptions? options = null) #Byte[]Renders a Mermaid flowchart document to static PNG through ChartForgeX topology rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidFlowchartDocument
- The parsed Mermaid flowchart document.
- options ChartForgeX.Mermaid.MermaidFlowchartRenderOptions? = null
- Optional conversion and rendering defaults.
Returns
PNG bytes.
public static String ToSvg(MermaidFlowchartDocument document, MermaidFlowchartRenderOptions? options = null) #StringRenders a Mermaid flowchart document to static SVG through ChartForgeX topology rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidFlowchartDocument
- The parsed Mermaid flowchart document.
- options ChartForgeX.Mermaid.MermaidFlowchartRenderOptions? = null
- Optional conversion and rendering defaults.
Returns
SVG markup.
public static TopologyChart ToTopologyChart(MermaidFlowchartDocument document, MermaidFlowchartRenderOptions? options = null) #TopologyChartConverts a Mermaid flowchart document into a renderer-independent topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidFlowchartDocument
- The parsed Mermaid flowchart document.
- options ChartForgeX.Mermaid.MermaidFlowchartRenderOptions? = null
- Optional conversion and rendering defaults.
Returns
A topology chart that can render to ChartForgeX SVG, HTML, PNG, and raster outputs.
public static VisualArtifact ToVisualArtifact(MermaidFlowchartDocument document, MermaidFlowchartRenderOptions? options = null) #VisualArtifactWraps a Mermaid flowchart document in a product-neutral visual artifact envelope backed by a topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidFlowchartDocument
- The parsed Mermaid flowchart document.
- options ChartForgeX.Mermaid.MermaidFlowchartRenderOptions? = null
- Optional conversion and rendering defaults.
Returns
A visual artifact envelope.