時序圖配置架構

https://mermaid.dev.org.tw/schemas/config.schema.json#/$defs/SequenceDiagramConfig

包含時序圖特定配置的物件

抽象	可擴展	狀態	可識別	自訂屬性	額外屬性	存取限制	定義於
可以實例化	否	未知狀態	否	禁止	允許	無	config.schema.json*

SequenceDiagramConfig 類型

object (時序圖配置)

全部

• 基礎圖表配置

SequenceDiagramConfig 屬性

屬性	類型	必要	可為空	定義於
arrowMarkerAbsolute	布林值	選用	不可為空	Mermaid 配置
hideUnusedParticipants	布林值	選用	不可為空	Mermaid 配置
activationWidth	整數	必要	不可為空	Mermaid 配置
diagramMarginX	整數	必要	不可為空	Mermaid 配置
diagramMarginY	整數	必要	不可為空	Mermaid 配置
actorMargin	整數	必要	不可為空	Mermaid 配置
width	整數	必要	不可為空	Mermaid 配置
height	整數	必要	不可為空	Mermaid 配置
boxMargin	整數	必要	不可為空	Mermaid 配置
boxTextMargin	整數	必要	不可為空	Mermaid 配置
noteMargin	整數	必要	不可為空	Mermaid 配置
messageMargin	整數	必要	不可為空	Mermaid 配置
messageAlign	字串	必要	不可為空	Mermaid 配置
mirrorActors	布林值	必要	不可為空	Mermaid 配置
forceMenus	布林值	必要	不可為空	Mermaid 配置
bottomMarginAdj	整數	必要	不可為空	Mermaid 配置
rightAngles	布林值	必要	不可為空	Mermaid 配置
showSequenceNumbers	布林值	必要	不可為空	Mermaid 配置
actorFontSize	多個	必要	不可為空	Mermaid 配置
actorFontFamily	字串	必要	不可為空	Mermaid 配置
actorFontWeight	多個	必要	不可為空	Mermaid 配置
noteFontSize	多個	必要	不可為空	Mermaid 配置
noteFontFamily	字串	必要	不可為空	Mermaid 配置
noteFontWeight	多個	必要	不可為空	Mermaid 配置
noteAlign	字串	必要	不可為空	Mermaid 配置
messageFontSize	多個	必要	不可為空	Mermaid 配置
messageFontFamily	字串	必要	不可為空	Mermaid 配置
messageFontWeight	多個	必要	不可為空	Mermaid 配置
wrap	布林值	選用	不可為空	Mermaid 配置
wrapPadding	數字	選用	不可為空	Mermaid 配置
labelBoxWidth	數字	選用	不可為空	Mermaid 配置
labelBoxHeight	數字	選用	不可為空	Mermaid 配置
messageFont	未指定	選用	不可為空	Mermaid 配置
noteFont	未指定	選用	不可為空	Mermaid 配置
actorFont	未指定	選用	不可為空	Mermaid 配置

arrowMarkerAbsolute

arrowMarkerAbsolute

• 是選用的

• 類型：布林值

• 不可為空

• 定義於：Mermaid 配置

arrowMarkerAbsolute 類型

布林值

hideUnusedParticipants

hideUnusedParticipants

• 是選用的

• 類型：布林值

• 不可為空

• 定義於：Mermaid 配置

hideUnusedParticipants 類型

布林值

activationWidth

活動矩形的寬度

activationWidth

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

activationWidth 類型

整數

activationWidth 約束

最小值：此數字的值必須大於或等於：0

activationWidth 預設值

預設值為

10

diagramMarginX

時序圖左右兩側的邊距

diagramMarginX

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

diagramMarginX 類型

整數

diagramMarginX 約束

最小值：此數字的值必須大於或等於：0

diagramMarginX 預設值

預設值為

50

diagramMarginY

時序圖上下方的邊距

diagramMarginY

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

diagramMarginY 類型

整數

diagramMarginY 約束

最小值：此數字的值必須大於或等於：0

diagramMarginY 預設值

預設值為

10

