时序图配置模式

https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/SequenceDiagramConfig

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

抽象	可扩展	状态	可识别	自定义属性	其他属性	访问限制	定义位置
可以实例化	否	未知状态	否	禁止	允许	无	config.schema.json*

SequenceDiagramConfig 类型

object (时序图配置)

所有

• 基本图表配置

SequenceDiagramConfig 属性

属性	类型	必需	可空	定义来源
arrowMarkerAbsolute	boolean	可选	不可为 null	Mermaid 配置
hideUnusedParticipants	boolean	可选	不可为 null	Mermaid 配置
activationWidth	integer	必需	不可为 null	Mermaid 配置
diagramMarginX	integer	必需	不可为 null	Mermaid 配置
diagramMarginY	integer	必需	不可为 null	Mermaid 配置
actorMargin	integer	必需	不可为 null	Mermaid 配置
width	integer	必需	不可为 null	Mermaid 配置
height	integer	必需	不可为 null	Mermaid 配置
boxMargin	integer	必需	不可为 null	Mermaid 配置
boxTextMargin	integer	必需	不可为 null	Mermaid 配置
noteMargin	integer	必需	不可为 null	Mermaid 配置
messageMargin	integer	必需	不可为 null	Mermaid 配置
messageAlign	string	必需	不可为 null	Mermaid 配置
mirrorActors	boolean	必需	不可为 null	Mermaid 配置
forceMenus	boolean	必需	不可为 null	Mermaid 配置
bottomMarginAdj	integer	必需	不可为 null	Mermaid 配置
rightAngles	boolean	必需	不可为 null	Mermaid 配置
showSequenceNumbers	boolean	必需	不可为 null	Mermaid 配置
actorFontSize	多重	必需	不可为 null	Mermaid 配置
actorFontFamily	string	必需	不可为 null	Mermaid 配置
actorFontWeight	多重	必需	不可为 null	Mermaid 配置
noteFontSize	多重	必需	不可为 null	Mermaid 配置
noteFontFamily	string	必需	不可为 null	Mermaid 配置
noteFontWeight	多重	必需	不可为 null	Mermaid 配置
noteAlign	string	必需	不可为 null	Mermaid 配置
messageFontSize	多重	必需	不可为 null	Mermaid 配置
messageFontFamily	string	必需	不可为 null	Mermaid 配置
messageFontWeight	多重	必需	不可为 null	Mermaid 配置
wrap	boolean	可选	不可为 null	Mermaid 配置
wrapPadding	number	可选	不可为 null	Mermaid 配置
labelBoxWidth	number	可选	不可为 null	Mermaid 配置
labelBoxHeight	number	可选	不可为 null	Mermaid 配置
messageFont	未指定	可选	不可为 null	Mermaid 配置
noteFont	未指定	可选	不可为 null	Mermaid 配置
actorFont	未指定	可选	不可为 null	Mermaid 配置

arrowMarkerAbsolute

arrowMarkerAbsolute

• 是可选的

• 类型: boolean

• 不可为 null

• 定义位置: Mermaid 配置

arrowMarkerAbsolute 类型

boolean

hideUnusedParticipants

hideUnusedParticipants

• 是可选的

• 类型: boolean

• 不可为 null

• 定义位置: Mermaid 配置

hideUnusedParticipants 类型

boolean

activationWidth

激活矩形的宽度

activationWidth

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

activationWidth 类型

integer

activationWidth 约束

最小值: 此数字的值必须大于或等于: 0

activationWidth 默认值

默认值为

10

diagramMarginX

时序图左右的边距

diagramMarginX

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

diagramMarginX 类型

integer

diagramMarginX 约束

最小值: 此数字的值必须大于或等于: 0

diagramMarginX 默认值

默认值为

50

diagramMarginY

时序图上下的边距

diagramMarginY

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

diagramMarginY 类型

integer

diagramMarginY 约束

最小值: 此数字的值必须大于或等于: 0

diagramMarginY 默认值

默认值为

10

actorMargin

参与者之间的边距

actorMargin

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

actorMargin 类型

