API Reference
Class
MermaidGitGraphDocument
Describes a parsed Mermaid git graph diagram.
Inheritance
- MermaidDocument
- MermaidGitGraphDocument
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.ParseGitGraph
Accepted by parameters 8
- Extension method MermaidGitGraphDocument.ToGitGraphBlock
- Extension method MermaidGitGraphDocument.ToPng
- Extension method MermaidGitGraphDocument.ToSvg
- Extension method MermaidGitGraphDocument.ToVisualArtifact
- Method MermaidGitGraphRendering.ToGitGraphBlock
- Method MermaidGitGraphRendering.ToPng
- Method MermaidGitGraphRendering.ToSvg
- Method MermaidGitGraphRendering.ToVisualArtifact
Constructors
public MermaidGitGraphDocument() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public List<MermaidRawStatement> Statements { get; } #Gets git graph statements retained in source order.
public List<MermaidGitGraphBranch> Branches { get; } #Gets parsed git graph branches.
public List<MermaidGitGraphCommit> Commits { get; } #Gets parsed git graph commits.
public List<MermaidRawStatement> RetainedStatements { get; } #Gets configuration, theme, or unsupported statements retained for future support.
public String Direction { get; set; } #Gets or sets the diagram orientation token from the header.
Inherited Properties
public MermaidDiagramKind Kind { get; set; } #Inherited from MermaidDocument
public Boolean IsDiagnosticOnly { get; } #Inherited from MermaidDocument
public String SourceText { get; set; } #Inherited from MermaidDocument
public MermaidSourceSpan HeaderSpan { get; set; } #Inherited from MermaidDocument
public String Header { get; set; } #Inherited from MermaidDocument
public String? FrontMatter { get; set; } #Inherited from MermaidDocument
public VisualAccessibility Accessibility { get; } #Inherited from MermaidDocument
public String? Theme { get; set; } #Inherited from MermaidDocument
public List<MermaidDirective> Directives { get; } #Inherited from MermaidDocument
public List<MermaidRawStatement> RawStatements { get; } #Inherited from MermaidDocument
Extension Methods
public static GitGraphBlock ToGitGraphBlock(MermaidGitGraphDocument document, MermaidGitGraphRenderOptions? options = null) #Returns:
GitGraphBlockConverts a Mermaid git graph document into a reusable git graph visual block.
Parameters
- document ChartForgeX.Mermaid.MermaidGitGraphDocument
- options ChartForgeX.Mermaid.MermaidGitGraphRenderOptions? = null
public static Byte[] ToPng(MermaidGitGraphDocument document, MermaidGitGraphRenderOptions? options = null) #Returns:
Byte[]Renders a Mermaid git graph document to static PNG.
Parameters
- document ChartForgeX.Mermaid.MermaidGitGraphDocument
- options ChartForgeX.Mermaid.MermaidGitGraphRenderOptions? = null
public static String ToSvg(MermaidGitGraphDocument document, MermaidGitGraphRenderOptions? options = null) #Returns:
StringRenders a Mermaid git graph document to static SVG.
Parameters
- document ChartForgeX.Mermaid.MermaidGitGraphDocument
- options ChartForgeX.Mermaid.MermaidGitGraphRenderOptions? = null
public static VisualArtifact ToVisualArtifact(MermaidGitGraphDocument document, MermaidGitGraphRenderOptions? options = null) #Returns:
VisualArtifactWraps a Mermaid git graph document in a visual artifact envelope backed by a git graph block.
Parameters
- document ChartForgeX.Mermaid.MermaidGitGraphDocument
- options ChartForgeX.Mermaid.MermaidGitGraphRenderOptions? = null