actorMargin

參與者之間的邊距

actorMargin

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

actorMargin 類型

整數

actorMargin 約束

最小值：此數字的值必須大於或等於：0

actorMargin 預設值

預設值為

50

width

參與者方塊的寬度

width

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

width 類型

整數

width 約束

最小值：此數字的值必須大於或等於：0

width 預設值

預設值為

150

height

參與者方塊的高度

height

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

height 類型

整數

height 約束

最小值：此數字的值必須大於或等於：0

height 預設值

預設值為

50

boxMargin

迴圈方塊周圍的邊距

boxMargin

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

boxMargin 類型

整數

boxMargin 約束

最小值：此數字的值必須大於或等於：0

boxMargin 預設值

預設值為

10

boxTextMargin

迴圈/alt/opt 方塊中文字周圍的邊距

boxTextMargin

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

boxTextMargin 類型

整數

boxTextMargin 約束

最小值：此數字的值必須大於或等於：0

boxTextMargin 預設值

預設值為

5

noteMargin

筆記周圍的邊距

noteMargin

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

noteMargin 類型

整數

noteMargin 約束

最小值：此數字的值必須大於或等於：0

noteMargin 預設值

預設值為

10

messageMargin

訊息之間的空間。

messageMargin

• 是必要的

• 類型：整數

• 不可為空

• 定義於：Mermaid 配置

messageMargin 類型

整數

messageMargin 約束

最小值：此數字的值必須大於或等於：0

messageMargin 預設值

預設值為

35

messageAlign

多行訊息對齊

messageAlign

• 是必要的

• 類型: string

• 不可為空

• 定義於: Mermaid 設定

messageAlign 類型

字串

messageAlign 約束

列舉：此屬性的值必須等於下列其中一個值

值	說明
"left"
"center"
"right"

messageAlign 預設值

預設值為

"center"

mirrorActors

在圖表下方鏡像顯示參與者

mirrorActors

• 是必要的

• 類型：布林值

• 不可為空

• 定義於: Mermaid 設定

mirrorActors 類型

布林值

mirrorActors 預設值

預設值為

true

forceMenus

強制參與者彈出選單永遠可見（以支援 E2E 測試）。

forceMenus

• 是必要的

• 類型：布林值

• 不可為空

• 定義於: Mermaid 設定

forceMenus 類型

布林值

bottomMarginAdj

向下延長圖表的邊緣。

根據 CSS 樣式，可能需要調整此設定。

bottomMarginAdj

• 是必要的

• 類型：整數

• 不可為空

• 定義於: Mermaid 設定

bottomMarginAdj 類型

整數

bottomMarginAdj 約束

最小值：此數字的值必須大於或等於：0

bottomMarginAdj 預設值

預設值為

1

rightAngles

彎曲箭頭變成直角

這會將起點和終點都在同一節點的箭頭顯示為直角，而不是曲線。

rightAngles

• 是必要的

• 類型：布林值

• 不可為空

• 定義於: Mermaid 設定

rightAngles 類型

布林值

showSequenceNumbers

這會顯示節點編號

showSequenceNumbers

• 是必要的

• 類型：布林值

• 不可為空

• 定義於: Mermaid 設定

showSequenceNumbers 類型

布林值

actorFontSize

這會設定參與者描述的字體大小

actorFontSize

• 是必要的

• 類型：下列任一類型：string 或 number (詳細資訊)

• 不可為空

• 定義於: Mermaid 設定

actorFontSize 類型

下列任一類型：string 或 number (詳細資訊)

actorFontSize 預設值

預設值為

14

actorFontFamily

這會設定參與者描述的字體系列

actorFontFamily

• 是必要的

• 類型: string

• 不可為空

• 定義於: Mermaid 設定

actorFontFamily 類型

字串

actorFontFamily 預設值

預設值為

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

actorFontWeight

這會設定參與者描述的字體粗細

actorFontWeight

• 是必要的

• 類型：下列任一類型：string 或 number (詳細資訊)

• 不可為空

• 定義於: Mermaid 設定

