API Reference
Class
MermaidJourneyDocument
Describes a parsed Mermaid user journey diagram.
Inheritance
- MermaidDocument
- MermaidJourneyDocument
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.ParseJourney
Accepted by parameters 8
- Extension method MermaidJourneyDocument.ToChart
- Extension method MermaidJourneyDocument.ToPng
- Extension method MermaidJourneyDocument.ToSvg
- Extension method MermaidJourneyDocument.ToVisualArtifact
- Method MermaidJourneyRendering.ToChart
- Method MermaidJourneyRendering.ToPng
- Method MermaidJourneyRendering.ToSvg
- Method MermaidJourneyRendering.ToVisualArtifact
Constructors
public MermaidJourneyDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets raw journey statements retained with source spans.
public String? Title { get; set; } #Gets or sets the optional Mermaid journey title.
public List<MermaidJourneySection> Sections { get; } #Gets journey sections in source order.
public List<MermaidJourneyTask> Tasks { get; } #Gets journey tasks in source order.
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 Chart ToChart(MermaidJourneyDocument document, MermaidJourneyRenderOptions? options = null) #Returns:
ChartConverts a Mermaid journey document into a renderer-independent ChartForgeX score chart.
Parameters
- document ChartForgeX.Mermaid.MermaidJourneyDocument
- options ChartForgeX.Mermaid.MermaidJourneyRenderOptions? = null
public static Byte[] ToPng(MermaidJourneyDocument document, MermaidJourneyRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid journey document to static PNG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidJourneyDocument
- options ChartForgeX.Mermaid.MermaidJourneyRenderOptions? = null
public static String ToSvg(MermaidJourneyDocument document, MermaidJourneyRenderOptions? options = null) #Returns:
StringRenders a Mermaid journey document to static SVG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidJourneyDocument
- options ChartForgeX.Mermaid.MermaidJourneyRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidJourneyDocument document, MermaidJourneyRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid journey document in a visual artifact envelope backed by a ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidJourneyDocument
- options ChartForgeX.Mermaid.MermaidJourneyRenderOptions? = null