integer

actorMargin 约束

最小值: 此数字的值必须大于或等于: 0

actorMargin 默认值

默认值为

50

width

参与者框的宽度

width

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

width 类型

integer

width 约束

最小值: 此数字的值必须大于或等于: 0

width 默认值

默认值为

150

height

参与者框的高度

height

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

height 类型

integer

height 约束

最小值: 此数字的值必须大于或等于: 0

height 默认值

默认值为

50

boxMargin

循环框周围的边距

boxMargin

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

boxMargin 类型

integer

boxMargin 约束

最小值: 此数字的值必须大于或等于: 0

boxMargin 默认值

默认值为

10

boxTextMargin

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

boxTextMargin

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

boxTextMargin 类型

integer

boxTextMargin 约束

最小值: 此数字的值必须大于或等于: 0

boxTextMargin 默认值

默认值为

5

noteMargin

笔记周围的边距

noteMargin

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

noteMargin 类型

integer

noteMargin 约束

最小值: 此数字的值必须大于或等于: 0

noteMargin 默认值

默认值为

10

messageMargin

消息之间的间距。

messageMargin

• 是必需的

• 类型: integer

• 不可为 null

• 定义位置: Mermaid 配置

messageMargin 类型

integer

messageMargin 约束

最小值: 此数字的值必须大于或等于: 0

messageMargin 默认值

默认值为

35

messageAlign

多行消息对齐方式

messageAlign

• 是必需的

• 类型: string

• 不可为 null

• 定义于：Mermaid 配置

messageAlign 类型

string

messageAlign 约束

枚举：此属性的值必须等于以下值之一

值	解释
"left"
"center"
"right"

messageAlign 默认值

默认值为

"center"

mirrorActors

在图表下方镜像参与者

mirrorActors

• 是必需的

• 类型: boolean

• 不可为 null

• 定义于：Mermaid 配置

mirrorActors 类型

boolean

mirrorActors 默认值

默认值为

true

forceMenus

强制参与者弹出菜单始终可见（以支持 E2E 测试）。

forceMenus

• 是必需的

• 类型: boolean

• 不可为 null

• 定义于：Mermaid 配置

forceMenus 类型

boolean

bottomMarginAdj

延长图表的底部边缘。

根据 CSS 样式，这可能需要调整。

bottomMarginAdj

• 是必需的

• 类型: integer

• 不可为 null

• 定义于：Mermaid 配置

bottomMarginAdj 类型

integer

bottomMarginAdj 约束

最小值: 此数字的值必须大于或等于: 0

bottomMarginAdj 默认值

默认值为

1

rightAngles

弯曲箭头变为直角

这将显示从同一节点开始和结束的箭头作为直角，而不是曲线。

rightAngles

• 是必需的

• 类型: boolean

• 不可为 null

• 定义于：Mermaid 配置

rightAngles 类型

boolean

showSequenceNumbers

这将显示节点编号

showSequenceNumbers

• 是必需的

• 类型: boolean

• 不可为 null

• 定义于：Mermaid 配置

showSequenceNumbers 类型

boolean

actorFontSize

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

actorFontSize

• 是必需的

• 类型：以下任一：string 或 number (详情)

• 不可为 null

• 定义于：Mermaid 配置

actorFontSize 类型

以下任一：string 或 number (详情)

actorFontSize 默认值

默认值为

14

actorFontFamily

这设置参与者描述的字体系列

actorFontFamily

• 是必需的

• 类型: string

• 不可为 null

• 定义于：Mermaid 配置

actorFontFamily 类型

string

actorFontFamily 默认值

默认值为

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

actorFontWeight

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

actorFontWeight

• 是必需的

• 类型：以下任一：string 或 number (详情)

• 不可为 null

• 定义于：Mermaid 配置

actorFontWeight 类型

以下任一：string 或 number (详情)

actorFontWeight 默认值

默认值为

400

noteFontSize

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

noteFontSize

• 是必需的

• 类型：以下任一：string 或 number (详情)

• 不可为 null

• 定义于：Mermaid 配置

noteFontSize 类型

