State Diagram Config Schema
https://mermaid.js.org/schemas/config.schema.json#/$defs/StateDiagramConfigThe object containing configurations specific for entity relationship 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* |
StateDiagramConfig Type
object (State Diagram Config)
all of
StateDiagramConfig Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| theme | string | Optional | cannot be null | Mermaid Config |
| look | string | Optional | cannot be null | Mermaid Config |
| layout | string | Optional | cannot be null | Mermaid Config |
| wrappingWidth | number | Required | cannot be null | Mermaid Config |
| minNodeWidth | number | Required | cannot be null | Mermaid Config |
| titleTopMargin | integer | Required | cannot be null | Mermaid Config |
| arrowMarkerAbsolute | boolean | Optional | cannot be null | Mermaid Config |
| dividerMargin | number | Optional | cannot be null | Mermaid Config |
| sizeUnit | number | Optional | cannot be null | Mermaid Config |
| padding | number | Optional | cannot be null | Mermaid Config |
| textHeight | number | Optional | cannot be null | Mermaid Config |
| titleShift | number | Optional | cannot be null | Mermaid Config |
| noteMargin | number | Optional | cannot be null | Mermaid Config |
| nodeSpacing | integer | Optional | cannot be null | Mermaid Config |
| rankSpacing | integer | Optional | cannot be null | Mermaid Config |
| forkWidth | number | Optional | cannot be null | Mermaid Config |
| forkHeight | number | Optional | cannot be null | Mermaid Config |
| miniPadding | number | Optional | cannot be null | Mermaid Config |
| fontSizeFactor | number | Optional | cannot be null | Mermaid Config |
| fontSize | number | Optional | cannot be null | Mermaid Config |
| labelHeight | number | Optional | cannot be null | Mermaid Config |
| edgeLengthFactor | string | Optional | cannot be null | Mermaid Config |
| compositTitleSize | number | Optional | cannot be null | Mermaid Config |
| radius | number | 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"layout
Defines which layout algorithm to use for rendering the diagram.
layout
is optional
Type:
stringcannot be null
defined in: Mermaid Config
layout Type
string
layout Default Value
The default value is:
"elk"wrappingWidth
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:
120titleTopMargin
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:
25arrowMarkerAbsolute
arrowMarkerAbsolute
is optional
Type:
booleancannot be null
defined in: Mermaid Config
arrowMarkerAbsolute Type
boolean
dividerMargin
dividerMargin
is optional
Type:
numbercannot be null
defined in: Mermaid Config
dividerMargin Type
number
dividerMargin Default Value
The default value is:
10sizeUnit
sizeUnit
is optional
Type:
numbercannot be null
defined in: Mermaid Config
sizeUnit Type
number
sizeUnit Default Value
The default value is:
5padding
padding
is optional
Type:
numbercannot be null
defined in: Mermaid Config
padding Type
number
padding Default Value
The default value is:
8textHeight
textHeight
is optional
Type:
numbercannot be null
defined in: Mermaid Config
textHeight Type
number
textHeight Default Value
The default value is:
10titleShift
titleShift
is optional
Type:
numbercannot be null
defined in: Mermaid Config
titleShift Type
number
titleShift Default Value
The default value is:
-15noteMargin
noteMargin
is optional
Type:
numbercannot be null
defined in: Mermaid Config
noteMargin Type
number
noteMargin Default Value
The default value is:
10nodeSpacing
nodeSpacing
is optional
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
rankSpacing
rankSpacing
is optional
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
forkWidth
forkWidth
is optional
Type:
numbercannot be null
defined in: Mermaid Config
forkWidth Type
number
forkWidth Default Value
The default value is:
70forkHeight
forkHeight
is optional
Type:
numbercannot be null
defined in: Mermaid Config
forkHeight Type
number
forkHeight Default Value
The default value is:
7miniPadding
miniPadding
is optional
Type:
numbercannot be null
defined in: Mermaid Config
miniPadding Type
number
miniPadding Default Value
The default value is:
2fontSizeFactor
Font size factor, this is used to guess the width of the edges labels before rendering by dagre layout. This might need updating if/when switching font
fontSizeFactor
is optional
Type:
numbercannot be null
defined in: Mermaid Config
fontSizeFactor Type
number
fontSizeFactor Default Value
The default value is:
5.02fontSize
fontSize
is optional
Type:
numbercannot be null
defined in: Mermaid Config
fontSize Type
number
fontSize Default Value
The default value is:
24labelHeight
labelHeight
is optional
Type:
numbercannot be null
defined in: Mermaid Config
labelHeight Type
number
labelHeight Default Value
The default value is:
16edgeLengthFactor
edgeLengthFactor
is optional
Type:
stringcannot be null
defined in: Mermaid Config
edgeLengthFactor Type
string
edgeLengthFactor Default Value
The default value is:
"20"compositTitleSize
compositTitleSize
is optional
Type:
numbercannot be null
defined in: Mermaid Config
compositTitleSize Type
number
compositTitleSize Default Value
The default value is:
35radius
radius
is optional
Type:
numbercannot be null
defined in: Mermaid Config
radius Type
number
radius Default Value
The default value is:
5