Mermaid Config Schema

https://mermaid.js.org/schemas/config.schema.json

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	config.schema.json

Mermaid Config Type

object (Mermaid Config)

Mermaid Config Properties

Property	Type	Required	Nullable	Defined by
theme	string	Optional	cannot be null	Mermaid Config
themeVariables	Not specified	Optional	cannot be null	Mermaid Config
themeCSS	string	Optional	cannot be null	Mermaid Config
look	string	Required	cannot be null	Mermaid Config
handDrawnSeed	number	Optional	cannot be null	Mermaid Config
layout	string	Optional	cannot be null	Mermaid Config
maxTextSize	number	Optional	cannot be null	Mermaid Config
maxEdges	integer	Optional	cannot be null	Mermaid Config
elk	object	Optional	cannot be null	Mermaid Config
darkMode	boolean	Optional	cannot be null	Mermaid Config
htmlLabels	boolean	Optional	cannot be null	Mermaid Config
fontFamily	string	Required	cannot be null	Mermaid Config
altFontFamily	string	Optional	cannot be null	Mermaid Config
logLevel	Multiple	Required	cannot be null	Mermaid Config
securityLevel	string	Required	cannot be null	Mermaid Config
startOnLoad	boolean	Required	cannot be null	Mermaid Config
arrowMarkerAbsolute	boolean	Required	cannot be null	Mermaid Config
secure	array	Optional	cannot be null	Mermaid Config
legacyMathML	boolean	Optional	cannot be null	Mermaid Config
forceLegacyMathML	boolean	Optional	cannot be null	Mermaid Config
deterministicIds	boolean	Optional	cannot be null	Mermaid Config
deterministicIDSeed	string	Optional	cannot be null	Mermaid Config
flowchart	Merged	Required	cannot be null	Mermaid Config
sequence	Merged	Required	cannot be null	Mermaid Config
gantt	Merged	Required	cannot be null	Mermaid Config
journey	Merged	Required	cannot be null	Mermaid Config
timeline	Merged	Optional	cannot be null	Mermaid Config
class	Merged	Required	cannot be null	Mermaid Config
state	Merged	Required	cannot be null	Mermaid Config
er	Merged	Required	cannot be null	Mermaid Config
pie	Merged	Required	cannot be null	Mermaid Config
quadrantChart	Merged	Required	cannot be null	Mermaid Config
xyChart	Merged	Required	cannot be null	Mermaid Config
requirement	Merged	Required	cannot be null	Mermaid Config
architecture	Merged	Required	cannot be null	Mermaid Config
mindmap	Merged	Required	cannot be null	Mermaid Config
kanban	Merged	Required	cannot be null	Mermaid Config
gitGraph	Merged	Required	cannot be null	Mermaid Config
c4	Merged	Required	cannot be null	Mermaid Config
sankey	Merged	Required	cannot be null	Mermaid Config
packet	Merged	Required	cannot be null	Mermaid Config
block	Merged	Required	cannot be null	Mermaid Config
dompurifyConfig	object	Optional	cannot be null	Mermaid Config
wrap	boolean	Optional	cannot be null	Mermaid Config
fontSize	number	Optional	cannot be null	Mermaid Config
markdownAutoWrap	boolean	Optional	cannot be null	Mermaid Config
suppressErrorRendering	boolean	Optional	cannot be null	Mermaid Config

theme

主题，CSS 样式表。你也可以使用 themeCSS 覆盖此值。

theme

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

theme Type

string

theme Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"default"
"base"
"dark"
"forest"
"neutral"
"null"	Can be set to disable any pre-defined mermaid theme

theme Default Value

The default value is:

"default"

themeVariables

themeVariables

• is optional

• Type: unknown

• cannot be null

• defined in: Mermaid Config

• tsType: any

themeVariables Type

unknown

themeCSS

themeCSS

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

themeCSS Type

string

look

定义图表要使用的主要外观。

look

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

look Type

string

look Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"classic"
"handDrawn"

look Default Value

The default value is:

"classic"

handDrawnSeed

定义使用手绘外观时要使用的种子。这对于自动化测试很重要，因为它们总是会在没有种子的情况下发现差异。默认值为 0，它给出一个随机种子。

handDrawnSeed

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

handDrawnSeed Type

number

layout

定义用于渲染图表的布局算法。

layout

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

layout Type

string

layout Default Value

The default value is:

"dagre"

maxTextSize

用户文本图的最大允许大小

maxTextSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

maxTextSize Type

number

maxTextSize Default Value

The default value is:

50000

maxEdges

定义图形中可以绘制的最大边数。

maxEdges

• is optional

• Type: integer

• cannot be null

• defined in: Mermaid Config

maxEdges Type

integer

maxEdges Constraints

minimum: the value of this number must greater than or equal to: 0

maxEdges Default Value

The default value is:

500

elk

elk

• is optional

• Type: object (Details)

• cannot be null

• defined in: Mermaid Config

elk Type

object (Details)

darkMode

darkMode

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

darkMode Type

boolean

htmlLabels

htmlLabels

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

htmlLabels Type

boolean

fontFamily

指定渲染图表中使用的字体。可以是任何可能的 CSS font-family。 See https://developer.mozilla.org/en-US/docs/Web/CSS/font-family

fontFamily

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

fontFamily Type

string

fontFamily Default Value

The default value is:

"\"trebuchet ms\", verdana, arial, sans-serif;"

altFontFamily

altFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

altFontFamily Type

string

logLevel

此选项决定 mermaid 要使用的日志量。

logLevel

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

logLevel Type

any of the following: string or number (Details)

logLevel Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"trace"	Equivalent to 0
0
"debug"	Equivalent to 1
1
"info"	Equivalent to 2
2
"warn"	Equivalent to 3
3
"error"	Equivalent to 4
4
"fatal"	Equivalent to 5 (default)
5

logLevel Default Value

The default value is:

5

securityLevel

解析图表的信任级别

securityLevel

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

securityLevel Type

string

securityLevel Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"strict"	(**default**) HTML tags in the text are encoded and click functionality is disabled.
"loose"	HTML tags in text are allowed and click functionality is enabled.
"antiscript"	HTML tags in text are allowed (only script elements are removed), and click functionality is enabled.
"sandbox"	With this security level, all rendering takes place in a sandboxed iframe. This prevent any JavaScript from running in the context. This may hinder interactive functionality of the diagram, like scripts, popups in the sequence diagram, or links to other tabs or targets, etc.

securityLevel Default Value

The default value is:

"strict"

startOnLoad

指示 mermaid 是否在页面加载时启动

startOnLoad

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

startOnLoad Type

boolean

startOnLoad Default Value

The default value is:

true

arrowMarkerAbsolute

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

arrowMarkerAbsolute

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

secure

此选项控制哪些 currentConfig 密钥被视为安全，并且只能通过调用 mermaid.initialize 进行更改。这可以防止恶意图形指令覆盖站点的默认安全性。

secure

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

secure Type

string[]

secure Default Value

The default value is:

["secure", "securityLevel", "startOnLoad", "maxTextSize", "suppressErrorRendering", "maxEdges"]

legacyMathML

此选项指定 Mermaid 是否可以期望依赖包含没有自己的 MathML 实现的浏览器的 KaTeX 样式表。如果禁用此选项且不支持 MathML，则数学公式将被替换为警告。如果启用此选项且不支持 MathML，则 Mermaid 将恢复为 KaTeX 的传统渲染。

legacyMathML

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

legacyMathML Type

boolean

forceLegacyMathML

此选项强制 Mermaid 依赖 KaTeX 自己的样式表来渲染 MathML。由于操作系统字体和浏览器的 MathML 实现之间的差异，如果一致的渲染很重要，建议使用此选项。如果设置为 true，则忽略 legacyMathML。

forceLegacyMathML

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

forceLegacyMathML Type

boolean

deterministicIds

此选项控制 SVG 中节点的生成 ID 是随机生成的还是基于种子生成的。如果设置为 false，则 ID 将基于当前日期生成，因此不是确定性的。这是默认行为。如果你的文件被签入源代码管理，这很重要，例如 git 并且除非内容发生变化，否则不应更改。

deterministicIds

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

deterministicIds Type

boolean

deterministicIDSeed

此选项是确定性 ID 的可选种子。如果设置为 undefined 但 deterministicIds 是 true，则使用简单的数字迭代器。你可以设置此属性以基于静态字符串的种子。

deterministicIDSeed

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

deterministicIDSeed Type

string

flowchart

包含特定于流程图的配置的对象

flowchart

• is required

• Type: object (Flowchart Diagram Config)

• cannot be null

• defined in: Mermaid Config

flowchart Type

object (Flowchart Diagram Config)

all of

• Base Diagram Config

sequence

包含特定于时序图的配置的对象

sequence

• is required

• Type: object (Sequence Diagram Config)

• cannot be null

• defined in: Mermaid Config

sequence Type

object (Sequence Diagram Config)

all of

• Base Diagram Config

gantt

包含特定于甘特图的配置的对象

gantt

• is required

• Type: object (Gantt Diagram Config)

• cannot be null

• defined in: Mermaid Config

gantt Type

object (Gantt Diagram Config)

all of

• Base Diagram Config

journey

包含特定于旅程图的配置的对象

journey

• is required

• Type: object (Journey Diagram Config)

• cannot be null

• defined in: Mermaid Config

journey Type

object (Journey Diagram Config)

all of

• Base Diagram Config

timeline

timeline

• is optional

• Type: object (Timeline Diagram Config)

• cannot be null

• defined in: Mermaid Config

timeline Type

object (Timeline Diagram Config)

all of

• Base Diagram Config

class

class

• is required

• Type: object (Class Diagram Config)

• cannot be null

• defined in: Mermaid Config

class Type

object (Class Diagram Config)

all of

• Base Diagram Config

state

包含特定于实体关系图的配置的对象

state

• is required

• Type: object (State Diagram Config)

• cannot be null

• defined in: Mermaid Config

state Type

object (State Diagram Config)

all of

• Base Diagram Config

er

包含特定于实体关系图的配置的对象

er

• is required

• Type: object (Er Diagram Config)

• cannot be null

• defined in: Mermaid Config

er Type

object (Er Diagram Config)

all of

• Base Diagram Config

pie

pie

• is required

• Type: object (Pie Diagram Config)

• cannot be null

• defined in: Mermaid Config

pie Type

object (Pie Diagram Config)

all of

• Base Diagram Config

quadrantChart

quadrantChart

• is required

• Type: object (Quadrant Chart Config)

• cannot be null

• defined in: Mermaid Config

quadrantChart Type

object (Quadrant Chart Config)

all of

• Base Diagram Config

xyChart

此对象包含特定于 XYCharts 的配置

xyChart

• is required

• Type: object (XYChart Config)

• cannot be null

• defined in: Mermaid Config

xyChart Type

object (XYChart Config)

all of

• Base Diagram Config

requirement

包含特定于 req 图的配置的对象

requirement

• is required

• Type: object (Requirement Diagram Config)

• cannot be null

• defined in: Mermaid Config

requirement Type

object (Requirement Diagram Config)

all of

• Base Diagram Config

architecture

包含特定于架构图的配置的对象

architecture

• is required

• Type: object (Architecture Diagram Config)

• cannot be null

• defined in: Mermaid Config

architecture Type

object (Architecture Diagram Config)

all of

• Base Diagram Config

mindmap

包含特定于思维导图的配置的对象

mindmap

• is required

• Type: object (Mindmap Diagram Config)

• cannot be null

• defined in: Mermaid Config

mindmap Type

object (Mindmap Diagram Config)

all of

• Base Diagram Config

kanban

包含特定于看板图的配置的对象

kanban

• is required

• Type: object (Kanban Diagram Config)

• cannot be null

• defined in: Mermaid Config

kanban Type

object (Kanban Diagram Config)

all of

• Base Diagram Config

gitGraph

gitGraph

• is required

• Type: object (Git Graph Diagram Config)

• cannot be null

• defined in: Mermaid Config

gitGraph Type

object (Git Graph Diagram Config)

