API Reference
Class
GitGraphBlock
A deterministic visual block for product-neutral commit and branch graphs.
Inheritance
- VisualBlock<GitGraphBlock>
- GitGraphBlock
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 MermaidGitGraphDocument.ToGitGraphBlock
- Method MermaidGitGraphRendering.ToGitGraphBlock
- Method GitGraphBlock.AddBranch
- Method GitGraphBlock.AddCommit
- Method GitGraphBlock.Create
- Method GitGraphBlock.WithBranchLabels
- Method GitGraphBlock.WithCard
- Method GitGraphBlock.WithCommitLabels
- Method GitGraphBlock.WithHostFrame
- Method GitGraphBlock.WithPadding
- Method GitGraphBlock.WithPngOutputScale
- Method GitGraphBlock.WithSize
- Method GitGraphBlock.WithSubtitle
- Method GitGraphBlock.WithTheme
- Method GitGraphBlock.WithTitle
- Method GitGraphBlock.WithTransparentBackground
Constructors
public GitGraphBlock() #Methods
public GitGraphBlock AddBranch(String name, Int32? order = null) #Returns:
GitGraphBlockAdds a branch lane.
Parameters
- name System.String
- order System.Int32? = null
public GitGraphBlock AddCommit(String id, String branchName, IEnumerable<String>? parentIds = null, GitGraphCommitType type = Normal, String label = "", String tag = "", String sourceCommitId = "") #Returns:
GitGraphBlockAdds a commit on a branch.
Parameters
- id System.String
- branchName System.String
- parentIds System.Collections.Generic.IEnumerable<System.String>? = null
- type ChartForgeX.VisualBlocks.GitGraphCommitType = Normal
- label System.String = ""
- tag System.String = ""
- sourceCommitId System.String = ""
public GitGraphBlock WithBranchLabels(Boolean visible = true) #Returns:
GitGraphBlockSets whether branch labels are rendered.
Parameters
- visible System.Boolean = true
public GitGraphBlock WithCommitLabels(Boolean visible = true) #Returns:
GitGraphBlockSets whether commit labels are rendered.
Parameters
- visible System.Boolean = true
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
public virtual RgbaImage RenderRgba() #Returns:
RgbaImageInherited from 0, Culture=neutral, PublicKeyToken=null]]
public virtual String RenderSvg(String idScope) #Returns:
StringInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- idScope String
public GitGraphBlock WithCard(Boolean enabled = true) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled Boolean = true
public GitGraphBlock WithHostFrame(Boolean hostOwnsFrame = true) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- hostOwnsFrame Boolean = true
WithPadding 2 overloads
public GitGraphBlock WithPadding(Double padding) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- padding Double
public GitGraphBlock WithPadding(Double left, Double top, Double right, Double bottom) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- left Double
- top Double
- right Double
- bottom Double
public GitGraphBlock WithPngOutputScale(Int32 scale) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Int32
public GitGraphBlock WithSize(Int32 width, Int32 height) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- width Int32
- height Int32
public GitGraphBlock WithSubtitle(String subtitle) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- subtitle String
public GitGraphBlock WithTheme(ChartTheme theme) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- theme ChartTheme
public GitGraphBlock WithTitle(String title) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- title String
public GitGraphBlock WithTransparentBackground(Boolean enabled = true) #Returns:
GitGraphBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled Boolean = true
Properties
public IReadOnlyList<GitGraphBranch> Branches { get; } #Gets branches in declaration order.
public IReadOnlyList<GitGraphCommit> Commits { get; } #Gets commits in source order.
public Boolean ShowBranchLabels { get; set; } #Gets or sets whether branch labels and lane lines are rendered.
public Boolean ShowCommitLabels { get; set; } #Gets or sets whether commit labels are rendered.
public override String AccessibleName { get; } #Gets a concise accessibility label.