跳至內容

旅程圖配置綱要

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

包含旅程圖特定配置的物件

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

JourneyDiagramConfig 類型

object (旅程圖配置)

全部

JourneyDiagramConfig 屬性

屬性類型必要可為空定義者
diagramMarginX整數必要不可為空Mermaid 設定
diagramMarginY整數必要不可為空Mermaid 設定
leftMargin整數必要不可為空Mermaid 設定
width整數必要不可為空Mermaid 設定
height整數必要不可為空Mermaid 設定
boxMargin整數必要不可為空Mermaid 設定
boxTextMargin整數必要不可為空Mermaid 設定
noteMargin整數必要不可為空Mermaid 設定
messageMargin整數必要不可為空Mermaid 設定
messageAlign字串必要不可為空Mermaid 設定
bottomMarginAdj整數必要不可為空Mermaid 設定
rightAngles布林值必要不可為空Mermaid 設定
taskFontSize多個選填不可為空Mermaid 設定
taskFontFamily字串選填不可為空Mermaid 設定
taskMargin數字選填不可為空Mermaid 設定
activationWidth數字選填不可為空Mermaid 設定
textPlacement字串選填不可為空Mermaid 設定
actorColours陣列選填不可為空Mermaid 設定
sectionFills陣列選填不可為空Mermaid 設定
sectionColours陣列選填不可為空Mermaid 設定

diagramMarginX

C4 圖表左右的邊距,必須為正值。

diagramMarginX

diagramMarginX 類型

整數

diagramMarginX 約束

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

diagramMarginX 預設值

預設值為

json
50

diagramMarginY

C4 圖表上方和下方的邊距,必須為正值。

diagramMarginY

diagramMarginY 類型

整數

diagramMarginY 約束

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

diagramMarginY 預設值

預設值為

json
10

leftMargin

參與者之間的邊距

leftMargin

leftMargin 類型

整數

leftMargin 約束

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

leftMargin 預設值

預設值為

json
150

width

參與者方塊的寬度

width

width 類型

整數

width 約束

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

width 預設值

預設值為

json
150

height

參與者方塊的高度

height

height 類型

整數

height 約束

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

height 預設值

預設值為

json
50

boxMargin

迴圈方塊周圍的邊距

boxMargin

boxMargin 類型

整數

boxMargin 約束

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

boxMargin 預設值

預設值為

json
10

boxTextMargin

迴圈/替代/選項方塊中文字周圍的邊距

boxTextMargin

boxTextMargin 類型

整數

boxTextMargin 約束

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

boxTextMargin 預設值

預設值為

json
5

noteMargin

筆記周圍的邊距

noteMargin

noteMargin 類型

整數

noteMargin 約束

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

noteMargin 預設值

預設值為

json
10

messageMargin

訊息之間的間距。

messageMargin

messageMargin 類型

整數

messageMargin 約束

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

messageMargin 預設值

預設值為

json
35

messageAlign

多行訊息對齊方式

messageAlign

messageAlign 類型

字串

messageAlign 約束

列舉:此屬性的值必須等於下列值之一

說明
"left"
"center"
"right"

messageAlign 預設值

預設值為

json
"center"

bottomMarginAdj

向下延伸圖表的邊緣。

根據 CSS 樣式,可能需要進行調整。

bottomMarginAdj

bottomMarginAdj 類型

整數

bottomMarginAdj 約束

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

bottomMarginAdj 預設值

預設值為

json
1

rightAngles

彎曲箭頭變成直角

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

rightAngles

rightAngles 類型

布林值

taskFontSize

taskFontSize

taskFontSize 類型

以下任一:stringnumber (詳細資訊)

taskFontSize 預設值

預設值為

json
14

taskFontFamily

taskFontFamily

taskFontFamily 類型

字串

taskFontFamily 預設值

預設值為

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

taskMargin

taskMargin

taskMargin 類型

數字

taskMargin 預設值

預設值為

json
50

activationWidth

活動方塊的寬度

activationWidth

activationWidth 類型

數字

activationWidth 預設值

預設值為

json
10

textPlacement

文字放置方式:tspan | fo | 僅舊有文字

textPlacement

textPlacement 類型

字串

textPlacement 預設值

預設值為

json
"fo"

actorColours

actorColours

  • 為選填項目

  • 類型:string[]

  • 不可為空

  • 定義於:Mermaid 設定

actorColours 類型

string[]

actorColours 預設值

預設值為

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

sectionFills

sectionFills

  • 為選填項目

  • 類型:string[]

  • 不可為空

  • 定義於:Mermaid 設定

sectionFills 類型

string[]

sectionFills 預設值

預設值為

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

sectionColours

sectionColours

  • 為選填項目

  • 類型:string[]

  • 不可為空

  • 定義於:Mermaid 設定

sectionColours 類型

string[]

sectionColours 預設值

預設值為

json
["#fff"]