all of

• Base Diagram Config

c4

包含特定于 c4 图的配置的对象

c4

• is required

• Type: object (C4 Diagram Config)

• cannot be null

• defined in: Mermaid Config

c4 Type

object (C4 Diagram Config)

all of

• Base Diagram Config

sankey

包含特定于桑基图的配置的对象。

sankey

• is required

• Type: object (Sankey Diagram Config)

• cannot be null

• defined in: Mermaid Config

sankey Type

object (Sankey Diagram Config)

all of

• Base Diagram Config

packet

包含特定于数据包图的配置的对象。

packet

• is required

• Type: object (Packet Diagram Config)

• cannot be null

• defined in: Mermaid Config

packet Type

object (Packet Diagram Config)

all of

• Base Diagram Config

block

包含特定于框图的配置的对象。

block

• is required

• Type: object (Block Diagram Config)

• cannot be null

• defined in: Mermaid Config

block Type

object (Block Diagram Config)

all of

• Base Diagram Config

dompurifyConfig

传递给 dompurify 库的配置选项。

dompurifyConfig

• is optional

• Type: object (DOM Purify Configuration)

• cannot be null

• defined in: Mermaid Config

• tsType: import('dompurify').Config

dompurifyConfig Type

object (DOM Purify Configuration)

wrap

wrap

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

wrap Type

boolean

fontSize

fontSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSize Type

number

fontSize Default Value

The default value is:

16

markdownAutoWrap

markdownAutoWrap

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

markdownAutoWrap Type

boolean

markdownAutoWrap Default Value

The default value is:

true

suppressErrorRendering

禁止在 DOM 中插入 'Syntax error' 图。当你想要控制如何处理应用中的语法错误时，这很有用。

suppressErrorRendering

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

suppressErrorRendering Type

boolean

Mermaid Config Definitions

Definitions group BaseDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/BaseDiagramConfig" }

Property	Type	Required	Nullable	Defined by
useWidth	number	Optional	cannot be null	Mermaid Config
useMaxWidth	boolean	Optional	cannot be null	Mermaid Config

useWidth

useWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

useWidth Type

number

useMaxWidth

当此标志设置为 true 时，高度和宽度设置为 100%，然后使用可用空间缩放。如果设置为 false，则使用所需的绝对空间。

useMaxWidth

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

useMaxWidth Type

boolean

useMaxWidth Default Value

The default value is:

true

Definitions group C4DiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/C4DiagramConfig" }

Property	Type	Required	Nullable	Defined by
diagramMarginX	integer	Required	cannot be null	Mermaid Config
diagramMarginY	integer	Required	cannot be null	Mermaid Config
c4ShapeMargin	integer	Required	cannot be null	Mermaid Config
c4ShapePadding	integer	Required	cannot be null	Mermaid Config
width	integer	Required	cannot be null	Mermaid Config
height	integer	Required	cannot be null	Mermaid Config
boxMargin	integer	Required	cannot be null	Mermaid Config
c4ShapeInRow	integer	Required	cannot be null	Mermaid Config
nextLinePaddingX	number	Optional	cannot be null	Mermaid Config
c4BoundaryInRow	integer	Required	cannot be null	Mermaid Config
personFontSize	Multiple	Optional	cannot be null	Mermaid Config
personFontFamily	string	Optional	cannot be null	Mermaid Config
personFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_personFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_personFontFamily	string	Optional	cannot be null	Mermaid Config
external_personFontWeight	Multiple	Optional	cannot be null	Mermaid Config
systemFontSize	Multiple	Optional	cannot be null	Mermaid Config
systemFontFamily	string	Optional	cannot be null	Mermaid Config
systemFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_systemFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_systemFontFamily	string	Optional	cannot be null	Mermaid Config
external_systemFontWeight	Multiple	Optional	cannot be null	Mermaid Config
system_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
system_dbFontFamily	string	Optional	cannot be null	Mermaid Config
system_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_system_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_system_dbFontFamily	string	Optional	cannot be null	Mermaid Config
external_system_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
system_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
system_queueFontFamily	string	Optional	cannot be null	Mermaid Config
system_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_system_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_system_queueFontFamily	string	Optional	cannot be null	Mermaid Config
external_system_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
boundaryFontSize	Multiple	Optional	cannot be null	Mermaid Config
boundaryFontFamily	string	Optional	cannot be null	Mermaid Config
boundaryFontWeight	Multiple	Optional	cannot be null	Mermaid Config
messageFontSize	Multiple	Optional	cannot be null	Mermaid Config
messageFontFamily	string	Optional	cannot be null	Mermaid Config
messageFontWeight	Multiple	Optional	cannot be null	Mermaid Config
containerFontSize	Multiple	Optional	cannot be null	Mermaid Config
containerFontFamily	string	Optional	cannot be null	Mermaid Config
containerFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_containerFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_containerFontFamily	string	Optional	cannot be null	Mermaid Config
external_containerFontWeight	Multiple	Optional	cannot be null	Mermaid Config
container_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
container_dbFontFamily	string	Optional	cannot be null	Mermaid Config
container_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_container_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_container_dbFontFamily	string	Optional	cannot be null	Mermaid Config
external_container_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
container_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
container_queueFontFamily	string	Optional	cannot be null	Mermaid Config
container_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_container_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_container_queueFontFamily	string	Optional	cannot be null	Mermaid Config
external_container_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
componentFontSize	Multiple	Optional	cannot be null	Mermaid Config
componentFontFamily	string	Optional	cannot be null	Mermaid Config
componentFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_componentFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_componentFontFamily	string	Optional	cannot be null	Mermaid Config
external_componentFontWeight	Multiple	Optional	cannot be null	Mermaid Config
component_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
component_dbFontFamily	string	Optional	cannot be null	Mermaid Config
component_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_component_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_component_dbFontFamily	string	Optional	cannot be null	Mermaid Config
external_component_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
component_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
component_queueFontFamily	string	Optional	cannot be null	Mermaid Config
component_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_component_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_component_queueFontFamily	string	Optional	cannot be null	Mermaid Config
external_component_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
wrap	boolean	Optional	cannot be null	Mermaid Config
wrapPadding	number	Optional	cannot be null	Mermaid Config
person_bg_color	string	Optional	cannot be null	Mermaid Config
person_border_color	string	Optional	cannot be null	Mermaid Config
external_person_bg_color	string	Optional	cannot be null	Mermaid Config
external_person_border_color	string	Optional	cannot be null	Mermaid Config
system_bg_color	string	Optional	cannot be null	Mermaid Config
system_border_color	string	Optional	cannot be null	Mermaid Config
system_db_bg_color	string	Optional	cannot be null	Mermaid Config
system_db_border_color	string	Optional	cannot be null	Mermaid Config
system_queue_bg_color	string	Optional	cannot be null	Mermaid Config
system_queue_border_color	string	Optional	cannot be null	Mermaid Config
external_system_bg_color	string	Optional	cannot be null	Mermaid Config
external_system_border_color	string	Optional	cannot be null	Mermaid Config
external_system_db_bg_color	string	Optional	cannot be null	Mermaid Config
external_system_db_border_color	string	Optional	cannot be null	Mermaid Config
external_system_queue_bg_color	string	Optional	cannot be null	Mermaid Config
external_system_queue_border_color	string	Optional	cannot be null	Mermaid Config
container_bg_color	string	Optional	cannot be null	Mermaid Config
container_border_color	string	Optional	cannot be null	Mermaid Config
container_db_bg_color	string	Optional	cannot be null	Mermaid Config
container_db_border_color	string	Optional	cannot be null	Mermaid Config
container_queue_bg_color	string	Optional	cannot be null	Mermaid Config
container_queue_border_color	string	Optional	cannot be null	Mermaid Config
external_container_bg_color	string	Optional	cannot be null	Mermaid Config
external_container_border_color	string	Optional	cannot be null	Mermaid Config
external_container_db_bg_color	string	Optional	cannot be null	Mermaid Config
external_container_db_border_color	string	Optional	cannot be null	Mermaid Config
external_container_queue_bg_color	string	Optional	cannot be null	Mermaid Config
external_container_queue_border_color	string	Optional	cannot be null	Mermaid Config
component_bg_color	string	Optional	cannot be null	Mermaid Config
component_border_color	string	Optional	cannot be null	Mermaid Config
component_db_bg_color	string	Optional	cannot be null	Mermaid Config
component_db_border_color	string	Optional	cannot be null	Mermaid Config
component_queue_bg_color	string	Optional	cannot be null	Mermaid Config
component_queue_border_color	string	Optional	cannot be null	Mermaid Config
external_component_bg_color	string	Optional	cannot be null	Mermaid Config
external_component_border_color	string	Optional	cannot be null	Mermaid Config
external_component_db_bg_color	string	Optional	cannot be null	Mermaid Config
external_component_db_border_color	string	Optional	cannot be null	Mermaid Config
external_component_queue_bg_color	string	Optional	cannot be null	Mermaid Config
external_component_queue_border_color	string	Optional	cannot be null	Mermaid Config
personFont	Not specified	Optional	cannot be null	Mermaid Config
external_personFont	Not specified	Optional	cannot be null	Mermaid Config
systemFont	Not specified	Optional	cannot be null	Mermaid Config
external_systemFont	Not specified	Optional	cannot be null	Mermaid Config
system_dbFont	Not specified	Optional	cannot be null	Mermaid Config
external_system_dbFont	Not specified	Optional	cannot be null	Mermaid Config
system_queueFont	Not specified	Optional	cannot be null	Mermaid Config
external_system_queueFont	Not specified	Optional	cannot be null	Mermaid Config
containerFont	Not specified	Optional	cannot be null	Mermaid Config
external_containerFont	Not specified	Optional	cannot be null	Mermaid Config
container_dbFont	Not specified	Optional	cannot be null	Mermaid Config
external_container_dbFont	Not specified	Optional	cannot be null	Mermaid Config
container_queueFont	Not specified	Optional	cannot be null	Mermaid Config
external_container_queueFont	Not specified	Optional	cannot be null	Mermaid Config
componentFont	Not specified	Optional	cannot be null	Mermaid Config
external_componentFont	Not specified	Optional	cannot be null	Mermaid Config
component_dbFont	Not specified	Optional	cannot be null	Mermaid Config
external_component_dbFont	Not specified	Optional	cannot be null	Mermaid Config
component_queueFont	Not specified	Optional	cannot be null	Mermaid Config
external_component_queueFont	Not specified	Optional	cannot be null	Mermaid Config
boundaryFont	Not specified	Optional	cannot be null	Mermaid Config
messageFont	Not specified	Optional	cannot be null	Mermaid Config

diagramMarginX

c4 图右侧和左侧的边距必须为正值。

diagramMarginX

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

minimum: the value of this number must greater than or equal to: 0

diagramMarginX Default Value

The default value is:

50

diagramMarginY

c4 图上方和下方的边距必须为正值。

diagramMarginY

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

minimum: the value of this number must greater than or equal to: 0

diagramMarginY Default Value

The default value is:

10

c4ShapeMargin

形状之间的边距

c4ShapeMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

c4ShapeMargin Type

integer

c4ShapeMargin Constraints

minimum: the value of this number must greater than or equal to: 0

c4ShapeMargin Default Value

The default value is:

50

c4ShapePadding

形状之间的填充

c4ShapePadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

c4ShapePadding Type

integer

c4ShapePadding Constraints

minimum: the value of this number must greater than or equal to: 0

c4ShapePadding Default Value

The default value is:

20

width

人物框的宽度

width

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

width Type

integer

width Constraints

minimum: the value of this number must greater than or equal to: 0

width Default Value

The default value is:

216

height

人物框的高度

height

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

height Type

integer

height Constraints

minimum: the value of this number must greater than or equal to: 0

height Default Value

The default value is:

60

boxMargin

框周围的边距

boxMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

minimum: the value of this number must greater than or equal to: 0

boxMargin Default Value

The default value is:

10

c4ShapeInRow

每行要放置多少个形状。

c4ShapeInRow

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

