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

• Base Diagram Config

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

图表上方文本的顶部边​​距

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

控制 html 代码中的箭头标记是绝对路径还是锚点。如果你使用基本标签设置，这很重要。

arrowMarkerAbsolute

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

arrowMarkerAbsolute Default Value

The default value is:

false

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

决定要使用哪个渲染引擎进行渲染。

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

整个图表周围的填充量，以便嵌入的图表具有边距，以像素表示。

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

htmlLabels Default Value

The default value is:

false

hideEmptyMembersBox

hideEmptyMembersBox

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

hideEmptyMembersBox Type

boolean

hideEmptyMembersBox Default Value

The default value is:

false