Flowchart Diagram Config Schema
https://mermaid.js.org/schemas/config.schema.json#/$defs/FlowchartDiagramConfigThe object containing configurations specific for flowcharts
| 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* |
FlowchartDiagramConfig Type
object (Flowchart Diagram Config)
all of
FlowchartDiagramConfig Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| theme | string | Optional | cannot be null | Mermaid Config |
| look | string | Optional | cannot be null | Mermaid Config |
| titleTopMargin | integer | Required | cannot be null | Mermaid Config |
| subGraphTitleMargin | object | Required | cannot be null | Mermaid Config |
| arrowMarkerAbsolute | boolean | Optional | cannot be null | Mermaid Config |
| diagramPadding | integer | Required | cannot be null | Mermaid Config |
| htmlLabels | boolean | Optional | can be null | Mermaid Config |
| nodeSpacing | integer | Required | cannot be null | Mermaid Config |
| rankSpacing | integer | Required | cannot be null | Mermaid Config |
| curve | string | Required | cannot be null | Mermaid Config |
| padding | number | Optional | cannot be null | Mermaid Config |
| wrappingWidth | number | Required | cannot be null | Mermaid Config |
| minNodeWidth | number | Required | cannot be null | Mermaid Config |
| inheritDir | boolean | Optional | cannot be null | Mermaid Config |
theme
Theme, the CSS style sheet. You may also use themeCSS to override this value.
theme
is optional
Type:
stringcannot be null
defined in: Mermaid Config
theme Type
string
theme Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"default" | |
"base" | |
"dark" | |
"forest" | |
"neutral" | |
"neo" | |
"neo-dark" | |
"redux" | |
"redux-dark" | |
"redux-color" | |
"redux-dark-color" | |
"null" | Can be set to disable any pre-defined mermaid theme |
theme Default Value
The default value is:
"redux-color"look
Defines which main look to use for the diagram.
look
is optional
Type:
stringcannot be null
defined in: Mermaid Config
look Type
string
look Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"classic" | |
"handDrawn" | |
"neo" |
look Default Value
The default value is:
"neo"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:
25subGraphTitleMargin
Defines a top/bottom margin for subgraph titles
subGraphTitleMargin
is required
Type:
object(Details)cannot be null
defined in: Mermaid Config
subGraphTitleMargin Type
object (Details)
subGraphTitleMargin Default Value
The default value is:
{
"top": 0,
"bottom": 0
}arrowMarkerAbsolute
arrowMarkerAbsolute
is optional
Type:
booleancannot be null
defined in: Mermaid Config
arrowMarkerAbsolute Type
boolean
diagramPadding
The amount of padding around the diagram as a whole so that embedded diagrams have margins, expressed in pixels.
diagramPadding
is required
Type:
integercannot be null
defined in: Mermaid Config
diagramPadding Type
integer
diagramPadding Constraints
minimum: the value of this number must greater than or equal to: 0
diagramPadding Default Value
The default value is:
20htmlLabels
DEPRECATED: Use global htmlLabels instead.
Flag for setting whether or not a html tag should be used for rendering labels on nodes and edges. This property is deprecated. Please use the global htmlLabels configuration instead.
htmlLabels
is optional
Type:
booleancan be null
defined in: Mermaid Config
htmlLabels Type
boolean
htmlLabels Default Value
The default value is:
nullnodeSpacing
Defines the spacing between nodes on the same level
Pertains to horizontal spacing for TB (top to bottom) or BT (bottom to top) graphs, and the vertical spacing for LR as well as RL graphs.
nodeSpacing
is required
Type:
integercannot be null
defined in: Mermaid Config
nodeSpacing Type
integer
nodeSpacing Constraints
minimum: the value of this number must greater than or equal to: 0
nodeSpacing Default Value
The default value is:
50rankSpacing
Defines the spacing between nodes on different levels
Pertains to horizontal spacing for TB (top to bottom) or BT (bottom to top) graphs, and the vertical spacing for LR as well as RL graphs.
rankSpacing
is required
Type:
integercannot be null
defined in: Mermaid Config
rankSpacing Type
integer
rankSpacing Constraints
minimum: the value of this number must greater than or equal to: 0
rankSpacing Default Value
The default value is:
50curve
Defines how mermaid renders curves for flowcharts.
curve
is required
Type:
stringcannot be null
defined in: Mermaid Config
curve Type
string
curve Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"basis" | |
"bumpX" | |
"bumpY" | |
"cardinal" | |
"catmullRom" | |
"linear" | |
"monotoneX" | |
"monotoneY" | |
"natural" | |
"step" | |
"stepAfter" | |
"stepBefore" | |
"rounded" |
curve Default Value
The default value is:
"basis"padding
Represents the padding between the labels and the shape
Only used in new experimental rendering.
padding
is optional
Type:
numbercannot be null
defined in: Mermaid Config
padding Type
number
padding Default Value
The default value is:
15wrappingWidth
Width of nodes where text is wrapped.
When using markdown strings the text is wrapped automatically, this value sets the max width of a text before it continues on a new line.
wrappingWidth
is required
Type:
numbercannot be null
defined in: Mermaid Config
wrappingWidth Type
number
wrappingWidth Default Value
The default value is:
120minNodeWidth
Minimum width of the label area of a node.
Labels narrower than this are widened to it, so nodes with short text get a uniform width; the node's own padding is added on top, the same way it is for wrappingWidth. Nodes with an explicit width are not affected.
minNodeWidth
is required
Type:
numbercannot be null
defined in: Mermaid Config
minNodeWidth Type
number
minNodeWidth Default Value
The default value is:
120inheritDir
If true, subgraphs without explicit direction will inherit the global graph direction (e.g., LR, TB, RL, BT). Defaults to false to preserve legacy layout behavior.
inheritDir
is optional
Type:
booleancannot be null
defined in: Mermaid Config
inheritDir Type
boolean
inheritDir Default Value
The default value is:
false