c4ShapeInRow Type

integer

c4ShapeInRow Constraints

minimum: the value of this number must greater than or equal to: 0

c4ShapeInRow Default Value

The default value is:

4

nextLinePaddingX

nextLinePaddingX

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

nextLinePaddingX Type

number

c4BoundaryInRow

每行要放置多少个边界。

c4BoundaryInRow

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

c4BoundaryInRow Type

integer

c4BoundaryInRow Constraints

minimum: the value of this number must greater than or equal to: 0

c4BoundaryInRow Default Value

The default value is:

2

personFontSize

这设置了图表的人员形状的字体大小

personFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

personFontSize Type

any of the following: string or number (Details)

personFontSize Default Value

The default value is:

14

personFontFamily

这设置了图表的人员形状的字体粗细

personFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

personFontFamily Type

string

personFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

personFontWeight

这设置了图表的人员形状的字体粗细

personFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

personFontWeight Type

any of the following: string or number (Details)

personFontWeight Default Value

The default value is:

"normal"

external_personFontSize

这设置了图表的外部人员形状的字体大小

external_personFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_personFontSize Type

any of the following: string or number (Details)

external_personFontSize Default Value

The default value is:

14

external_personFontFamily

这设置了图表的外部人员形状的字体系列

external_personFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_personFontFamily Type

string

external_personFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_personFontWeight

设置图表的外部人员形状的字体粗细

external_personFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_personFontWeight Type

any of the following: string or number (Details)

external_personFontWeight Default Value

The default value is:

"normal"

systemFontSize

这设置了图表的系统形状的字体大小

systemFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

systemFontSize Type

any of the following: string or number (Details)

systemFontSize Default Value

The default value is:

14

systemFontFamily

这设置了图表的系统形状的字体系列

systemFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

systemFontFamily Type

string

systemFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

systemFontWeight

这设置了图表的系统形状的字体粗细

systemFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

systemFontWeight Type

any of the following: string or number (Details)

systemFontWeight Default Value

The default value is:

"normal"

external_systemFontSize

这设置了图表的外部系统形状的字体大小

external_systemFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_systemFontSize Type

any of the following: string or number (Details)

external_systemFontSize Default Value

The default value is:

14

external_systemFontFamily

这设置了图表的外部系统形状的字体系列

external_systemFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_systemFontFamily Type

string

external_systemFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_systemFontWeight

这设置了图表的外部系统形状的字体粗细

external_systemFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_systemFontWeight Type

any of the following: string or number (Details)

external_systemFontWeight Default Value

The default value is:

"normal"

system_dbFontSize

这设置了图表的系统数据库形状的字体大小

system_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

system_dbFontSize Type

any of the following: string or number (Details)

system_dbFontSize Default Value

The default value is:

14

system_dbFontFamily

这设置了图表的系统 DB 形状的字体系列

system_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_dbFontFamily Type

string

system_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

system_dbFontWeight

这设置了图表的系统数据库形状的字体粗细

system_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

system_dbFontWeight Type

any of the following: string or number (Details)

system_dbFontWeight Default Value

The default value is:

"normal"

external_system_dbFontSize

这设置了图表的外部系统数据库形状的字体大小图表

external_system_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_system_dbFontSize Type

any of the following: string or number (Details)

external_system_dbFontSize Default Value

The default value is:

14

external_system_dbFontFamily

这设置了图表的外部系统 DB 形状的字体系列

external_system_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_dbFontFamily Type

string

external_system_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_system_dbFontWeight

设置图表的外部系统数据库形状的字体粗细

external_system_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_system_dbFontWeight Type

any of the following: string or number (Details)

external_system_dbFontWeight Default Value

The default value is:

"normal"

system_queueFontSize

这设置了图表的系统队列形状的字体大小

system_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

system_queueFontSize Type

any of the following: string or number (Details)

system_queueFontSize Default Value

The default value is:

14

system_queueFontFamily

这设置了图表的系统队列形状的字体系列

system_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_queueFontFamily Type

string

system_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

system_queueFontWeight

这设置了图表的系统队列形状的字体粗细

system_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

system_queueFontWeight Type

any of the following: string or number (Details)

system_queueFontWeight Default Value

The default value is:

"normal"

external_system_queueFontSize

这设置了图表的外部系统队列形状的字体大小

external_system_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_system_queueFontSize Type

any of the following: string or number (Details)

external_system_queueFontSize Default Value

The default value is:

14

external_system_queueFontFamily

这设置了图表的外部系统队列形状的字体系列

external_system_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_queueFontFamily Type

string

external_system_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_system_queueFontWeight

设置图表的外部系统队列形状的字体粗细图表

external_system_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_system_queueFontWeight Type

any of the following: string or number (Details)

external_system_queueFontWeight Default Value

The default value is:

"normal"

boundaryFontSize

这将设置图表的边界形状的字体大小

boundaryFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

boundaryFontSize Type

any of the following: string or number (Details)

boundaryFontSize Default Value

The default value is:

14

boundaryFontFamily

设置图表的边界形状的字体系列

boundaryFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

boundaryFontFamily Type

string

boundaryFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

boundaryFontWeight

这设置了图表的边界形状的字体粗细

boundaryFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

boundaryFontWeight Type

any of the following: string or number (Details)

boundaryFontWeight Default Value

The default value is:

"normal"

messageFontSize

这设置了图表的消息形状的字体大小

messageFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

messageFontSize Type

any of the following: string or number (Details)

messageFontSize Default Value

The default value is:

12

messageFontFamily

这设置了图表的消息形状的字体系列

messageFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

messageFontFamily Type

string

messageFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

messageFontWeight

这设置了图表的消息形状的字体粗细

messageFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

messageFontWeight Type

any of the following: string or number (Details)

messageFontWeight Default Value

The default value is:

"normal"

containerFontSize

这设置了图表的容器形状的字体大小

containerFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

containerFontSize Type

any of the following: string or number (Details)

containerFontSize Default Value

The default value is:

14

containerFontFamily

设置图表的容器形状的字体系列

containerFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

containerFontFamily Type

string

containerFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

containerFontWeight

设置图表的容器形状的字体粗细

containerFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

containerFontWeight Type

any of the following: string or number (Details)

containerFontWeight Default Value

The default value is:

"normal"

external_containerFontSize

这设置了图表的外部容器形状的字体大小

external_containerFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_containerFontSize Type

any of the following: string or number (Details)

external_containerFontSize Default Value

The default value is:

14

external_containerFontFamily

这设置了图表的外部容器形状的字体系列

external_containerFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_containerFontFamily Type

string

external_containerFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_containerFontWeight

设置图表的外部容器形状的字体粗细

external_containerFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_containerFontWeight Type

any of the following: string or number (Details)

external_containerFontWeight Default Value

The default value is:

"normal"

container_dbFontSize

这设置了图表的容器数据库形状的字体大小

container_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

container_dbFontSize Type

any of the following: string or number (Details)

container_dbFontSize Default Value

The default value is:

14

container_dbFontFamily

设置图表的容器 DB 形状的字体系列

container_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_dbFontFamily Type

string

container_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

container_dbFontWeight

设置图表的容器数据库形状的字体粗细

container_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

container_dbFontWeight Type

any of the following: string or number (Details)

container_dbFontWeight Default Value

The default value is:

"normal"

external_container_dbFontSize

这设置了图表的外部容器数据库形状的字体大小

external_container_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_container_dbFontSize Type

any of the following: string or number (Details)

external_container_dbFontSize Default Value

The default value is:

14

external_container_dbFontFamily

设置外部容器的字体系列图表的 DB 形状

external_container_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_dbFontFamily Type

string

external_container_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_container_dbFontWeight

设置图表的外部容器数据库形状的字体粗细

external_container_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_container_dbFontWeight Type

any of the following: string or number (Details)

external_container_dbFontWeight Default Value

The default value is:

"normal"

container_queueFontSize

这设置了图表的容器队列形状的字体大小

container_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

container_queueFontSize Type

any of the following: string or number (Details)

container_queueFontSize Default Value

The default value is:

14

container_queueFontFamily

设置图表的容器队列形状的字体系列

container_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_queueFontFamily Type

string

container_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

container_queueFontWeight

设置图表的容器队列形状的字体粗细

container_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

container_queueFontWeight Type

any of the following: string or number (Details)

container_queueFontWeight Default Value

The default value is:

"normal"

external_container_queueFontSize

这设置了图表的外部容器队列形状的字体大小

external_container_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_container_queueFontSize Type

any of the following: string or number (Details)

external_container_queueFontSize Default Value

The default value is:

14

external_container_queueFontFamily

这设置了图表的外部容器队列形状的字体系列

external_container_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_queueFontFamily Type

string

external_container_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_container_queueFontWeight

设置图表的外部容器队列形状的字体粗细

external_container_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_container_queueFontWeight Type

any of the following: string or number (Details)

external_container_queueFontWeight Default Value

The default value is:

"normal"

componentFontSize

这设置了图表的组件形状的字体大小

componentFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

componentFontSize Type

any of the following: string or number (Details)

componentFontSize Default Value

The default value is:

14

componentFontFamily

设置图表的组件形状的字体系列

componentFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

componentFontFamily Type

string

componentFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

componentFontWeight

这设置了图表的组件形状

componentFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

componentFontWeight Type

any of the following: string or number (Details)

componentFontWeight Default Value

The default value is:

"normal"

external_componentFontSize

这设置了图表的外部组件形状的字体大小

external_componentFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_componentFontSize Type

any of the following: string or number (Details)

external_componentFontSize Default Value

The default value is:

14

external_componentFontFamily

设置图表的外部组件形状的字体系列

external_componentFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_componentFontFamily Type

string

external_componentFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_componentFontWeight

设置图表的外部组件形状的字体粗细

external_componentFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_componentFontWeight Type

any of the following: string or number (Details)

external_componentFontWeight Default Value

The default value is:

"normal"

component_dbFontSize

这将设置图表的组件 DB 形状的字体大小

component_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

component_dbFontSize Type

any of the following: string or number (Details)

component_dbFontSize Default Value

The default value is:

14

component_dbFontFamily

设置图表的组件 DB 形状的字体系列

component_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_dbFontFamily Type

string

component_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

component_dbFontWeight

这设置了图表的组件数据库形状的字体粗细

component_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

component_dbFontWeight Type

any of the following: string or number (Details)

component_dbFontWeight Default Value

The default value is:

"normal"

external_component_dbFontSize

这设置了图表的外部组件数据库形状的字体大小

external_component_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_component_dbFontSize Type

any of the following: string or number (Details)

external_component_dbFontSize Default Value

The default value is:

14

external_component_dbFontFamily

设置图表的外部组件 DB 形状的字体系列

external_component_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_dbFontFamily Type

string

external_component_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_component_dbFontWeight

设置图表的外部组件数据库形状的字体粗细

external_component_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_component_dbFontWeight Type

any of the following: string or number (Details)

external_component_dbFontWeight Default Value

The default value is:

"normal"

component_queueFontSize

这设置了图表的组件队列形状的字体大小

component_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

component_queueFontSize Type

any of the following: string or number (Details)

component_queueFontSize Default Value

The default value is:

14

component_queueFontFamily

设置图表的组件队列形状的字体系列

component_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_queueFontFamily Type

string

component_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

component_queueFontWeight

这设置了图表的组件队列形状的字体粗细

component_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

component_queueFontWeight Type

any of the following: string or number (Details)

component_queueFontWeight Default Value

The default value is:

"normal"

external_component_queueFontSize

这设置了图表的外部组件队列形状的字体大小

external_component_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_component_queueFontSize Type

any of the following: string or number (Details)

external_component_queueFontSize Default Value

The default value is:

14

external_component_queueFontFamily

设置图表的外部组件队列形状的字体系列

external_component_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_queueFontFamily Type

string

external_component_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_component_queueFontWeight

设置图表的外部组件队列形状的字体粗细

external_component_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_component_queueFontWeight Type

any of the following: string or number (Details)

external_component_queueFontWeight Default Value

