API Reference
Class
MermaidStateDocument
Describes a parsed Mermaid state diagram.
Inheritance
- MermaidDocument
- MermaidStateDocument
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.ParseState
Accepted by parameters 8
- Extension method MermaidStateDocument.ToPng
- Extension method MermaidStateDocument.ToSvg
- Extension method MermaidStateDocument.ToTopologyChart
- Extension method MermaidStateDocument.ToVisualArtifact
- Method MermaidTopologyRendering.ToPng
- Method MermaidTopologyRendering.ToSvg
- Method MermaidTopologyRendering.ToTopologyChart
- Method MermaidTopologyRendering.ToVisualArtifact
Constructors
public MermaidStateDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public String? Direction { get; set; } #Gets or sets the optional diagram direction statement.
public List<MermaidStateNode> States { get; } #Gets states in source order.
public List<MermaidStateTransition> Transitions { get; } #Gets transitions in source order.
public List<MermaidStateStatement> Statements { get; } #Gets retained notes, class definitions, and other non-rendered state statements.
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(MermaidStateDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid state diagram to PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidStateDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static String ToSvg(MermaidStateDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
StringRenders a Mermaid state diagram to SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidStateDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static TopologyChart ToTopologyChart(MermaidStateDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
TopologyChartConverts a Mermaid state diagram to a topology chart.
Parameters
- document ChartForgeX.Mermaid.MermaidStateDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidStateDocument document, MermaidTopologyRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid state diagram in a visual artifact envelope.
Parameters
- document ChartForgeX.Mermaid.MermaidStateDocument
- options ChartForgeX.Mermaid.MermaidTopologyRenderOptions? = null