actorFontWeight 類型

下列任一類型：string 或 number (詳細資訊)

actorFontWeight 預設值

預設值為

400

noteFontSize

這會設定參與者附加註解的字體大小

noteFontSize

• 是必要的

• 類型：下列任一類型：string 或 number (詳細資訊)

• 不可為空

• 定義於: Mermaid 設定

noteFontSize 類型

下列任一類型：string 或 number (詳細資訊)

noteFontSize 預設值

預設值為

14

noteFontFamily

這會設定參與者附加註解的字體系列

noteFontFamily

• 是必要的

• 類型: string

• 不可為空

• 定義於: Mermaid 設定

noteFontFamily 類型

字串

noteFontFamily 預設值

預設值為

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

noteFontWeight

這會設定參與者附加註解的字體粗細

noteFontWeight

• 是必要的

• 類型：下列任一類型：string 或 number (詳細資訊)

• 不可為空

• 定義於: Mermaid 設定

noteFontWeight 類型

下列任一類型：string 或 number (詳細資訊)

noteFontWeight 預設值

預設值為

400

noteAlign

這會設定參與者附加註解的文字對齊方式

noteAlign

• 是必要的

• 類型: string

• 不可為空

• 定義於: Mermaid 設定

noteAlign 類型

字串

noteAlign 約束

列舉：此屬性的值必須等於下列其中一個值

值	說明
"left"
"center"
"right"

noteAlign 預設值

預設值為

"center"

messageFontSize

這會設定參與者訊息的字體大小

messageFontSize

• 是必要的

• 類型：下列任一類型：string 或 number (詳細資訊)

• 不可為空

• 定義於: Mermaid 設定

messageFontSize 類型

下列任一類型：string 或 number (詳細資訊)

messageFontSize 預設值

預設值為

16

messageFontFamily

這會設定參與者訊息的字體系列

messageFontFamily

• 是必要的

• 類型: string

• 不可為空

• 定義於: Mermaid 設定

messageFontFamily 類型

字串

messageFontFamily 預設值

預設值為

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

messageFontWeight

這會設定參與者訊息的字體粗細

messageFontWeight

• 是必要的

• 類型：下列任一類型：string 或 number (詳細資訊)

• 不可為空

• 定義於: Mermaid 設定

messageFontWeight 類型

下列任一類型：string 或 number (詳細資訊)

messageFontWeight 預設值

預設值為

400

wrap

這會設定圖表的自動換行狀態

wrap

• 是選用的

• 類型：布林值

• 不可為空

• 定義於: Mermaid 設定

wrap 類型

布林值

wrapPadding

這會設定圖表的自動換行邊距（僅限兩側）

wrapPadding

• 是選用的

• 類型: number

• 不可為空

• 定義於: Mermaid 設定

wrapPadding 類型

數字

wrapPadding 預設值

預設值為

10

labelBoxWidth

這會設定迴圈框（loop、alt、opt、par）的寬度

labelBoxWidth

• 是選用的

• 類型: number

• 不可為空

• 定義於: Mermaid 設定

labelBoxWidth 類型

數字

labelBoxWidth 預設值

預設值為

50

labelBoxHeight

設定循環框（loop、alt、opt、par）的高度

labelBoxHeight

• 是選用的

• 類型: number

• 不可為空

• 定義於：Mermaid 設定

labelBoxHeight 類型

數字

labelBoxHeight 預設值

預設值為

20

messageFont

返回 FontConfig 的 JavaScript 函數。

預設情況下，這些會返回適當的 *FontSize、*FontFamily、*FontWeight 值。

例如，名為 boundaryFont 的字體計算器可以定義為

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

messageFont

• 是選用的

• 類型：未知（字體計算器）

• 不可為空

• 定義於：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

• 是選用的

• 類型：未知（字體計算器）

• 不可為空

• 定義於：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

• 是選用的

• 類型：未知（字體計算器）

• 不可為空

• 定義於：Mermaid 設定

• tsType: () => Partial<FontConfig>

actorFont 類型

未知（字體計算器）