The default value is:

"normal"

wrap

设置图表的自动换行状态

wrap

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

wrap Type

boolean

wrap Default Value

The default value is:

true

wrapPadding

设置图表的自动换行填充（仅限侧面）

wrapPadding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

wrapPadding Type

number

wrapPadding Default Value

The default value is:

10

person_bg_color

person_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

person_bg_color Type

string

person_bg_color Default Value

The default value is:

"#08427B"

person_border_color

person_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

person_border_color Type

string

person_border_color Default Value

The default value is:

"#073B6F"

external_person_bg_color

external_person_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_person_bg_color Type

string

external_person_bg_color Default Value

The default value is:

"#686868"

external_person_border_color

external_person_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_person_border_color Type

string

external_person_border_color Default Value

The default value is:

"#8A8A8A"

system_bg_color

system_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_bg_color Type

string

system_bg_color Default Value

The default value is:

"#1168BD"

system_border_color

system_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_border_color Type

string

system_border_color Default Value

The default value is:

"#3C7FC0"

system_db_bg_color

system_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_db_bg_color Type

string

system_db_bg_color Default Value

The default value is:

"#1168BD"

system_db_border_color

system_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_db_border_color Type

string

system_db_border_color Default Value

The default value is:

"#3C7FC0"

system_queue_bg_color

system_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_queue_bg_color Type

string

system_queue_bg_color Default Value

The default value is:

"#1168BD"

system_queue_border_color

system_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_queue_border_color Type

string

system_queue_border_color Default Value

The default value is:

"#3C7FC0"

external_system_bg_color

external_system_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_bg_color Type

string

external_system_bg_color Default Value

The default value is:

"#999999"

external_system_border_color

external_system_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_border_color Type

string

external_system_border_color Default Value

The default value is:

"#8A8A8A"

external_system_db_bg_color

external_system_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_db_bg_color Type

string

external_system_db_bg_color Default Value

The default value is:

"#999999"

external_system_db_border_color

external_system_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_db_border_color Type

string

external_system_db_border_color Default Value

The default value is:

"#8A8A8A"

external_system_queue_bg_color

external_system_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_queue_bg_color Type

string

external_system_queue_bg_color Default Value

The default value is:

"#999999"

external_system_queue_border_color

external_system_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_queue_border_color Type

string

external_system_queue_border_color Default Value

The default value is:

"#8A8A8A"

container_bg_color

container_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_bg_color Type

string

container_bg_color Default Value

The default value is:

"#438DD5"

container_border_color

container_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_border_color Type

string

container_border_color Default Value

The default value is:

"#3C7FC0"

container_db_bg_color

container_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_db_bg_color Type

string

container_db_bg_color Default Value

The default value is:

"#438DD5"

container_db_border_color

container_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_db_border_color Type

string

container_db_border_color Default Value

The default value is:

"#3C7FC0"

container_queue_bg_color

container_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_queue_bg_color Type

string

container_queue_bg_color Default Value

The default value is:

"#438DD5"

container_queue_border_color

container_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_queue_border_color Type

string

container_queue_border_color Default Value

The default value is:

"#3C7FC0"

external_container_bg_color

external_container_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_bg_color Type

string

external_container_bg_color Default Value

The default value is:

"#B3B3B3"

external_container_border_color

external_container_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_border_color Type

string

external_container_border_color Default Value

The default value is:

"#A6A6A6"

external_container_db_bg_color

external_container_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_db_bg_color Type

string

external_container_db_bg_color Default Value

The default value is:

"#B3B3B3"

external_container_db_border_color

external_container_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_db_border_color Type

string

external_container_db_border_color Default Value

The default value is:

"#A6A6A6"

external_container_queue_bg_color

external_container_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_queue_bg_color Type

string

external_container_queue_bg_color Default Value

The default value is:

"#B3B3B3"

external_container_queue_border_color

external_container_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_queue_border_color Type

string

external_container_queue_border_color Default Value

The default value is:

"#A6A6A6"

component_bg_color

component_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_bg_color Type

string

component_bg_color Default Value

The default value is:

"#85BBF0"

component_border_color

component_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_border_color Type

string

component_border_color Default Value

The default value is:

"#78A8D8"

component_db_bg_color

component_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_db_bg_color Type

string

component_db_bg_color Default Value

The default value is:

"#85BBF0"

component_db_border_color

component_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_db_border_color Type

string

component_db_border_color Default Value

The default value is:

"#78A8D8"

component_queue_bg_color

component_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_queue_bg_color Type

string

component_queue_bg_color Default Value

The default value is:

"#85BBF0"

component_queue_border_color

component_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_queue_border_color Type

string

component_queue_border_color Default Value

The default value is:

"#78A8D8"

external_component_bg_color

external_component_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_bg_color Type

string

external_component_bg_color Default Value

The default value is:

"#CCCCCC"

external_component_border_color

external_component_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_border_color Type

string

external_component_border_color Default Value

The default value is:

"#BFBFBF"

external_component_db_bg_color

external_component_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_db_bg_color Type

string

external_component_db_bg_color Default Value

The default value is:

"#CCCCCC"

external_component_db_border_color

external_component_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_db_border_color Type

string

external_component_db_border_color Default Value

The default value is:

"#BFBFBF"

external_component_queue_bg_color

external_component_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_queue_bg_color Type

string

external_component_queue_bg_color Default Value

The default value is:

"#CCCCCC"

external_component_queue_border_color

external_component_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_queue_border_color Type

string

external_component_queue_border_color Default Value

The default value is:

"#BFBFBF"

personFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

personFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

personFont Type

unknown (Font Calculator)

external_personFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_personFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_personFont Type

unknown (Font Calculator)

systemFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

systemFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

systemFont Type

unknown (Font Calculator)

external_systemFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_systemFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_systemFont Type

unknown (Font Calculator)

system_dbFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

system_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

system_dbFont Type

unknown (Font Calculator)

external_system_dbFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_system_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_system_dbFont Type

unknown (Font Calculator)

system_queueFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

system_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

system_queueFont Type

unknown (Font Calculator)

external_system_queueFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_system_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_system_queueFont Type

unknown (Font Calculator)

containerFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

containerFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

containerFont Type

unknown (Font Calculator)

external_containerFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_containerFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_containerFont Type

unknown (Font Calculator)

container_dbFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

container_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

container_dbFont Type

unknown (Font Calculator)

external_container_dbFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_container_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_container_dbFont Type

unknown (Font Calculator)

container_queueFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

container_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

container_queueFont Type

unknown (Font Calculator)

external_container_queueFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_container_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_container_queueFont Type

unknown (Font Calculator)

componentFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

componentFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

componentFont Type

unknown (Font Calculator)

external_componentFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_componentFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_componentFont Type

unknown (Font Calculator)

component_dbFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

component_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

component_dbFont Type

unknown (Font Calculator)

external_component_dbFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_component_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_component_dbFont Type

unknown (Font Calculator)

component_queueFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

component_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

component_queueFont Type

unknown (Font Calculator)

external_component_queueFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_component_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_component_queueFont Type

unknown (Font Calculator)

boundaryFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

boundaryFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

boundaryFont Type

unknown (Font Calculator)

messageFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

messageFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

messageFont Type

unknown (Font Calculator)

Definitions group GitGraphDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/GitGraphDiagramConfig" }

Property	Type	Required	Nullable	Defined by
titleTopMargin	integer	Required	cannot be null	Mermaid Config
diagramPadding	number	Optional	cannot be null	Mermaid Config
nodeLabel	Merged	Optional	cannot be null	Mermaid Config
mainBranchName	string	Optional	cannot be null	Mermaid Config
mainBranchOrder	number	Optional	cannot be null	Mermaid Config
showCommitLabel	boolean	Optional	cannot be null	Mermaid Config
showBranches	boolean	Optional	cannot be null	Mermaid Config
rotateCommitLabel	boolean	Optional	cannot be null	Mermaid Config
parallelCommits	boolean	Optional	cannot be null	Mermaid Config
arrowMarkerAbsolute	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

diagramPadding

diagramPadding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

diagramPadding Type

number

diagramPadding Default Value

The default value is:

8

nodeLabel

nodeLabel

• is optional

• Type: object (Details)

• cannot be null

• defined in: Mermaid Config

nodeLabel Type

object (Details)

all of

• Node Label

nodeLabel Default Value

The default value is:

{
  "width": 75,
  "height": 100,
  "x": -25,
  "y": 0
}

mainBranchName

mainBranchName

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

mainBranchName Type

string

mainBranchName Default Value

The default value is:

"main"

mainBranchOrder

mainBranchOrder

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

mainBranchOrder Type

number

showCommitLabel

showCommitLabel

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showCommitLabel Type

boolean

showCommitLabel Default Value

The default value is:

true

showBranches

showBranches

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showBranches Type

boolean

showBranches Default Value

The default value is:

true

rotateCommitLabel

rotateCommitLabel

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

rotateCommitLabel Type

boolean

rotateCommitLabel Default Value

The default value is:

true

parallelCommits

parallelCommits

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

parallelCommits Type

boolean

arrowMarkerAbsolute

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

arrowMarkerAbsolute

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

Definitions group NodeLabel

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/NodeLabel" }

Property	Type	Required	Nullable	Defined by
width	number	Optional	cannot be null	Mermaid Config
height	number	Optional	cannot be null	Mermaid Config
x	number	Optional	cannot be null	Mermaid Config
y	number	Optional	cannot be null	Mermaid Config

width

width

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

width Type

number

height

height

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

height Type

number

x

x

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

x Type

number

y

y

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

y Type

number

Definitions group RequirementDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/RequirementDiagramConfig" }

Property	Type	Required	Nullable	Defined by
rect_fill	string	Optional	cannot be null	Mermaid Config
text_color	string	Optional	cannot be null	Mermaid Config
rect_border_size	string	Optional	cannot be null	Mermaid Config
rect_border_color	string	Optional	cannot be null	Mermaid Config
rect_min_width	number	Optional	cannot be null	Mermaid Config
rect_min_height	number	Optional	cannot be null	Mermaid Config
fontSize	number	Optional	cannot be null	Mermaid Config
rect_padding	number	Optional	cannot be null	Mermaid Config
line_height	number	Optional	cannot be null	Mermaid Config

rect_fill

rect_fill

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

rect_fill Type

string

rect_fill Default Value

The default value is:

"#f9f9f9"

text_color

text_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

text_color Type

string

text_color Default Value

The default value is:

"#333"

rect_border_size

rect_border_size

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

rect_border_size Type

string

rect_border_size Default Value

The default value is:

"0.5px"

rect_border_color

rect_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

rect_border_color Type

string

rect_border_color Default Value

The default value is:

"#bbb"

rect_min_width

rect_min_width

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

rect_min_width Type

number

rect_min_width Default Value

The default value is:

200

rect_min_height

rect_min_height

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

rect_min_height Type

number

rect_min_height Default Value

The default value is:

200

fontSize

fontSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSize Type

number

fontSize Default Value

The default value is:

14

rect_padding

rect_padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

rect_padding Type

number

rect_padding Default Value

The default value is:

10

line_height

line_height

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

line_height Type

number

line_height Default Value

The default value is:

20

Definitions group ArchitectureDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/ArchitectureDiagramConfig" }

Property	Type	Required	Nullable	Defined by
padding	number	Required	cannot be null	Mermaid Config
iconSize	number	Required	cannot be null	Mermaid Config
fontSize	number	Required	cannot be null	Mermaid Config

padding

padding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

40

iconSize

iconSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

iconSize Type

number

iconSize Default Value

The default value is:

80

fontSize

fontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSize Type

number

fontSize Default Value

The default value is:

16

Definitions group MindmapDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/MindmapDiagramConfig" }

Property	Type	Required	Nullable	Defined by
padding	number	Required	cannot be null	Mermaid Config
maxNodeWidth	number	Required	cannot be null	Mermaid Config

padding

padding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

10

maxNodeWidth

maxNodeWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

maxNodeWidth Type

number

maxNodeWidth Default Value

The default value is:

