Type Definitions
BranchCommitOptions
Branch commit options
Type:
- object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
color |
string |
<optional> |
Master color (dot & message) |
|
author |
string |
<optional> |
this.parent.author | Author name & email |
date |
string |
<optional> |
Date of commit, default is now |
|
detail |
HTMLElement |
<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> |
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 |
dotFont |
string |
<optional> |
this.template.commit.dot.font | Font of the dot |
dotColor |
string |
<optional> |
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 | |
message |
string |
<optional> |
"He doesn't like George Michael! Boooo!" | Commit message |
messageColor |
string |
<optional> |
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> |
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:
CommitCallback(commit, mouseOver, event)
A callback for each commit
Parameters:
Name | Type | Description |
---|---|---|
commit |
Commit | A commit |
mouseOver |
boolean | True, if the mouse is currently hovering over the commit |
event |
Event | The DOM event (e.g. a click event) |
- Source:
CommitFormatter(commit)
A formatter for commit
Parameters:
Name | Type | Description |
---|---|---|
commit |
Commit | The commit to format |
- Source: