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 |
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
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:
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:
10padding
padding
is optional
Type:
numbercannot be null
defined in: Mermaid Config
padding Type
number
padding Default Value
The default value is:
5textHeight
textHeight
is optional
Type:
numbercannot be null
defined in: Mermaid Config
textHeight Type
number
textHeight Default Value
The default value is:
10defaultRenderer
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"nodeSpacing
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
diagramPadding
The amount of padding around the diagram as a whole so that embedded diagrams have margins, expressed in pixels.
diagramPadding
is optional
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
htmlLabels
is optional
Type:
booleancannot be null
defined in: Mermaid Config
htmlLabels Type
boolean