200

Definitions group KanbanDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/KanbanDiagramConfig" }

Property	Type	Required	Nullable	Defined by
padding	number	Optional	cannot be null	Mermaid Config
sectionWidth	number	Optional	cannot be null	Mermaid Config
ticketBaseUrl	string	Optional	cannot be null	Mermaid Config

padding

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

8

sectionWidth

sectionWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

sectionWidth Type

number

sectionWidth Default Value

The default value is:

200

ticketBaseUrl

ticketBaseUrl

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

ticketBaseUrl Type

string

Definitions group PieDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/PieDiagramConfig" }

Property	Type	Required	Nullable	Defined by
textPosition	number	Optional	cannot be null	Mermaid Config

textPosition

切片标签的轴向位置从中心的零到外边缘的 1。

textPosition

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

textPosition Type

number

textPosition Constraints

maximum: the value of this number must smaller than or equal to: 1

minimum: the value of this number must greater than or equal to: 0

textPosition Default Value

The default value is:

0.75

Definitions group QuadrantChartConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/QuadrantChartConfig" }

Property	Type	Required	Nullable	Defined by
chartWidth	number	Required	cannot be null	Mermaid Config
chartHeight	number	Required	cannot be null	Mermaid Config
titleFontSize	number	Required	cannot be null	Mermaid Config
titlePadding	number	Required	cannot be null	Mermaid Config
quadrantPadding	number	Required	cannot be null	Mermaid Config
xAxisLabelPadding	number	Required	cannot be null	Mermaid Config
yAxisLabelPadding	number	Required	cannot be null	Mermaid Config
xAxisLabelFontSize	number	Required	cannot be null	Mermaid Config
yAxisLabelFontSize	number	Required	cannot be null	Mermaid Config
quadrantLabelFontSize	number	Required	cannot be null	Mermaid Config
quadrantTextTopPadding	number	Required	cannot be null	Mermaid Config
pointTextPadding	number	Required	cannot be null	Mermaid Config
pointLabelFontSize	number	Required	cannot be null	Mermaid Config
pointRadius	number	Required	cannot be null	Mermaid Config
xAxisPosition	string	Required	cannot be null	Mermaid Config
yAxisPosition	string	Required	cannot be null	Mermaid Config
quadrantInternalBorderStrokeWidth	number	Required	cannot be null	Mermaid Config
quadrantExternalBorderStrokeWidth	number	Required	cannot be null	Mermaid Config

chartWidth

图表的宽度

chartWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

chartWidth Type

number

chartWidth Constraints

minimum: the value of this number must greater than or equal to: 0

chartWidth Default Value

The default value is:

500

chartHeight

图表的高度

chartHeight

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

chartHeight Type

number

chartHeight Constraints

minimum: the value of this number must greater than or equal to: 0

chartHeight Default Value

The default value is:

500

titleFontSize

图表标题顶部和底部填充

titleFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titleFontSize Type

number

titleFontSize Constraints

minimum: the value of this number must greater than or equal to: 0

titleFontSize Default Value

The default value is:

20

titlePadding

象限正方形周围的填充

titlePadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titlePadding Type

number

titlePadding Constraints

minimum: the value of this number must greater than or equal to: 0

titlePadding Default Value

The default value is:

10

quadrantPadding

如果象限在顶部渲染，则象限标题从顶部填充

quadrantPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantPadding Type

number

quadrantPadding Constraints

minimum: the value of this number must greater than or equal to: 0

quadrantPadding Default Value

The default value is:

5

xAxisLabelPadding

x 轴标签周围的填充

xAxisLabelPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

xAxisLabelPadding Type

number

xAxisLabelPadding Constraints

minimum: the value of this number must greater than or equal to: 0

xAxisLabelPadding Default Value

The default value is:

5

yAxisLabelPadding

y 轴标签周围的填充

yAxisLabelPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

yAxisLabelPadding Type

number

yAxisLabelPadding Constraints

minimum: the value of this number must greater than or equal to: 0

yAxisLabelPadding Default Value

The default value is:

5

xAxisLabelFontSize

x 轴标签字体大小

xAxisLabelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

xAxisLabelFontSize Type

number

xAxisLabelFontSize Constraints

minimum: the value of this number must greater than or equal to: 0

xAxisLabelFontSize Default Value

The default value is:

16

yAxisLabelFontSize

y 轴标签字体大小

yAxisLabelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

yAxisLabelFontSize Type

number

yAxisLabelFontSize Constraints

minimum: the value of this number must greater than or equal to: 0

yAxisLabelFontSize Default Value

The default value is:

16

quadrantLabelFontSize

象限标题字体大小

quadrantLabelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantLabelFontSize Type

number

quadrantLabelFontSize Constraints

minimum: the value of this number must greater than or equal to: 0

quadrantLabelFontSize Default Value

The default value is:

16

quadrantTextTopPadding

如果象限在顶部渲染，则象限标题从顶部填充

quadrantTextTopPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantTextTopPadding Type

number

quadrantTextTopPadding Constraints

minimum: the value of this number must greater than or equal to: 0

quadrantTextTopPadding Default Value

The default value is:

5

pointTextPadding

点和点标签之间的填充

pointTextPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

pointTextPadding Type

number

pointTextPadding Constraints

minimum: the value of this number must greater than or equal to: 0

pointTextPadding Default Value

The default value is:

5

pointLabelFontSize

点标题字体大小

pointLabelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

pointLabelFontSize Type

number

pointLabelFontSize Constraints

minimum: the value of this number must greater than or equal to: 0

pointLabelFontSize Default Value

The default value is:

12

pointRadius

要绘制的点的半径

pointRadius

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

pointRadius Type

number

pointRadius Constraints

minimum: the value of this number must greater than or equal to: 0

pointRadius Default Value

The default value is:

5

xAxisPosition

x 轴标签的位置

xAxisPosition

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

xAxisPosition Type

string

xAxisPosition Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"top"
"bottom"

xAxisPosition Default Value

The default value is:

"top"

yAxisPosition

y 轴标签的位置

yAxisPosition

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

yAxisPosition Type

string

yAxisPosition Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"left"
"right"

yAxisPosition Default Value

The default value is:

"left"

quadrantInternalBorderStrokeWidth

象限内的框边缘的描边宽度

quadrantInternalBorderStrokeWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantInternalBorderStrokeWidth Type

number

quadrantInternalBorderStrokeWidth Constraints

minimum: the value of this number must greater than or equal to: 0

quadrantInternalBorderStrokeWidth Default Value

The default value is:

1

quadrantExternalBorderStrokeWidth

象限外的框边缘的描边宽度

quadrantExternalBorderStrokeWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantExternalBorderStrokeWidth Type

number

quadrantExternalBorderStrokeWidth Constraints

minimum: the value of this number must greater than or equal to: 0

quadrantExternalBorderStrokeWidth Default Value

The default value is:

2

Definitions group XYChartAxisConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/XYChartAxisConfig" }

Property	Type	Required	Nullable	Defined by
showLabel	boolean	Required	cannot be null	Mermaid Config
labelFontSize	number	Required	cannot be null	Mermaid Config
labelPadding	number	Required	cannot be null	Mermaid Config
showTitle	boolean	Required	cannot be null	Mermaid Config
titleFontSize	number	Required	cannot be null	Mermaid Config
titlePadding	number	Required	cannot be null	Mermaid Config
showTick	boolean	Required	cannot be null	Mermaid Config
tickLength	number	Required	cannot be null	Mermaid Config
tickWidth	number	Required	cannot be null	Mermaid Config
showAxisLine	boolean	Required	cannot be null	Mermaid Config
axisLineWidth	number	Required	cannot be null	Mermaid Config

showLabel

应显示轴标签（刻度文本）

showLabel

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showLabel Type

boolean

showLabel Default Value

The default value is:

true

labelFontSize

轴标签的字体大小（刻度文本）

labelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

labelFontSize Type

number

labelFontSize Constraints

minimum: the value of this number must greater than or equal to: 1

labelFontSize Default Value

The default value is:

14

labelPadding

轴标签（刻度文本）的顶部和底部空间

labelPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

labelPadding Type

number

labelPadding Constraints

minimum: the value of this number must greater than or equal to: 0

labelPadding Default Value

The default value is:

5

showTitle

应显示轴标题

showTitle

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showTitle Type

boolean

showTitle Default Value

The default value is:

true

titleFontSize

轴标题的字体大小

titleFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titleFontSize Type

number

titleFontSize Constraints

minimum: the value of this number must greater than or equal to: 1

titleFontSize Default Value

The default value is:

16

titlePadding

轴标题的顶部和底部空间

titlePadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titlePadding Type

number

titlePadding Constraints

minimum: the value of this number must greater than or equal to: 0

titlePadding Default Value

The default value is:

5

showTick

应显示轴刻度线

showTick

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showTick Type

boolean

showTick Default Value

The default value is:

true

tickLength

轴刻度线的长度

tickLength

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

tickLength Type

number

tickLength Constraints

minimum: the value of this number must greater than or equal to: 1

tickLength Default Value

The default value is:

5

tickWidth

轴刻度线的宽度

tickWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

tickWidth Type

number

tickWidth Constraints

minimum: the value of this number must greater than or equal to: 1

tickWidth Default Value

The default value is:

2

showAxisLine

显示跨轴线

showAxisLine

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showAxisLine Type

boolean

showAxisLine Default Value

The default value is:

true

axisLineWidth

轴线的宽度

axisLineWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

axisLineWidth Type

number

axisLineWidth Constraints

minimum: the value of this number must greater than or equal to: 1

axisLineWidth Default Value

The default value is:

2

Definitions group XYChartConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/XYChartConfig" }

Property	Type	Required	Nullable	Defined by
width	number	Required	cannot be null	Mermaid Config
height	number	Required	cannot be null	Mermaid Config
titleFontSize	number	Required	cannot be null	Mermaid Config
titlePadding	number	Required	cannot be null	Mermaid Config
showTitle	boolean	Required	cannot be null	Mermaid Config
xAxis	object	Required	cannot be null	Mermaid Config
yAxis	object	Required	cannot be null	Mermaid Config
chartOrientation	Not specified	Required	cannot be null	Mermaid Config
plotReservedSpacePercent	number	Required	cannot be null	Mermaid Config

width

图表的宽度

width

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

width Type

number

width Constraints

minimum: the value of this number must greater than or equal to: 1

width Default Value

The default value is:

700

height

图表的高度

height

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

height Type

number

height Constraints

minimum: the value of this number must greater than or equal to: 1

height Default Value

The default value is:

500

titleFontSize

图表标题的字体大小

titleFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titleFontSize Type

number

titleFontSize Constraints

minimum: the value of this number must greater than or equal to: 1

titleFontSize Default Value

The default value is:

20

titlePadding

图表标题的顶部和底部空间

titlePadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titlePadding Type

number

titlePadding Constraints

minimum: the value of this number must greater than or equal to: 0

titlePadding Default Value

The default value is:

10

showTitle

应显示图表标题

showTitle

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showTitle Type

boolean

showTitle Default Value

The default value is:

true

xAxis

此对象包含 XYChart 轴配置的配置

xAxis

• is required

• Type: object (XYChart axis config)

• cannot be null

• defined in: Mermaid Config

xAxis Type

object (XYChart axis config)

xAxis Default Value

The default value is:

