Meziantou.FrameworkTimelineDiagram Class
A timeline: periods in order, each with its events, grouped in sections of the same color (Mermaid timeline).
public sealed class TimelineDiagram : Diagram- Inheritance
DiagramTimelineDiagram
Constructors
| Name | Description |
|---|---|
| TimelineDiagram() |
TimelineDiagram()
TimelineDiagram.cspublic TimelineDiagram()No documentation is available.
Properties
| Name | Description |
|---|---|
| Direction | Gets or sets the direction of the time axis. |
| DisableMulticolor | Gets or sets a value that indicates whether the periods that are in no section have the same color. By default, each one has the next color of the palette of the theme (Mermaid disableMulticolor). |
| Periods | Gets the periods that are in no section, drawn first. |
| Sections | Gets the sections. |
Direction
TimelineDiagram.csGets or sets the direction of the time axis.
public TimelineDirection Direction { get; set; }Property value
DisableMulticolor
TimelineDiagram.csPeriods
TimelineDiagram.csGets the periods that are in no section, drawn first.
public IList<TimelinePeriod> Periods { get; }Property value
Sections
TimelineDiagram.csMethods
| Name | Description |
|---|---|
| AddPeriod(DiagramText, IEnumerable<DiagramText>) | Adds a period that is in no section. |
| AddSection(DiagramText) | Adds a section. |
AddPeriod(DiagramText, IEnumerable<DiagramText>)
TimelineDiagram.csAdds a period that is in no section.
public TimelinePeriod AddPeriod(DiagramText label, params IEnumerable<DiagramText> events)Parameters
labelDiagramText- The text of the period, such as a year.
eventsIEnumerable<DiagramText>- The events.
Returns
TimelinePeriod The period.
AddSection(DiagramText)
TimelineDiagram.csAdds a section.
public TimelineSection AddSection(DiagramText title)