Er Diagram Config Schema
https://mermaid.js.org/schemas/config.schema.json#/$defs/ErDiagramConfigThe 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* |
ErDiagramConfig Type
object (Er Diagram Config)
all of
ErDiagramConfig Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| titleTopMargin | integer | Required | cannot be null | Mermaid Config |
| diagramPadding | integer | Required | cannot be null | Mermaid Config |
| layoutDirection | string | Required | cannot be null | Mermaid Config |
| minEntityWidth | integer | Required | cannot be null | Mermaid Config |
| minEntityHeight | integer | Required | cannot be null | Mermaid Config |
| entityPadding | integer | Required | cannot be null | Mermaid Config |
| nodeSpacing | integer | Optional | cannot be null | Mermaid Config |
| rankSpacing | integer | Optional | cannot be null | Mermaid Config |
| stroke | string | Required | cannot be null | Mermaid Config |
| fill | string | Required | cannot be null | Mermaid Config |
| fontSize | integer | Optional | 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:
25diagramPadding
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:
20layoutDirection
Directional bias for layout of entities
layoutDirection
is required
Type:
stringcannot be null
defined in: Mermaid Config
layoutDirection Type
string
layoutDirection Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"TB" | Top-Bottom |
"BT" | Bottom-Top |
"LR" | Left-Right |
"RL" | Right to Left |
layoutDirection Default Value
The default value is:
"TB"minEntityWidth
The minimum width of an entity box. Expressed in pixels.
minEntityWidth
is required
Type:
integercannot be null
defined in: Mermaid Config
minEntityWidth Type
integer
minEntityWidth Constraints
minimum: the value of this number must greater than or equal to: 0
minEntityWidth Default Value
The default value is:
100minEntityHeight
The minimum height of an entity box. Expressed in pixels.
minEntityHeight
is required
Type:
integercannot be null
defined in: Mermaid Config
minEntityHeight Type
integer
minEntityHeight Constraints
minimum: the value of this number must greater than or equal to: 0
minEntityHeight Default Value
The default value is:
75entityPadding
The minimum internal padding between text in an entity box and the enclosing box borders. Expressed in pixels.
entityPadding
is required
Type:
integercannot be null
defined in: Mermaid Config
entityPadding Type
integer
entityPadding Constraints
minimum: the value of this number must greater than or equal to: 0
entityPadding Default Value
The default value is:
15nodeSpacing
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
nodeSpacing Default Value
The default value is:
140rankSpacing
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
rankSpacing Default Value
The default value is:
80stroke
Stroke color of box edges and lines.
stroke
is required
Type:
stringcannot be null
defined in: Mermaid Config
stroke Type
string
stroke Default Value
The default value is:
"gray"fill
Fill color of entity boxes
fill
is required
Type:
stringcannot be null
defined in: Mermaid Config
fill Type
string
fill Default Value
The default value is:
"honeydew"fontSize
Font size (expressed as an integer representing a number of pixels)
fontSize
is optional
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:
12