API Reference
MermaidTimelineDocument
Describes a parsed Mermaid timeline document.
Inheritance
- MermaidDocument
- MermaidTimelineDocument
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.ParseTimeline
Accepted by parameters 8
- Extension method MermaidTimelineDocument.ToChart
- Extension method MermaidTimelineDocument.ToPng
- Extension method MermaidTimelineDocument.ToSvg
- Extension method MermaidTimelineDocument.ToVisualArtifact
- Method MermaidTimelineRendering.ToChart
- Method MermaidTimelineRendering.ToPng
- Method MermaidTimelineRendering.ToSvg
- Method MermaidTimelineRendering.ToVisualArtifact
Constructors
public MermaidTimelineDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets raw timeline statements retained with source spans.
public String? Title { get; set; } #Gets or sets the optional Mermaid timeline title.
public MermaidTimelineDirection Direction { get; set; } #Gets or sets the declared timeline direction.
public List<MermaidTimelineSection> Sections { get; } #Gets timeline sections in source order.
public List<MermaidTimelinePeriod> Periods { get; } #Gets timeline periods in source order.
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 Chart ToChart(MermaidTimelineDocument document, MermaidTimelineRenderOptions? options = null) #ChartConverts a Mermaid timeline document into a renderer-independent ChartForgeX timeline chart.
Parameters
- document ChartForgeX.Mermaid.MermaidTimelineDocument
- options ChartForgeX.Mermaid.MermaidTimelineRenderOptions? = null
public static Byte[] ToPng(MermaidTimelineDocument document, MermaidTimelineRenderOptions? options = null) #Byte[]Renders a Mermaid timeline document to static PNG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidTimelineDocument
- options ChartForgeX.Mermaid.MermaidTimelineRenderOptions? = null
public static String ToSvg(MermaidTimelineDocument document, MermaidTimelineRenderOptions? options = null) #StringRenders a Mermaid timeline document to static SVG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidTimelineDocument
- options ChartForgeX.Mermaid.MermaidTimelineRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidTimelineDocument document, MermaidTimelineRenderOptions? options = null) #VisualArtifactWraps a Mermaid timeline document in a visual artifact envelope backed by a ChartForgeX timeline chart.
Parameters
- document ChartForgeX.Mermaid.MermaidTimelineDocument
- options ChartForgeX.Mermaid.MermaidTimelineRenderOptions? = null