Timeline Diagram Config Schema β
https://mermaid.js.org/schemas/config.schema.json#/$defs/TimelineDiagramConfig
Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config.schema.json* |
TimelineDiagramConfig Type β
object
(Timeline Diagram Config)
all of
TimelineDiagramConfig Properties β
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
diagramMarginX | integer | Required | cannot be null | Mermaid Config |
diagramMarginY | integer | Required | cannot be null | Mermaid Config |
leftMargin | integer | Required | cannot be null | Mermaid Config |
width | integer | Required | cannot be null | Mermaid Config |
height | integer | Required | cannot be null | Mermaid Config |
padding | number | Optional | cannot be null | Mermaid Config |
boxMargin | integer | Required | cannot be null | Mermaid Config |
boxTextMargin | integer | Required | cannot be null | Mermaid Config |
noteMargin | integer | Required | cannot be null | Mermaid Config |
messageMargin | integer | Required | cannot be null | Mermaid Config |
messageAlign | string | Required | cannot be null | Mermaid Config |
bottomMarginAdj | integer | Required | cannot be null | Mermaid Config |
rightAngles | boolean | Optional | cannot be null | Mermaid Config |
taskFontSize | Multiple | Optional | cannot be null | Mermaid Config |
taskFontFamily | string | Optional | cannot be null | Mermaid Config |
taskMargin | number | Optional | cannot be null | Mermaid Config |
activationWidth | number | Optional | cannot be null | Mermaid Config |
textPlacement | string | Optional | cannot be null | Mermaid Config |
actorColours | array | Optional | cannot be null | Mermaid Config |
sectionFills | array | Optional | cannot be null | Mermaid Config |
sectionColours | array | Optional | cannot be null | Mermaid Config |
disableMulticolor | boolean | Optional | cannot be null | Mermaid Config |
diagramMarginX β
Margin to the right and left of the c4 diagram, must be a positive value.
diagramMarginX
is required
Type:
integer
cannot be null
defined in: Mermaid Config
diagramMarginX Type β
integer
diagramMarginX Constraints β
minimum: the value of this number must greater than or equal to: 0
diagramMarginX Default Value β
The default value is:
50
diagramMarginY β
Margin to the over and under the c4 diagram, must be a positive value.
diagramMarginY
is required
Type:
integer
cannot be null
defined in: Mermaid Config
diagramMarginY Type β
integer
diagramMarginY Constraints β
minimum: the value of this number must greater than or equal to: 0
diagramMarginY Default Value β
The default value is:
10
leftMargin β
Margin between actors
leftMargin
is required
Type:
integer
cannot be null
defined in: Mermaid Config
leftMargin Type β
integer
leftMargin Constraints β
minimum: the value of this number must greater than or equal to: 0
leftMargin Default Value β
The default value is:
150
width β
Width of actor boxes
width
is required
Type:
integer
cannot be null
defined in: Mermaid Config
width Type β
integer
width Constraints β
minimum: the value of this number must greater than or equal to: 0
width Default Value β
The default value is:
150
height β
Height of actor boxes
height
is required
Type:
integer
cannot be null
defined in: Mermaid Config
height Type β
integer
height Constraints β
minimum: the value of this number must greater than or equal to: 0
height Default Value β
The default value is:
50
padding β
padding
is optional
Type:
number
cannot be null
defined in: Mermaid Config
padding Type β
number
boxMargin β
Margin around loop boxes
boxMargin
is required
Type:
integer
cannot be null
defined in: Mermaid Config
boxMargin Type β
integer
boxMargin Constraints β
minimum: the value of this number must greater than or equal to: 0
boxMargin Default Value β
The default value is:
10
boxTextMargin β
Margin around the text in loop/alt/opt boxes
boxTextMargin
is required
Type:
integer
cannot be null
defined in: Mermaid Config
boxTextMargin Type β
integer
boxTextMargin Constraints β
minimum: the value of this number must greater than or equal to: 0
boxTextMargin Default Value β
The default value is:
5
noteMargin β
Margin around notes
noteMargin
is required
Type:
integer
cannot be null
defined in: Mermaid Config
noteMargin Type β
integer
noteMargin Constraints β
minimum: the value of this number must greater than or equal to: 0
noteMargin Default Value β
The default value is:
10
messageMargin β
Space between messages.
messageMargin
is required
Type:
integer
cannot be null
defined in: Mermaid Config
messageMargin Type β
integer
messageMargin Constraints β
minimum: the value of this number must greater than or equal to: 0
messageMargin Default Value β
The default value is:
35
messageAlign β
Multiline message alignment
messageAlign
is required
Type:
string
cannot be null
defined in: Mermaid Config
tsType:
string | "left" | "center" | "right"
messageAlign Type β
string
messageAlign Constraints β
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"left" | |
"center" | |
"right" |
messageAlign Default Value β
The default value is:
"center"
bottomMarginAdj β
Prolongs the edge of the diagram downwards.
Depending on css styling this might need adjustment.
bottomMarginAdj
is required
Type:
integer
cannot be null
defined in: Mermaid Config
bottomMarginAdj Type β
integer
bottomMarginAdj Constraints β
minimum: the value of this number must greater than or equal to: 0
bottomMarginAdj Default Value β
The default value is:
1
rightAngles β
Curved Arrows become Right Angles
This will display arrows that start and begin at the same node as right angles, rather than as curves.
rightAngles
is optional
Type:
boolean
cannot be null
defined in: Mermaid Config
rightAngles Type β
boolean
taskFontSize β
taskFontSize
is optional
Type: any of the following:
string
ornumber
(Details)cannot be null
defined in: Mermaid Config
taskFontSize Type β
any of the following: string
or number
(Details)
taskFontSize Default Value β
The default value is:
14
taskFontFamily β
taskFontFamily
is optional
Type:
string
cannot be null
defined in: Mermaid Config
taskFontFamily Type β
string
taskFontFamily Default Value β
The default value is:
"\"Open Sans\", sans-serif"
taskMargin β
taskMargin
is optional
Type:
number
cannot be null
defined in: Mermaid Config
taskMargin Type β
number
taskMargin Default Value β
The default value is:
50
activationWidth β
Width of activation box
activationWidth
is optional
Type:
number
cannot be null
defined in: Mermaid Config
activationWidth Type β
number
activationWidth Default Value β
The default value is:
10
textPlacement β
text placement as: tspan | fo | old only text as before
textPlacement
is optional
Type:
string
cannot be null
defined in: Mermaid Config
textPlacement Type β
string
textPlacement Default Value β
The default value is:
"fo"
actorColours β
actorColours
is optional
Type:
string[]
cannot be null
defined in: Mermaid Config
actorColours Type β
string[]
actorColours Default Value β
The default value is:
["#8FBC8F", "#7CFC00", "#00FFFF", "#20B2AA", "#B0E0E6", "#FFFFE0"]
sectionFills β
sectionFills
is optional
Type:
string[]
cannot be null
defined in: Mermaid Config
sectionFills Type β
string[]
sectionFills Default Value β
The default value is:
["#191970", "#8B008B", "#4B0082", "#2F4F4F", "#800000", "#8B4513", "#00008B"]
sectionColours β
sectionColours
is optional
Type:
string[]
cannot be null
defined in: Mermaid Config
sectionColours Type β
string[]
sectionColours Default Value β
The default value is:
["#fff"]
disableMulticolor β
disableMulticolor
is optional
Type:
boolean
cannot be null
defined in: Mermaid Config
disableMulticolor Type β
boolean