{
  "$ref": "#/$defs/XYChartAxisConfig",
  "title": "XYChart axis config",
  "description": "此对象包含 XYChart 轴配置的配置",
  "type": "object",
  "unevaluatedProperties": true,
  "required": [
    "showLabel",
    "labelFontSize",
    "labelPadding",
    "showTitle",
    "titleFontSize",
    "titlePadding",
    "showTick",
    "tickLength",
    "tickWidth",
    "showAxisLine",
    "axisLineWidth"
  ],
  "properties": {
    "showLabel": {
      "description": "应显示轴标签（刻度文本）",
      "type": "boolean",
      "default": true
    },
    "labelFontSize": {
      "description": "轴标签的字体大小（刻度文本）",
      "type": "number",
      "default": 14,
      "minimum": 1
    },
    "labelPadding": {
      "description": "轴标签（刻度文本）的顶部和底部空间",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTitle": {
      "description": "应显示轴标题",
      "type": "boolean",
      "default": true
    },
    "titleFontSize": {
      "description": "轴标题的字体大小",
      "type": "number",
      "default": 16,
      "minimum": 1
    },
    "titlePadding": {
      "description": "轴标题的顶部和底部空间",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTick": {
      "description": "应显示轴刻度线",
      "type": "boolean",
      "default": true
    },
    "tickLength": {
      "description": "轴刻度线的长度",
      "type": "number",
      "default": 5,
      "minimum": 1
    },
    "tickWidth": {
      "description": "轴刻度线的宽度",
      "type": "number",
      "default": 2,
      "minimum": 1
    },
    "showAxisLine": {
      "description": "显示跨轴线",
      "type": "boolean",
      "default": true
    },
    "axisLineWidth": {
      "description": "轴线的宽度",
      "type": "number",
      "default": 2,
      "minimum": 1
    }
  }
}

yAxis

此对象包含 XYChart 轴配置的配置

yAxis

• is required

• Type: object (XYChart axis config)

• cannot be null

• defined in: Mermaid Config

yAxis Type

object (XYChart axis config)

yAxis Default Value

The default value is:

{
  "$ref": "#/$defs/XYChartAxisConfig",
  "title": "XYChart axis config",
  "description": "此对象包含 XYChart 轴配置的配置",
  "type": "object",
  "unevaluatedProperties": true,
  "required": [
    "showLabel",
    "labelFontSize",
    "labelPadding",
    "showTitle",
    "titleFontSize",
    "titlePadding",
    "showTick",
    "tickLength",
    "tickWidth",
    "showAxisLine",
    "axisLineWidth"
  ],
  "properties": {
    "showLabel": {
      "description": "应显示轴标签（刻度文本）",
      "type": "boolean",
      "default": true
    },
    "labelFontSize": {
      "description": "轴标签的字体大小（刻度文本）",
      "type": "number",
      "default": 14,
      "minimum": 1
    },
    "labelPadding": {
      "description": "轴标签（刻度文本）的顶部和底部空间",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTitle": {
      "description": "应显示轴标题",
      "type": "boolean",
      "default": true
    },
    "titleFontSize": {
      "description": "轴标题的字体大小",
      "type": "number",
      "default": 16,
      "minimum": 1
    },
    "titlePadding": {
      "description": "轴标题的顶部和底部空间",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTick": {
      "description": "应显示轴刻度线",
      "type": "boolean",
      "default": true
    },
    "tickLength": {
      "description": "轴刻度线的长度",
      "type": "number",
      "default": 5,
      "minimum": 1
    },
    "tickWidth": {
      "description": "轴刻度线的宽度",
      "type": "number",
      "default": 2,
      "minimum": 1
    },
    "showAxisLine": {
      "description": "显示跨轴线",
      "type": "boolean",
      "default": true
    },
    "axisLineWidth": {
      "description": "轴线的宽度",
      "type": "number",
      "default": 2,
      "minimum": 1
    }
  }
}

chartOrientation

如何绘制水平或垂直图形

chartOrientation

• is required

• Type: unknown

• cannot be null

• defined in: Mermaid Config

• tsType: "vertical" | "horizontal"

chartOrientation Type

unknown

chartOrientation Default Value

The default value is:

"vertical"

plotReservedSpacePercent

图表占用的空间图的最小百分比

plotReservedSpacePercent

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

plotReservedSpacePercent Type

number

plotReservedSpacePercent Constraints

minimum: the value of this number must greater than or equal to: 30

plotReservedSpacePercent Default Value

The default value is:

50

Definitions group ErDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/ErDiagramConfig" }

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
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

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

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

diagramPadding

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

diagramPadding

• is required

• 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

layoutDirection

实体布局的方向偏差

layoutDirection

• is required

• Type: string

• cannot 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

实体框的最小宽度。以像素表示。

minEntityWidth

• is required

• Type: integer

• cannot 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:

100

minEntityHeight

实体框的最小高度。以像素表示。

minEntityHeight

• is required

• Type: integer

• cannot 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:

75

entityPadding

实体框中的文本与封闭框边框之间的最小内部填充。以像素表示。

entityPadding

• is required

• Type: integer

• cannot 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:

15

stroke

框边缘和线条的描边颜色。

stroke

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

stroke Type

string

stroke Default Value

The default value is:

"gray"

fill

实体框的填充颜色

fill

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

fill Type

string

fill Default Value

The default value is:

"honeydew"

fontSize

字体大小（表示为表示像素数的整数）

fontSize

• is optional

• Type: integer

• cannot 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

Definitions group StateDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/StateDiagramConfig" }

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
nodeSpacing	integer	Optional	cannot be null	Mermaid Config
rankSpacing	integer	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

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

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

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

sizeUnit

sizeUnit

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

sizeUnit Type

number

sizeUnit Default Value

The default value is:

5

padding

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

8

textHeight

textHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

textHeight Type

number

textHeight Default Value

The default value is:

10

titleShift

titleShift

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

titleShift Type

number

titleShift Default Value

The default value is:

-15

noteMargin

noteMargin

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

noteMargin Type

number

noteMargin Default Value

The default value is:

10

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

forkWidth

forkWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

forkWidth Type

number

forkWidth Default Value

The default value is:

70

forkHeight

forkHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

forkHeight Type

number

forkHeight Default Value

The default value is:

7

miniPadding

miniPadding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

miniPadding Type

number

miniPadding Default Value

The default value is:

2

fontSizeFactor

字体大小因子，用于在通过 dagre 布局渲染之前猜测边标签的宽度。如果/当切换字体时，可能需要更新

fontSizeFactor

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSizeFactor Type

number

fontSizeFactor Default Value

The default value is:

5.02

fontSize

fontSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSize Type

number

fontSize Default Value

The default value is:

24

labelHeight

labelHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

labelHeight Type

number

labelHeight Default Value

The default value is:

16

edgeLengthFactor

edgeLengthFactor

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

edgeLengthFactor Type

string

edgeLengthFactor Default Value

The default value is:

"20"

compositTitleSize

compositTitleSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

compositTitleSize Type

number

compositTitleSize Default Value

The default value is:

35

radius

radius

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

radius Type

number

radius Default Value

The default value is:

5

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"

Definitions group ClassDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/ClassDiagramConfig" }

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

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

hideEmptyMembersBox

hideEmptyMembersBox

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

hideEmptyMembersBox Type

boolean

Definitions group JourneyDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/JourneyDiagramConfig" }

Property	Type	Required	Nullable	Defined by
diagramMarginX	integer	Required	cannot be null	Mermaid Config
diagramMarginY	integer	Required	cannot be null	Mermaid Config
leftMargin	integer	Required	cannot be null	Mermaid Config
width	integer	Required	cannot be null	Mermaid Config
height	integer	Required	cannot be null	Mermaid Config
boxMargin	integer	Required	cannot be null	Mermaid Config
boxTextMargin	integer	Required	cannot be null	Mermaid Config
noteMargin	integer	Required	cannot be null	Mermaid Config
messageMargin	integer	Required	cannot be null	Mermaid Config
messageAlign	string	Required	cannot be null	Mermaid Config
bottomMarginAdj	integer	Required	cannot be null	Mermaid Config
rightAngles	boolean	Required	cannot be null	Mermaid Config
taskFontSize	Multiple	Optional	cannot be null	Mermaid Config
taskFontFamily	string	Optional	cannot be null	Mermaid Config
taskMargin	number	Optional	cannot be null	Mermaid Config
activationWidth	number	Optional	cannot be null	Mermaid Config
textPlacement	string	Optional	cannot be null	Mermaid Config
actorColours	array	Optional	cannot be null	Mermaid Config
sectionFills	array	Optional	cannot be null	Mermaid Config
sectionColours	array	Optional	cannot be null	Mermaid Config

diagramMarginX

c4 图右侧和左侧的边距必须为正值。

diagramMarginX

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

minimum: the value of this number must greater than or equal to: 0

diagramMarginX Default Value

The default value is:

50

diagramMarginY

c4 图上方和下方的边距必须为正值。

diagramMarginY

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

minimum: the value of this number must greater than or equal to: 0

diagramMarginY Default Value

The default value is:

10

leftMargin

角色之间的边距

leftMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

leftMargin Type

integer

leftMargin Constraints

minimum: the value of this number must greater than or equal to: 0

leftMargin Default Value

The default value is:

150

width

参与者框的宽度

width

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

width Type

integer

width Constraints

minimum: the value of this number must greater than or equal to: 0

width Default Value

The default value is:

150

height

角色框的高度

height

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

height Type

integer

height Constraints

minimum: the value of this number must greater than or equal to: 0

height Default Value

The default value is:

50

boxMargin

循环框周围的边距

boxMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

minimum: the value of this number must greater than or equal to: 0

boxMargin Default Value

The default value is:

10

boxTextMargin

循环/alt/opt 框中文本周围的边距

boxTextMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxTextMargin Type

integer

boxTextMargin Constraints

minimum: the value of this number must greater than or equal to: 0

boxTextMargin Default Value

The default value is:

5

noteMargin

注释周围的边距

noteMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

noteMargin Type

integer

noteMargin Constraints

minimum: the value of this number must greater than or equal to: 0

noteMargin Default Value

The default value is:

10

messageMargin

消息之间的空间。

messageMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

messageMargin Type

integer

messageMargin Constraints

minimum: the value of this number must greater than or equal to: 0

messageMargin Default Value

The default value is:

35

messageAlign

多行消息对齐

messageAlign

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

messageAlign Type

string

messageAlign Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

"center"

bottomMarginAdj

向下延长图表的边缘。根据 css 样式，这可能需要调整。

bottomMarginAdj

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

bottomMarginAdj Type

integer

bottomMarginAdj Constraints

minimum: the value of this number must greater than or equal to: 0

bottomMarginAdj Default Value

The default value is:

1

rightAngles

弯曲箭头变为直角这将显示从同一节点开始并以直角而不是曲线开始的箭头。

rightAngles

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

rightAngles Type

boolean

taskFontSize

taskFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

taskFontSize Type

any of the following: string or number (Details)

taskFontSize Default Value

The default value is:

14

taskFontFamily

taskFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

taskFontFamily Type

string

taskFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

taskMargin

taskMargin

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

taskMargin Type

number

taskMargin Default Value

The default value is:

50

activationWidth

激活框的宽度

activationWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

activationWidth Type

number

activationWidth Default Value

The default value is:

10

textPlacement

text placement as: tspan | fo | old only text as before

textPlacement

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

textPlacement Type

string

textPlacement Default Value

The default value is:

"fo"

actorColours

actorColours

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

actorColours Type

string[]

actorColours Default Value

The default value is:

["#8FBC8F", "#7CFC00", "#00FFFF", "#20B2AA", "#B0E0E6", "#FFFFE0"]

sectionFills

sectionFills

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

sectionFills Type

string[]

sectionFills Default Value

The default value is:

["#191970", "#8B008B", "#4B0082", "#2F4F4F", "#800000", "#8B4513", "#00008B"]

sectionColours

sectionColours

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

sectionColours Type

string[]

sectionColours Default Value

The default value is:

["#fff"]

Definitions group TimelineDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/TimelineDiagramConfig" }

