API Reference
MermaidGanttDocument
Describes a parsed Mermaid Gantt diagram.
Inheritance
- MermaidDocument
- MermaidGanttDocument
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.ParseGantt
Accepted by parameters 8
- Extension method MermaidGanttDocument.ToChart
- Extension method MermaidGanttDocument.ToPng
- Extension method MermaidGanttDocument.ToSvg
- Extension method MermaidGanttDocument.ToVisualArtifact
- Method MermaidGanttRendering.ToChart
- Method MermaidGanttRendering.ToPng
- Method MermaidGanttRendering.ToSvg
- Method MermaidGanttRendering.ToVisualArtifact
Constructors
public MermaidGanttDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets retained non-empty Gantt statements.
public String? Title { get; set; } #Gets or sets the optional Mermaid title.
public String DateFormat { get; set; } #Gets or sets the Mermaid dateFormat directive.
public String? AxisFormat { get; set; } #Gets or sets the optional Mermaid axisFormat directive.
public String? TickInterval { get; set; } #Gets or sets the optional Mermaid tickInterval directive.
public String? Excludes { get; set; } #Gets or sets the optional Mermaid excludes directive.
public String? Includes { get; set; } #Gets or sets dates that override excluded days.
public String Weekend { get; set; } #Gets or sets the first weekend day, friday or saturday.
public String? TodayMarker { get; set; } #Gets or sets the optional Mermaid todayMarker directive.
public List<MermaidGanttSection> Sections { get; } #Gets Gantt sections in source order.
public List<MermaidGanttTask> Tasks { get; } #Gets Gantt tasks 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(MermaidGanttDocument document, MermaidGanttRenderOptions? options = null) #ChartConverts a Mermaid Gantt document into a renderer-independent ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidGanttDocument
- options ChartForgeX.Mermaid.MermaidGanttRenderOptions? = null
public static Byte[] ToPng(MermaidGanttDocument document, MermaidGanttRenderOptions? options = null) #Byte[]Renders a Mermaid Gantt document to static PNG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidGanttDocument
- options ChartForgeX.Mermaid.MermaidGanttRenderOptions? = null
public static String ToSvg(MermaidGanttDocument document, MermaidGanttRenderOptions? options = null) #StringRenders a Mermaid Gantt document to static SVG through ChartForgeX chart rendering.
Parameters
- document ChartForgeX.Mermaid.MermaidGanttDocument
- options ChartForgeX.Mermaid.MermaidGanttRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidGanttDocument document, MermaidGanttRenderOptions? options = null) #VisualArtifactWraps a Mermaid Gantt document in a visual artifact envelope backed by a ChartForgeX chart.
Parameters
- document ChartForgeX.Mermaid.MermaidGanttDocument
- options ChartForgeX.Mermaid.MermaidGanttRenderOptions? = null