API Reference
MermaidSequenceDocument
Describes a Mermaid sequence diagram document.
Inheritance
- MermaidDocument
- MermaidSequenceDocument
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.ParseSequence
Accepted by parameters 8
- Extension method MermaidSequenceDocument.ToPng
- Extension method MermaidSequenceDocument.ToSequenceArtifact
- Extension method MermaidSequenceDocument.ToSvg
- Extension method MermaidSequenceDocument.ToVisualArtifact
- Method MermaidSequenceRendering.ToPng
- Method MermaidSequenceRendering.ToSequenceArtifact
- Method MermaidSequenceRendering.ToSvg
- Method MermaidSequenceRendering.ToVisualArtifact
Constructors
public MermaidSequenceDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets raw sequence statements retained with source spans.
public List<MermaidSequenceParticipant> Participants { get; } #Gets declared and inferred participants in source order.
public List<MermaidSequenceMessage> Messages { get; } #Gets parsed sequence messages.
public List<MermaidSequenceNote> Notes { get; } #Gets parsed sequence notes.
public List<MermaidSequenceActivation> Activations { get; } #Gets parsed activation and deactivation statements.
public List<MermaidSequenceBlock> Blocks { get; } #Gets parsed block control statements such as loop, alt, par, critical, rect, and end.
public List<MermaidSequenceLink> Links { get; } #Gets parsed actor menu links.
public MermaidSequenceAutonumber? Autonumber { get; set; } #Gets parsed autonumber configuration, when present.
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(MermaidSequenceDocument document, MermaidSequenceRenderOptions? options = null) #Byte[]Renders a Mermaid sequence document to static PNG through ChartForgeX sequence rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidSequenceDocument
- options ChartForgeX.Mermaid.MermaidSequenceRenderOptions? = null
public static SequenceArtifact ToSequenceArtifact(MermaidSequenceDocument document, MermaidSequenceRenderOptions? options = null) #SequenceArtifactConverts a Mermaid sequence document into a product-neutral sequence artifact.
Parameters
- document ChartForgeX.Mermaid.MermaidSequenceDocument
- The parsed Mermaid sequence document.
- options ChartForgeX.Mermaid.MermaidSequenceRenderOptions? = null
- Optional conversion and rendering defaults.
Returns
A sequence artifact that can render static SVG and PNG previews.
public static String ToSvg(MermaidSequenceDocument document, MermaidSequenceRenderOptions? options = null) #StringRenders a Mermaid sequence document to static SVG through ChartForgeX sequence rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidSequenceDocument
- options ChartForgeX.Mermaid.MermaidSequenceRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidSequenceDocument document, MermaidSequenceRenderOptions? options = null) #VisualArtifactWraps a Mermaid sequence document in a product-neutral visual artifact envelope backed by a sequence artifact.
Parameters
- document ChartForgeX.Mermaid.MermaidSequenceDocument
- The parsed Mermaid sequence document.
- options ChartForgeX.Mermaid.MermaidSequenceRenderOptions? = null
- Optional conversion and rendering defaults.
Returns
A visual artifact envelope.