Property	Type	Required	Nullable	Defined by
diagramMarginX	integer	Required	cannot be null	Mermaid Config
diagramMarginY	integer	Required	cannot be null	Mermaid Config
leftMargin	integer	Required	cannot be null	Mermaid Config
width	integer	Required	cannot be null	Mermaid Config
height	integer	Required	cannot be null	Mermaid Config
padding	number	Optional	cannot be null	Mermaid Config
boxMargin	integer	Required	cannot be null	Mermaid Config
boxTextMargin	integer	Required	cannot be null	Mermaid Config
noteMargin	integer	Required	cannot be null	Mermaid Config
messageMargin	integer	Required	cannot be null	Mermaid Config
messageAlign	string	Required	cannot be null	Mermaid Config
bottomMarginAdj	integer	Required	cannot be null	Mermaid Config
rightAngles	boolean	Optional	cannot be null	Mermaid Config
taskFontSize	Multiple	Optional	cannot be null	Mermaid Config
taskFontFamily	string	Optional	cannot be null	Mermaid Config
taskMargin	number	Optional	cannot be null	Mermaid Config
activationWidth	number	Optional	cannot be null	Mermaid Config
textPlacement	string	Optional	cannot be null	Mermaid Config
actorColours	array	Optional	cannot be null	Mermaid Config
sectionFills	array	Optional	cannot be null	Mermaid Config
sectionColours	array	Optional	cannot be null	Mermaid Config
disableMulticolor	boolean	Optional	cannot be null	Mermaid Config

diagramMarginX

c4 图右侧和左侧的边距必须为正值。

diagramMarginX

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

minimum: the value of this number must greater than or equal to: 0

diagramMarginX Default Value

The default value is:

50

diagramMarginY

c4 图上方和下方的边距必须为正值。

diagramMarginY

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

minimum: the value of this number must greater than or equal to: 0

diagramMarginY Default Value

The default value is:

10

leftMargin

角色之间的边距

leftMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

leftMargin Type

integer

leftMargin Constraints

minimum: the value of this number must greater than or equal to: 0

leftMargin Default Value

The default value is:

150

width

参与者框的宽度

width

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

width Type

integer

width Constraints

minimum: the value of this number must greater than or equal to: 0

width Default Value

The default value is:

150

height

角色框的高度

height

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

height Type

integer

height Constraints

minimum: the value of this number must greater than or equal to: 0

height Default Value

The default value is:

50

padding

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

boxMargin

循环框周围的边距

boxMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

minimum: the value of this number must greater than or equal to: 0

boxMargin Default Value

The default value is:

10

boxTextMargin

循环/alt/opt 框中文本周围的边距

boxTextMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxTextMargin Type

integer

boxTextMargin Constraints

minimum: the value of this number must greater than or equal to: 0

boxTextMargin Default Value

The default value is:

5

noteMargin

注释周围的边距

noteMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

noteMargin Type

integer

noteMargin Constraints

minimum: the value of this number must greater than or equal to: 0

noteMargin Default Value

The default value is:

10

messageMargin

消息之间的空间。

messageMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

messageMargin Type

integer

messageMargin Constraints

minimum: the value of this number must greater than or equal to: 0

messageMargin Default Value

The default value is:

35

messageAlign

多行消息对齐

messageAlign

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

messageAlign Type

string

messageAlign Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

"center"

bottomMarginAdj

向下延长图表的边缘。根据 css 样式，这可能需要调整。

bottomMarginAdj

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

bottomMarginAdj Type

integer

bottomMarginAdj Constraints

minimum: the value of this number must greater than or equal to: 0

bottomMarginAdj Default Value

The default value is:

1

rightAngles

弯曲箭头变为直角这将显示从同一节点开始并以直角而不是曲线开始的箭头。

rightAngles

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

rightAngles Type

boolean

taskFontSize

taskFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

taskFontSize Type

any of the following: string or number (Details)

taskFontSize Default Value

The default value is:

14

taskFontFamily

taskFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

taskFontFamily Type

string

taskFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

taskMargin

taskMargin

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

taskMargin Type

number

taskMargin Default Value

The default value is:

50

activationWidth

激活框的宽度

activationWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

activationWidth Type

number

activationWidth Default Value

The default value is:

10

textPlacement

text placement as: tspan | fo | old only text as before

textPlacement

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

textPlacement Type

string

textPlacement Default Value

The default value is:

"fo"

actorColours

actorColours

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

actorColours Type

string[]

actorColours Default Value

The default value is:

["#8FBC8F", "#7CFC00", "#00FFFF", "#20B2AA", "#B0E0E6", "#FFFFE0"]

sectionFills

sectionFills

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

sectionFills Type

string[]

sectionFills Default Value

The default value is:

["#191970", "#8B008B", "#4B0082", "#2F4F4F", "#800000", "#8B4513", "#00008B"]

sectionColours

sectionColours

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

sectionColours Type

string[]

sectionColours Default Value

The default value is:

["#fff"]

disableMulticolor

disableMulticolor

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

disableMulticolor Type

boolean

Definitions group GanttDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/GanttDiagramConfig" }

Property	Type	Required	Nullable	Defined by
titleTopMargin	integer	Required	cannot be null	Mermaid Config
barHeight	integer	Required	cannot be null	Mermaid Config
barGap	integer	Optional	cannot be null	Mermaid Config
topPadding	integer	Required	cannot be null	Mermaid Config
rightPadding	integer	Required	cannot be null	Mermaid Config
leftPadding	integer	Required	cannot be null	Mermaid Config
gridLineStartPadding	integer	Required	cannot be null	Mermaid Config
fontSize	integer	Required	cannot be null	Mermaid Config
sectionFontSize	integer	Required	cannot be null	Mermaid Config
numberSectionStyles	integer	Required	cannot be null	Mermaid Config
axisFormat	string	Required	cannot be null	Mermaid Config
tickInterval	string	Optional	cannot be null	Mermaid Config
topAxis	boolean	Required	cannot be null	Mermaid Config
displayMode	string	Optional	cannot be null	Mermaid Config
weekday	string	Required	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

barHeight

图形中条形的高度

barHeight

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

barHeight Type

integer

barHeight Constraints

minimum: the value of this number must greater than or equal to: 0

barHeight Default Value

The default value is:

20

barGap

甘特图中不同活动之间的边距

barGap

• is optional

• Type: integer

• cannot be null

• defined in: Mermaid Config

barGap Type

integer

barGap Constraints

minimum: the value of this number must greater than or equal to: 0

barGap Default Value

The default value is:

4

topPadding

标题和甘特图之间以及轴和甘特图之间的边距。

topPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

topPadding Type

integer

topPadding Constraints

minimum: the value of this number must greater than or equal to: 0

topPadding Default Value

The default value is:

50

rightPadding

分配给活动右侧部分名称的空间

rightPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

rightPadding Type

integer

rightPadding Constraints

minimum: the value of this number must greater than or equal to: 0

rightPadding Default Value

The default value is:

75

leftPadding

分配给活动左侧部分名称的空间

leftPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

leftPadding Type

integer

leftPadding Constraints

minimum: the value of this number must greater than or equal to: 0

leftPadding Default Value

The default value is:

75

gridLineStartPadding

网格线的垂直起始位置

gridLineStartPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

gridLineStartPadding Type

integer

gridLineStartPadding Constraints

minimum: the value of this number must greater than or equal to: 0

gridLineStartPadding Default Value

The default value is:

35

fontSize

字体大小

fontSize

• is required

• Type: integer

• cannot 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:

11

sectionFontSize

各部分的字体大小

sectionFontSize

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

• tsType: string | number

sectionFontSize Type

integer

sectionFontSize Constraints

minimum: the value of this number must greater than or equal to: 0

sectionFontSize Default Value

The default value is:

11

numberSectionStyles

交替部分样式的数量

numberSectionStyles

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

numberSectionStyles Type

integer

numberSectionStyles Constraints

minimum: the value of this number must greater than or equal to: 0

numberSectionStyles Default Value

The default value is:

4

axisFormat

轴的日期/时间格式这可能需要调整以匹配你的语言环境和首选项。

axisFormat

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

axisFormat Type

string

axisFormat Default Value

The default value is:

"%Y-%m-%d"

tickInterval

轴刻度

Pattern is:

/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/;

tickInterval

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

tickInterval Type

string

tickInterval Constraints

pattern: the string must match the following regular expression:

/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/

try pattern

topAxis

设置此标志后，日期标签将添加到图表顶部

topAxis

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

topAxis Type

boolean

displayMode

控制显示模式。

displayMode

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

displayMode Type

string

displayMode Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
""
"compact"	Enables displaying multiple tasks on the same row.

weekday

基于一周的间隔应在哪一天开始

weekday

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

weekday Type

string

weekday Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"monday"
"tuesday"
"wednesday"
"thursday"
"friday"
"saturday"
"sunday"

weekday Default Value

The default value is:

"sunday"

Definitions group SequenceDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/SequenceDiagramConfig" }

Property	Type	Required	Nullable	Defined by
arrowMarkerAbsolute	boolean	Optional	cannot be null	Mermaid Config
hideUnusedParticipants	boolean	Optional	cannot be null	Mermaid Config
activationWidth	integer	Required	cannot be null	Mermaid Config
diagramMarginX	integer	Required	cannot be null	Mermaid Config
diagramMarginY	integer	Required	cannot be null	Mermaid Config
actorMargin	integer	Required	cannot be null	Mermaid Config
width	integer	Required	cannot be null	Mermaid Config
height	integer	Required	cannot be null	Mermaid Config
boxMargin	integer	Required	cannot be null	Mermaid Config
boxTextMargin	integer	Required	cannot be null	Mermaid Config
noteMargin	integer	Required	cannot be null	Mermaid Config
messageMargin	integer	Required	cannot be null	Mermaid Config
messageAlign	string	Required	cannot be null	Mermaid Config
mirrorActors	boolean	Required	cannot be null	Mermaid Config
forceMenus	boolean	Required	cannot be null	Mermaid Config
bottomMarginAdj	integer	Required	cannot be null	Mermaid Config
rightAngles	boolean	Required	cannot be null	Mermaid Config
showSequenceNumbers	boolean	Required	cannot be null	Mermaid Config
actorFontSize	Multiple	Required	cannot be null	Mermaid Config
actorFontFamily	string	Required	cannot be null	Mermaid Config
actorFontWeight	Multiple	Required	cannot be null	Mermaid Config
noteFontSize	Multiple	Required	cannot be null	Mermaid Config
noteFontFamily	string	Required	cannot be null	Mermaid Config
noteFontWeight	Multiple	Required	cannot be null	Mermaid Config
noteAlign	string	Required	cannot be null	Mermaid Config
messageFontSize	Multiple	Required	cannot be null	Mermaid Config
messageFontFamily	string	Required	cannot be null	Mermaid Config
messageFontWeight	Multiple	Required	cannot be null	Mermaid Config
wrap	boolean	Optional	cannot be null	Mermaid Config
wrapPadding	number	Optional	cannot be null	Mermaid Config
labelBoxWidth	number	Optional	cannot be null	Mermaid Config
labelBoxHeight	number	Optional	cannot be null	Mermaid Config
messageFont	Not specified	Optional	cannot be null	Mermaid Config
noteFont	Not specified	Optional	cannot be null	Mermaid Config
actorFont	Not specified	Optional	cannot be null	Mermaid Config

arrowMarkerAbsolute

arrowMarkerAbsolute

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

hideUnusedParticipants

hideUnusedParticipants

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

hideUnusedParticipants Type

boolean

activationWidth

激活矩形的宽度

activationWidth

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

activationWidth Type

integer

activationWidth Constraints

minimum: the value of this number must greater than or equal to: 0

activationWidth Default Value

The default value is:

10

diagramMarginX

时序图右侧和左侧的边距

diagramMarginX

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

minimum: the value of this number must greater than or equal to: 0

diagramMarginX Default Value

The default value is:

50

diagramMarginY

时序图上方和下方的边距

diagramMarginY

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

minimum: the value of this number must greater than or equal to: 0

diagramMarginY Default Value

The default value is:

10

actorMargin

角色之间的边距

actorMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

actorMargin Type

integer

actorMargin Constraints

minimum: the value of this number must greater than or equal to: 0

actorMargin Default Value

The default value is:

50

width

参与者框的宽度

width

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

width Type

integer

width Constraints

minimum: the value of this number must greater than or equal to: 0

width Default Value

The default value is:

150

height

角色框的高度

height

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

height Type

integer

height Constraints

minimum: the value of this number must greater than or equal to: 0

height Default Value

The default value is:

50

boxMargin

