Skip to content
ChartForgeX

API Reference

Class

MermaidGanttTask

Namespace ChartForgeX.Mermaid
Assembly ChartForgeX.Mermaid
Modifiers sealed

Describes one Mermaid Gantt task or milestone.

Inheritance

Usage

Explore 1 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

Constructors

public MermaidGanttTask(String title, String? id, String? section, DateTime start, DateTime end, Double progress, Boolean milestone, IReadOnlyList<String> tags, IReadOnlyList<String> dependencies, String rawMetadata, MermaidSourceSpan span) #

Initializes a Gantt task.

Parameters

title System.String requiredposition: 0
id System.String? requiredposition: 1
section System.String? requiredposition: 2
start System.DateTime requiredposition: 3
end System.DateTime requiredposition: 4
progress System.Double requiredposition: 5
milestone System.Boolean requiredposition: 6
tags System.Collections.Generic.IReadOnlyList<System.String> requiredposition: 7
dependencies System.Collections.Generic.IReadOnlyList<System.String> requiredposition: 8
rawMetadata System.String requiredposition: 9
span ChartForgeX.Mermaid.MermaidSourceSpan requiredposition: 10

Properties

public String Title { get; } #

Gets the display title.

public String? Id { get; } #

Gets the optional task id.

public String? Section { get; } #

Gets the optional section name.

public DateTime Start { get; } #

Gets the authored/resolved task start date/time, including a milestone's range start.

public DateTime End { get; } #

Gets the scheduling end used by dependencies, including a milestone's range end and excluded dates.

public DateTime RenderEnd { get; internal set; } #

Gets the visible bar endpoint before trailing excluded days; milestone rendering uses the scheduling range midpoint.

public Double Progress { get; } #

Gets the rendered progress value from zero to one.

public Boolean IsMilestone { get; } #

Gets whether the task is a milestone.

public Boolean IsVerticalMarker { get; } #

Gets whether this source task paints a vertical guide instead of reserving a task row.

public List<String> Tags { get; } #

Gets Mermaid tags such as active, done, crit, milestone, and vert.

public List<String> DependencyIds { get; } #

Gets referenced dependency ids from after clauses.

public List<String> UntilTaskIds { get; } #

Gets referenced task ids from until end clauses.

public Int32 DependencyIndex { get; internal set; } #

Gets the resolved zero-based dependency index, or -1 when none is rendered.

public String RawMetadata { get; } #

Gets raw Mermaid metadata after the task colon.