Skip to content
ChartForgeX

API Reference

Class

MermaidGitGraphCommit

Edit on GitHub
Namespace ChartForgeX.Mermaid
Assembly ChartForgeX.Mermaid
Source MermaidGitGraphDocument.cs:59
Modifiers sealed

Describes one Mermaid git graph commit.

Inheritance

  • Object
  • MermaidGitGraphCommit

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 MermaidGitGraphCommit(String id, String branchName, IEnumerable<String>? parentIds, GitGraphCommitType type, String label, String tag, String sourceCommitId, MermaidSourceSpan span) #
MermaidGitGraphDocument.cs:59

Initializes a Mermaid git graph commit.

Parameters

id System.String requiredposition: 0
branchName System.String requiredposition: 1
parentIds System.Collections.Generic.IEnumerable<System.String>? requiredposition: 2
type ChartForgeX.VisualBlocks.GitGraphCommitType requiredposition: 3
label System.String requiredposition: 4
tag System.String requiredposition: 5
sourceCommitId System.String requiredposition: 6
span ChartForgeX.Mermaid.MermaidSourceSpan requiredposition: 7

Properties

public String Id { get; set; } #
MermaidGitGraphDocument.cs:74

Gets or sets the commit id.

public String BranchName { get; set; } #
MermaidGitGraphDocument.cs:77

Gets or sets the branch name.

public IReadOnlyList<String> ParentIds { get; } #
MermaidGitGraphDocument.cs:80

Gets parent commit ids.

public GitGraphCommitType Type { get; } #
MermaidGitGraphDocument.cs:83

Gets the commit type.

public String Label { get; set; } #
MermaidGitGraphDocument.cs:86

Gets or sets the display label.

public String Tag { get; set; } #
MermaidGitGraphDocument.cs:89

Gets or sets the optional tag label.

public String SourceCommitId { get; set; } #
MermaidGitGraphDocument.cs:92

Gets or sets the cherry-pick source commit id.

public MermaidSourceSpan Span { get; } #
MermaidGitGraphDocument.cs:95

Gets the source span for the commit statement.