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:
integercannot 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:
50diagramMarginY
Margin to the over and under the c4 diagram, must be a positive value.
diagramMarginY
is required
Type:
integercannot 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:
10leftMargin
Margin between actors
leftMargin
is required
Type:
integercannot 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:
150width
Width of actor boxes
width
is required
Type:
integercannot 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:
150height
Height of actor boxes
height
is required
Type:
integercannot 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:
50padding
padding
is optional
Type:
numbercannot be null
defined in: Mermaid Config
padding Type
number
boxMargin
Margin around loop boxes
boxMargin
is required
Type:
integercannot 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:
10boxTextMargin
Margin around the text in loop/alt/opt boxes
boxTextMargin
is required
Type:
integercannot 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:
5noteMargin
Margin around notes
noteMargin
is required
Type:
integercannot 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:
10messageMargin
Space between messages.
messageMargin
is required
Type:
integercannot 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:
35messageAlign
Multiline message alignment
messageAlign
is required
Type:
stringcannot be null
defined in: Mermaid Config
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:
integercannot 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:
1rightAngles
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:
booleancannot be null
defined in: Mermaid Config
rightAngles Type
boolean
rightAngles Default Value
The default value is:
falsetaskFontSize
taskFontSize
is optional
Type: any of the following:
stringornumber(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:
14taskFontFamily
taskFontFamily
is optional
Type:
stringcannot 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:
numbercannot be null
defined in: Mermaid Config
taskMargin Type
number
taskMargin Default Value
The default value is:
50activationWidth
Width of activation box
activationWidth
is optional
Type:
numbercannot be null
defined in: Mermaid Config
activationWidth Type
number
activationWidth Default Value
The default value is:
10textPlacement
text placement as: tspan | fo | old only text as before
textPlacement
is optional
Type:
stringcannot 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:
booleancannot be null
defined in: Mermaid Config
disableMulticolor Type
boolean
disableMulticolor Default Value
The default value is:
false