Class Diagram Config Schema β
https://mermaid.js.org/schemas/config.schema.json#/$defs/ClassDiagramConfig
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* |
ClassDiagramConfig Type β
object
(Class Diagram Config)
all of
ClassDiagramConfig 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 |
padding | number | Optional | cannot be null | Mermaid Config |
textHeight | number | Optional | cannot be null | Mermaid Config |
defaultRenderer | string | Required | cannot be null | Mermaid Config |
nodeSpacing | integer | Optional | cannot be null | Mermaid Config |
rankSpacing | integer | Optional | cannot be null | Mermaid Config |
diagramPadding | integer | Optional | cannot be null | Mermaid Config |
htmlLabels | boolean | Optional | cannot be null | Mermaid Config |
hideEmptyMembersBox | boolean | Optional | cannot be null | Mermaid Config |
titleTopMargin β
Margin top for the text over the diagram
titleTopMargin
is required
Type:
integer
cannot 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:
25
arrowMarkerAbsolute β
Controls whether or arrow markers in html code are absolute paths or anchors. This matters if you are using base tag settings.
arrowMarkerAbsolute
is optional
Type:
boolean
cannot be null
defined in: Mermaid Config
arrowMarkerAbsolute Type β
boolean
dividerMargin β
dividerMargin
is optional
Type:
number
cannot be null
defined in: Mermaid Config
dividerMargin Type β
number
dividerMargin Default Value β
The default value is:
10
padding β
padding
is optional
Type:
number
cannot be null
defined in: Mermaid Config
padding Type β
number
padding Default Value β
The default value is:
5
textHeight β
textHeight
is optional
Type:
number
cannot be null
defined in: Mermaid Config
textHeight Type β
number
textHeight Default Value β
The default value is:
10
defaultRenderer β
Decides which rendering engine that is to be used for the rendering.
defaultRenderer
is required
Type:
string
cannot be null
defined in: Mermaid Config
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"
nodeSpacing β
nodeSpacing
is optional
Type:
integer
cannot 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:
integer
cannot be null
defined in: Mermaid Config
rankSpacing Type β
integer
rankSpacing Constraints β
minimum: the value of this number must greater than or equal to: 0
diagramPadding β
The amount of padding around the diagram as a whole so that embedded diagrams have margins, expressed in pixels.
diagramPadding
is optional
Type:
integer
cannot 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:
20
htmlLabels β
htmlLabels
is optional
Type:
boolean
cannot be null
defined in: Mermaid Config
htmlLabels Type β
boolean
hideEmptyMembersBox β
hideEmptyMembersBox
is optional
Type:
boolean
cannot be null
defined in: Mermaid Config
hideEmptyMembersBox Type β
boolean