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 |
|---|---|---|---|---|
| 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 |
| 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 |
| defaultRenderer | 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:
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:
10forkWidth
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:
5defaultRenderer
Decides which rendering engine that is to be used for the rendering.
defaultRenderer
is required
Type:
stringcannot be null
defined in: Mermaid Config
tsType:
string | "dagre-d3" | "dagre-wrapper" | "elk"
defaultRenderer Type
string
defaultRenderer Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"dagre-d3" | The [dagre-d3-es](https://www.npmjs.com/package/dagre-d3-es) library. |
"dagre-wrapper" | wrapper for dagre implemented in mermaid |
"elk" | Layout using [elkjs](https://github.com/kieler/elkjs) |
defaultRenderer Default Value
The default value is:
"dagre-wrapper"