循环框周围的边距

boxMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

minimum: the value of this number must greater than or equal to: 0

boxMargin Default Value

The default value is:

10

boxTextMargin

循环/alt/opt 框中文本周围的边距

boxTextMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxTextMargin Type

integer

boxTextMargin Constraints

minimum: the value of this number must greater than or equal to: 0

boxTextMargin Default Value

The default value is:

5

noteMargin

注释周围的边距

noteMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

noteMargin Type

integer

noteMargin Constraints

minimum: the value of this number must greater than or equal to: 0

noteMargin Default Value

The default value is:

10

messageMargin

消息之间的空间。

messageMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

messageMargin Type

integer

messageMargin Constraints

minimum: the value of this number must greater than or equal to: 0

messageMargin Default Value

The default value is:

35

messageAlign

多行消息对齐

messageAlign

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

messageAlign Type

string

messageAlign Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

"center"

mirrorActors

镜像图表下方的参与者

mirrorActors

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

mirrorActors Type

boolean

mirrorActors Default Value

The default value is:

true

forceMenus

强制角色弹出菜单始终可见（以支持 E2E 测试）。

forceMenus

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

forceMenus Type

boolean

bottomMarginAdj

向下延长图表的边缘。根据 css 样式，这可能需要调整。

bottomMarginAdj

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

bottomMarginAdj Type

integer

bottomMarginAdj Constraints

minimum: the value of this number must greater than or equal to: 0

bottomMarginAdj Default Value

The default value is:

1

rightAngles

弯曲箭头变为直角这将显示从同一节点开始并以直角而不是曲线开始的箭头。

rightAngles

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

rightAngles Type

boolean

showSequenceNumbers

这将显示节点编号

showSequenceNumbers

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showSequenceNumbers Type

boolean

actorFontSize

这设置了参与者描述的字体大小

actorFontSize

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

actorFontSize Type

any of the following: string or number (Details)

actorFontSize Default Value

The default value is:

14

actorFontFamily

这设置了参与者的描述

actorFontFamily

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

actorFontFamily Type

string

actorFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

actorFontWeight

这设置了参与者描述的字体粗细

actorFontWeight

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

actorFontWeight Type

any of the following: string or number (Details)

actorFontWeight Default Value

The default value is:

400

noteFontSize

这设置了参与者附加注释的字体大小

noteFontSize

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

noteFontSize Type

any of the following: string or number (Details)

noteFontSize Default Value

The default value is:

14

noteFontFamily

这设置了参与者附加注释的字体系列

noteFontFamily

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

noteFontFamily Type

string

noteFontFamily Default Value

The default value is:

"\"trebuchet ms\", verdana, arial, sans-serif"

noteFontWeight

这设置了参与者附加注释的字体粗细

noteFontWeight

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

noteFontWeight Type

any of the following: string or number (Details)

noteFontWeight Default Value

The default value is:

400

noteAlign

这设置了参与者附加注释的文本对齐方式

noteAlign

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

noteAlign Type

string

noteAlign Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"left"
"center"
"right"

noteAlign Default Value

The default value is:

"center"

messageFontSize

这设置了参与者消息的字体大小

messageFontSize

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

messageFontSize Type

any of the following: string or number (Details)

messageFontSize Default Value

The default value is:

16

messageFontFamily

这设置了参与者消息的字体系列

messageFontFamily

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

messageFontFamily Type

string

messageFontFamily Default Value

The default value is:

"\"trebuchet ms\", verdana, arial, sans-serif"

messageFontWeight

这设置了参与者消息的字体粗细

messageFontWeight

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

messageFontWeight Type

any of the following: string or number (Details)

messageFontWeight Default Value

The default value is:

400

wrap

设置图表的自动换行状态

wrap

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

wrap Type

boolean

wrapPadding

设置图表的自动换行填充（仅限侧面）

wrapPadding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

wrapPadding Type

number

wrapPadding Default Value

The default value is:

10

labelBoxWidth

这设置了循环框的宽度（循环、alt、opt、par）

labelBoxWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

labelBoxWidth Type

number

labelBoxWidth Default Value

The default value is:

50

labelBoxHeight

这设置了循环框的高度（循环、alt、opt、par）

labelBoxHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

labelBoxHeight Type

number

labelBoxHeight Default Value

The default value is:

20

messageFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

messageFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

messageFont Type

unknown (Font Calculator)

noteFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

noteFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

noteFont Type

unknown (Font Calculator)

actorFont

返回 FontConfig 的 JavaScript 函数。默认情况下，这些函数返回适当的 *FontSize、*FontFamily、*FontWeight 值。

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

actorFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

actorFont Type

unknown (Font Calculator)

Definitions group FlowchartDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/FlowchartDiagramConfig" }

Property	Type	Required	Nullable	Defined by
titleTopMargin	integer	Required	cannot be null	Mermaid Config
subGraphTitleMargin	object	Required	cannot be null	Mermaid Config
arrowMarkerAbsolute	boolean	Optional	cannot be null	Mermaid Config
diagramPadding	integer	Required	cannot be null	Mermaid Config
htmlLabels	boolean	Required	cannot be null	Mermaid Config
nodeSpacing	integer	Required	cannot be null	Mermaid Config
rankSpacing	integer	Required	cannot be null	Mermaid Config
curve	string	Required	cannot be null	Mermaid Config
padding	number	Optional	cannot be null	Mermaid Config
defaultRenderer	string	Required	cannot be null	Mermaid Config
wrappingWidth	number	Required	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

subGraphTitleMargin

定义子图标题的顶部/底部边距

subGraphTitleMargin

• is required

• Type: object (Details)

• cannot be null

• defined in: Mermaid Config

subGraphTitleMargin Type

object (Details)

subGraphTitleMargin Default Value

The default value is:

{
  "top": 0,
  "bottom": 0
}

arrowMarkerAbsolute

arrowMarkerAbsolute

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

diagramPadding

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

diagramPadding

• is required

• 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

用于设置是否应使用 html 标记来渲染边上的标签的标志。

htmlLabels

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

htmlLabels Type

boolean

htmlLabels Default Value

The default value is:

true

nodeSpacing

定义同一级别上节点之间的间距 涉及 TB（从上到下）或 BT（从下到上）图的水平间距，以及 LR 和 RL 图的垂直间距。

nodeSpacing

• is required

• 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

nodeSpacing Default Value

The default value is:

50

rankSpacing

定义不同级别上节点之间的间距 涉及 TB（从上到下）或 BT（从下到上）图的水平间距，以及 LR 和 RL 图的垂直间距。

rankSpacing

• is required

• 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

rankSpacing Default Value

The default value is:

50

curve

定义 mermaid 如何为流程图渲染曲线。

curve

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

curve Type

string

curve Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"basis"
"linear"
"cardinal"

curve Default Value

The default value is:

"basis"

padding

表示标签和形状之间的填充 仅用于新的实验性渲染。

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

15

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"

wrappingWidth

文本换行的节点的宽度。使用 markdown 字符串时，文本会自动换行，此值设置文本在新行继续之前的最大宽度。

wrappingWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

wrappingWidth Type

number

wrappingWidth Default Value

The default value is:

200

Definitions group SankeyLinkColor

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/SankeyLinkColor" }

Property	Type	Required	Nullable	Defined by

Definitions group SankeyNodeAlignment

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/SankeyNodeAlignment" }

Property	Type	Required	Nullable	Defined by

Definitions group SankeyDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/SankeyDiagramConfig" }

Property	Type	Required	Nullable	Defined by
width	number	Optional	cannot be null	Mermaid Config
height	number	Optional	cannot be null	Mermaid Config
linkColor	Merged	Optional	cannot be null	Mermaid Config
nodeAlignment	string	Optional	cannot be null	Mermaid Config
useMaxWidth	boolean	Optional	cannot be null	Mermaid Config
showValues	boolean	Optional	cannot be null	Mermaid Config
prefix	string	Optional	cannot be null	Mermaid Config
suffix	string	Optional	cannot be null	Mermaid Config

width

width

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

width Type

number

width Default Value

The default value is:

600

height

height

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

height Type

number

height Default Value

The default value is:

400

linkColor

桑基图中链接的颜色。

linkColor

• is optional

• Type: merged type (Details)

• cannot be null

• defined in: Mermaid Config

linkColor Type

merged type (Details)

any of

• Untitled string in Mermaid Config

• Untitled string in Mermaid Config

linkColor Default Value

The default value is:

"gradient"

nodeAlignment

控制桑基图的对齐方式。

See https://github.com/d3/d3-sankey#alignments.

nodeAlignment

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

nodeAlignment Type

string

nodeAlignment Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"left"	Align all inputs to the left.
"right"	Align all outputs to the right.
"center"	Like `left`, except that nodes without any incoming links are moved as right as possible.
"justify"	Like `left`, except that nodes without any outgoing links are moved to the far right.

nodeAlignment Default Value

The default value is:

"justify"

useMaxWidth

useMaxWidth

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

useMaxWidth Type

boolean

showValues

切换以显示或隐藏值以及标题。

showValues

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showValues Type

boolean

showValues Default Value

The default value is:

true

prefix

用于值的前缀

prefix

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

prefix Type

string

suffix

用于值的后缀

suffix

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

suffix Type

string

Definitions group PacketDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/PacketDiagramConfig" }

Property	Type	Required	Nullable	Defined by
rowHeight	number	Optional	cannot be null	Mermaid Config
bitWidth	number	Optional	cannot be null	Mermaid Config
bitsPerRow	number	Optional	cannot be null	Mermaid Config
showBits	boolean	Optional	cannot be null	Mermaid Config
paddingX	number	Optional	cannot be null	Mermaid Config
paddingY	number	Optional	cannot be null	Mermaid Config

rowHeight

数据包图中每行的高度。

rowHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

rowHeight Type

number

rowHeight Constraints

minimum: the value of this number must greater than or equal to: 1

rowHeight Default Value

The default value is:

32

bitWidth

数据包图中每个位的宽度。

bitWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

bitWidth Type

number

bitWidth Constraints

minimum: the value of this number must greater than or equal to: 1

bitWidth Default Value

The default value is:

32

bitsPerRow

每行显示的位数。

bitsPerRow

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

bitsPerRow Type

number

bitsPerRow Constraints

minimum: the value of this number must greater than or equal to: 1

bitsPerRow Default Value

The default value is:

32

showBits

切换以显示或隐藏位编号。

showBits

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showBits Type

boolean

showBits Default Value

The default value is:

true

paddingX

一行中块之间的水平填充。

paddingX

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

paddingX Type

number

paddingX Constraints

minimum: the value of this number must greater than or equal to: 0

paddingX Default Value

The default value is:

5

paddingY

行之间的垂直填充。

paddingY

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

paddingY Type

number

paddingY Constraints

minimum: the value of this number must greater than or equal to: 0

paddingY Default Value

The default value is:

5

Definitions group BlockDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/BlockDiagramConfig" }

Property	Type	Required	Nullable	Defined by
padding	number	Optional	cannot be null	Mermaid Config

padding

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Constraints

minimum: the value of this number must greater than or equal to: 0

padding Default Value

The default value is:

8

Definitions group FontCalculator

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/FontCalculator" }

Property	Type	Required	Nullable	Defined by

Definitions group FontConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/FontConfig" }

Property	Type	Required	Nullable	Defined by
fontSize	Multiple	Optional	cannot be null	Mermaid Config
fontFamily	string	Optional	cannot be null	Mermaid Config
fontWeight	Multiple	Optional	cannot be null	Mermaid Config

fontSize

要使用的字体大小

fontSize

• is optional

• Type: any of the following: string or number (CSS Font Size)

• cannot be null

• defined in: Mermaid Config

fontSize Type

any of the following: string or number (CSS Font Size)

fontSize Default Value

The default value is:

14

fontFamily

The CSS font-family to use.

fontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

fontFamily Type

string

fontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

fontWeight

要使用的字体粗细。

fontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

fontWeight Type

any of the following: string or number (Details)

fontWeight Default Value

The default value is:

"normal"