Gantt Diagram Config Schema
https://mermaid.js.org/schemas/config.schema.json#/$defs/GanttDiagramConfigThe object containing configurations specific for gantt diagrams
| 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* |
GanttDiagramConfig Type
object (Gantt Diagram Config)
all of
GanttDiagramConfig Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| titleTopMargin | integer | Required | cannot be null | Mermaid Config |
| barHeight | integer | Required | cannot be null | Mermaid Config |
| barGap | integer | Optional | cannot be null | Mermaid Config |
| topPadding | integer | Required | cannot be null | Mermaid Config |
| rightPadding | integer | Required | cannot be null | Mermaid Config |
| leftPadding | integer | Required | cannot be null | Mermaid Config |
| gridLineStartPadding | integer | Required | cannot be null | Mermaid Config |
| fontSize | integer | Required | cannot be null | Mermaid Config |
| sectionFontSize | integer | Required | cannot be null | Mermaid Config |
| numberSectionStyles | integer | Required | cannot be null | Mermaid Config |
| axisFormat | string | Required | cannot be null | Mermaid Config |
| tickInterval | string | Optional | cannot be null | Mermaid Config |
| topAxis | boolean | Required | cannot be null | Mermaid Config |
| displayMode | string | Optional | cannot be null | Mermaid Config |
| weekday | string | Required | cannot be null | Mermaid Config |
titleTopMargin
Margin top for the text over the diagram
titleTopMargin
is required
Type:
integercannot be null
defined in: Mermaid Config
titleTopMargin Type
integer
titleTopMargin Constraints
minimum: the value of this number must greater than or equal to: 0
titleTopMargin Default Value
The default value is:
25barHeight
The height of the bars in the graph
barHeight
is required
Type:
integercannot be null
defined in: Mermaid Config
barHeight Type
integer
barHeight Constraints
minimum: the value of this number must greater than or equal to: 0
barHeight Default Value
The default value is:
20barGap
The margin between the different activities in the gantt diagram
barGap
is optional
Type:
integercannot be null
defined in: Mermaid Config
barGap Type
integer
barGap Constraints
minimum: the value of this number must greater than or equal to: 0
barGap Default Value
The default value is:
4topPadding
Margin between title and gantt diagram and between axis and gantt diagram.
topPadding
is required
Type:
integercannot be null
defined in: Mermaid Config
topPadding Type
integer
topPadding Constraints
minimum: the value of this number must greater than or equal to: 0
topPadding Default Value
The default value is:
50rightPadding
The space allocated for the section name to the right of the activities
rightPadding
is required
Type:
integercannot be null
defined in: Mermaid Config
rightPadding Type
integer
rightPadding Constraints
minimum: the value of this number must greater than or equal to: 0
rightPadding Default Value
The default value is:
75leftPadding
The space allocated for the section name to the left of the activities
leftPadding
is required
Type:
integercannot be null
defined in: Mermaid Config
leftPadding Type
integer
leftPadding Constraints
minimum: the value of this number must greater than or equal to: 0
leftPadding Default Value
The default value is:
75gridLineStartPadding
Vertical starting position of the grid lines
gridLineStartPadding
is required
Type:
integercannot be null
defined in: Mermaid Config
gridLineStartPadding Type
integer
gridLineStartPadding Constraints
minimum: the value of this number must greater than or equal to: 0
gridLineStartPadding Default Value
The default value is:
35fontSize
Font size
fontSize
is required
Type:
integercannot be null
defined in: Mermaid Config
fontSize Type
integer
fontSize Constraints
minimum: the value of this number must greater than or equal to: 0
fontSize Default Value
The default value is:
11sectionFontSize
Font size for sections
sectionFontSize
is required
Type:
integercannot be null
defined in: Mermaid Config
tsType:
string | number
sectionFontSize Type
integer
sectionFontSize Constraints
minimum: the value of this number must greater than or equal to: 0
sectionFontSize Default Value
The default value is:
11numberSectionStyles
The number of alternating section styles
numberSectionStyles
is required
Type:
integercannot be null
defined in: Mermaid Config
numberSectionStyles Type
integer
numberSectionStyles Constraints
minimum: the value of this number must greater than or equal to: 0
numberSectionStyles Default Value
The default value is:
4axisFormat
Date/time format of the axis
This might need adjustment to match your locale and preferences.
axisFormat
is required
Type:
stringcannot be null
defined in: Mermaid Config
axisFormat Type
string
axisFormat Default Value
The default value is:
"%Y-%m-%d"tickInterval
axis ticks
Pattern is:
/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/;tickInterval
is optional
Type:
stringcannot be null
defined in: Mermaid Config
tickInterval Type
string
tickInterval Constraints
pattern: the string must match the following regular expression:
/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/topAxis
When this flag is set, date labels will be added to the top of the chart
topAxis
is required
Type:
booleancannot be null
defined in: Mermaid Config
topAxis Type
boolean
displayMode
Controls the display mode.
displayMode
is optional
Type:
stringcannot be null
defined in: Mermaid Config
tsType:
string | "compact"
displayMode Type
string
displayMode Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"" | |
"compact" | Enables displaying multiple tasks on the same row. |
weekday
On which day a week-based interval should start
weekday
is required
Type:
stringcannot be null
defined in: Mermaid Config
tsType:
"monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"
weekday Type
string
weekday Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"monday" | |
"tuesday" | |
"wednesday" | |
"thursday" | |
"friday" | |
"saturday" | |
"sunday" |
weekday Default Value
The default value is:
"sunday"