Class
TimelineDiagramBlock
ChartForgeX.VisualBlocks
An ordered categorical timeline. Period labels need not be dates or quantities.
Inheritance
- VisualBlock<TimelineDiagramBlock>
- TimelineDiagramBlock
Usage
Explore 16 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 16
- Extension method MermaidTimelineDocument.ToTimelineDiagramBlock
- Method MermaidTimelineRendering.ToTimelineDiagramBlock
- Method TimelineDiagramBlock.AddPeriod
- Method TimelineDiagramBlock.AddSection
- Method TimelineDiagramBlock.ConfigureTheme
- Method TimelineDiagramBlock.Create
- Method TimelineDiagramBlock.WithCard
- Method TimelineDiagramBlock.WithHostFrame
- Method TimelineDiagramBlock.WithPadding
- Method TimelineDiagramBlock.WithPngOutputScale
- Method TimelineDiagramBlock.WithSize
- Method TimelineDiagramBlock.WithSubtitle
- Method TimelineDiagramBlock.WithTheme
- Method TimelineDiagramBlock.WithThemeMode
- Method TimelineDiagramBlock.WithTitle
- Method TimelineDiagramBlock.WithTransparentBackground
Constructors
Methods
public TimelineDiagramBlock AddPeriod(string id, string label, IEnumerable<string> events, string? sectionId = null) #Adds a period and its ordered events, without inventing a numeric duration.
Parameters
- id string
- label string
- events System.Collections.Generic.IEnumerable<string>
- sectionId string? = null
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock AddSection(string id, string label) #Adds a phase with a stable identity independent of its display label.
Parameters
- id string
- label string
Returns
TimelineDiagramBlockpublic static TimelineDiagramBlock Create() #Creates an empty categorical timeline.
Returns
TimelineDiagramBlockInherited Methods
public TimelineDiagramBlock ConfigureTheme(Action<VisualThemeBuilder> configure) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<VisualThemeBuilder>
Returns
TimelineDiagramBlockpublic virtual RgbaImage RenderRgba() #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Returns
RgbaImagepublic virtual string RenderSvg(string idScope) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- idScope string
Returns
stringpublic TimelineDiagramBlock WithCard(bool enabled = true) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled bool = true
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock WithHostFrame(bool hostOwnsFrame = true) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- hostOwnsFrame bool = true
Returns
TimelineDiagramBlockWithPadding 2 overloads
public TimelineDiagramBlock WithPadding(double padding) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- padding double
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock WithPadding(double left, double top, double right, double bottom) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- left double
- top double
- right double
- bottom double
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock WithPngOutputScale(int scale) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale int
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock WithSize(int width, int height) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- width int
- height int
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock WithSubtitle(string subtitle) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- subtitle string
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock WithTheme(VisualTheme theme, VisualThemeMode? mode = null) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- theme VisualTheme
- mode VisualThemeMode? = null
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock WithThemeMode(VisualThemeMode mode) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- mode VisualThemeMode
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock WithTitle(string title) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- title string
Returns
TimelineDiagramBlockpublic TimelineDiagramBlock WithTransparentBackground(bool enabled = true) #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled bool = true
Returns
TimelineDiagramBlockProperties
public override string AccessibleName { get; } #Gets a concise accessible diagram name.
public IReadOnlyList<TimelineSection> Sections { get; } #Gets sections in authored order.
public IReadOnlyList<TimelinePeriod> Periods { get; } #Gets periods and their ordered events.
public TimelineDiagramDirection Direction { get; set; } #Gets or sets the reading direction.
Inherited Properties
public string Title { get; set; } #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
public string Subtitle { get; set; } #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]
public VisualBlockOptions Options { get; } #Inherited from VisualBlock<TSelf>[[TimelineDiagramBlock, ChartForgeX, Version=0, Culture=neutral, PublicKeyToken=null]]