以下任一：string 或 number (详情)

noteFontSize 默认值

默认值为

14

noteFontFamily

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

noteFontFamily

• 是必需的

• 类型: string

• 不可为 null

• 定义于：Mermaid 配置

noteFontFamily 类型

string

noteFontFamily 默认值

默认值为

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

noteFontWeight

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

noteFontWeight

• 是必需的

• 类型：以下任一：string 或 number (详情)

• 不可为 null

• 定义于：Mermaid 配置

noteFontWeight 类型

以下任一：string 或 number (详情)

noteFontWeight 默认值

默认值为

400

noteAlign

这设置参与者附加的备注的文本对齐

noteAlign

• 是必需的

• 类型: string

• 不可为 null

• 定义于：Mermaid 配置

noteAlign 类型

string

noteAlign 约束

枚举：此属性的值必须等于以下值之一

值	解释
"left"
"center"
"right"

noteAlign 默认值

默认值为

"center"

messageFontSize

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

messageFontSize

• 是必需的

• 类型：以下任一：string 或 number (详情)

• 不可为 null

• 定义于：Mermaid 配置

messageFontSize 类型

以下任一：string 或 number (详情)

messageFontSize 默认值

默认值为

16

messageFontFamily

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

messageFontFamily

• 是必需的

• 类型: string

• 不可为 null

• 定义于：Mermaid 配置

messageFontFamily 类型

string

messageFontFamily 默认值

默认值为

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

messageFontWeight

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

messageFontWeight

• 是必需的

• 类型：以下任一：string 或 number (详情)

• 不可为 null

• 定义于：Mermaid 配置

messageFontWeight 类型

以下任一：string 或 number (详情)

messageFontWeight 默认值

默认值为

400

wrap

这设置图表的自动换行状态

wrap

• 是可选的

• 类型: boolean

• 不可为 null

• 定义于：Mermaid 配置

wrap 类型

boolean

wrapPadding

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

wrapPadding

• 是可选的

• 类型：number

• 不可为 null

• 定义于：Mermaid 配置

wrapPadding 类型

number

wrapPadding 默认值

默认值为

10

labelBoxWidth

这设置循环框的宽度（循环、备选、可选、并行）

labelBoxWidth

• 是可选的

• 类型：number

• 不可为 null

• 定义于：Mermaid 配置

labelBoxWidth 类型

number

labelBoxWidth 默认值

默认值为

50

labelBoxHeight

这设置循环框的高度（循环、备选、可选、并行）

labelBoxHeight

• 是可选的

• 类型：number

• 不可为 null

• 定义于：Mermaid 配置

labelBoxHeight 类型

number

labelBoxHeight 默认值

默认值为

20

messageFont

返回 FontConfig 的 JavaScript 函数。

默认情况下，这些函数返回相应的 *FontSize、*FontFamily 和 *FontWeight 值。

例如，名为 boundaryFont 的字体计算器可以定义为

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

messageFont

• 是可选的

• 类型：未知 (字体计算器)

• 不可为 null

• 定义于：Mermaid 配置

• tsType：() => Partial<FontConfig>

messageFont 类型

未知 (字体计算器)

noteFont

返回 FontConfig 的 JavaScript 函数。

默认情况下，这些函数返回相应的 *FontSize、*FontFamily 和 *FontWeight 值。

例如，名为 boundaryFont 的字体计算器可以定义为

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

noteFont

• 是可选的

• 类型：未知 (字体计算器)

• 不可为 null

• 定义于：Mermaid 配置

• tsType：() => Partial<FontConfig>

noteFont 类型

未知 (字体计算器)

actorFont

返回 FontConfig 的 JavaScript 函数。

默认情况下，这些函数返回相应的 *FontSize、*FontFamily 和 *FontWeight 值。

例如，名为 boundaryFont 的字体计算器可以定义为

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

actorFont

• 是可选的

• 类型：未知 (字体计算器)

• 不可为 null

• 定义于：Mermaid 配置

• tsType：() => Partial<FontConfig>

actorFont 类型

未知 (字体计算器)