Class: Commit

Commit(options)

new Commit(options)

Commit

This:
Parameters:
Name Type Description
options object

Commit options

Properties
Name Type Attributes Default Description
parent GitGraph

GitGraph constructor

x number

Position X (dot)

y number

Position Y (dot)

color string

Master color (dot & message)

arrowDisplay boolean

Add a arrow under commit dot

author string <optional>
this.parent.author

Author name & email

date string <optional>

Date of commit, default is now

detail string <optional>

DOM Element of detail part

sha1 string <optional>

Sha1, default is a random short sha1

parentCommit Commit <optional>

Parent commit

type string <optional>
("mergeCommit"|null)

Type of commit

tag string <optional>

Tag of the commit

tagColor string <optional>
options.color

Color of the tag

tagFont string <optional>
this.template.commit.tag.font

Font of the tag

displayTagBox string <optional>
true

If true, display a box around the tag

dotColor string <optional>
options.color

Specific dot color

dotSize number <optional>
this.template.commit.dot.size

Dot size

dotStrokeWidth number <optional>
this.template.commit.dot.strokeWidth

Dot stroke width

dotStrokeColor string <optional>
this.template.commit.dot.strokeColor
lineDash Array.<number> <optional>
this.template.commit.dot.lineDash
message string <optional>
"He doesn't like George Michael! Boooo!"

Commit message

commitDotText string <optional>

short commit message (A few chars) to appear on the commit dot

messageColor string <optional>
options.color

Specific message color

messageFont string <optional>
this.template.commit.message.font

Font of the message

messageDisplay boolean <optional>
this.template.commit.message.display

Commit message display policy

messageAuthorDisplay boolean <optional>
this.template.commit.message.displayAuthor

Commit message author policy

messageBranchDisplay boolean <optional>
this.template.commit.message.displayBranch

Commit message author policy

messageHashDisplay boolean <optional>
this.template.commit.message.displayHash

Commit message hash policy

labelColor string <optional>
options.color

Specific label color

labelFont string <optional>
this.template.branch.labelFont

Font used for labels

tooltipDisplay boolean <optional>
true

Tooltip message display policy

onClick CommitCallback <optional>

OnClick event for the commit dot

representedObject object <optional>

Any object which is related to this commit. Can be used in onClick or the formatter. Useful to bind the commit to external objects such as database id etc.

Source:

Methods

arrow()

Render a arrow before commit

This:
Source:

render()

Render the commit

This:
Source: