旅程圖配置綱要
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
為必要項
類型:
整數
不可為空
定義於:Mermaid 設定
diagramMarginX 類型
整數
diagramMarginX 約束
最小值:此數字的值必須大於或等於:0
diagramMarginX 預設值
預設值為
50
diagramMarginY
C4 圖表上方和下方的邊距,必須為正值。
diagramMarginY
為必要項
類型:
整數
不可為空
定義於:Mermaid 設定
diagramMarginY 類型
整數
diagramMarginY 約束
最小值:此數字的值必須大於或等於:0
diagramMarginY 預設值
預設值為
10
leftMargin
參與者之間的邊距
leftMargin
為必要項
類型:
整數
不可為空
定義於:Mermaid 設定
leftMargin 類型
整數
leftMargin 約束
最小值:此數字的值必須大於或等於:0
leftMargin 預設值
預設值為
150
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
迴圈/替代/選項方塊中文字周圍的邊距
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
為必要項
類型:
字串
不可為空
定義於:Mermaid 設定
messageAlign 類型
字串
messageAlign 約束
列舉:此屬性的值必須等於下列值之一
值 | 說明 |
---|---|
"left" | |
"center" | |
"right" |
messageAlign 預設值
預設值為
"center"
bottomMarginAdj
向下延伸圖表的邊緣。
根據 CSS 樣式,可能需要進行調整。
bottomMarginAdj
為必要項
類型:
整數
不可為空
定義於:Mermaid 設定
bottomMarginAdj 類型
整數
bottomMarginAdj 約束
最小值:此數字的值必須大於或等於:0
bottomMarginAdj 預設值
預設值為
1
rightAngles
彎曲箭頭變成直角
這會將起點和終點在同一個節點的箭頭顯示為直角,而不是曲線。
rightAngles
為必要項
類型:
boolean
不可為空
定義於:Mermaid 設定
rightAngles 類型
布林值
taskFontSize
taskFontSize
為選填項目
類型:以下任一:
string
或number
(詳細資訊)不可為空
定義於:Mermaid 設定
taskFontSize 類型
以下任一:string
或 number
(詳細資訊)
taskFontSize 預設值
預設值為
14
taskFontFamily
taskFontFamily
為選填項目
類型:
字串
不可為空
定義於:Mermaid 設定
taskFontFamily 類型
字串
taskFontFamily 預設值
預設值為
"\"Open Sans\", sans-serif"
taskMargin
taskMargin
為選填項目
類型:
number
不可為空
定義於:Mermaid 設定
taskMargin 類型
數字
taskMargin 預設值
預設值為
50
activationWidth
活動方塊的寬度
activationWidth
為選填項目
類型:
number
不可為空
定義於:Mermaid 設定
activationWidth 類型
數字
activationWidth 預設值
預設值為
10
textPlacement
文字放置方式:tspan | fo | 僅舊有文字
textPlacement
為選填項目
類型:
字串
不可為空
定義於:Mermaid 設定
textPlacement 類型
字串
textPlacement 預設值
預設值為
"fo"
actorColours
actorColours
為選填項目
類型:
string[]
不可為空
定義於:Mermaid 設定
actorColours 類型
string[]
actorColours 預設值
預設值為
["#8FBC8F", "#7CFC00", "#00FFFF", "#20B2AA", "#B0E0E6", "#FFFFE0"]
sectionFills
sectionFills
為選填項目
類型:
string[]
不可為空
定義於:Mermaid 設定
sectionFills 類型
string[]
sectionFills 預設值
預設值為
["#191970", "#8B008B", "#4B0082", "#2F4F4F", "#800000", "#8B4513", "#00008B"]
sectionColours
sectionColours
為選填項目
類型:
string[]
不可為空
定義於:Mermaid 設定
sectionColours 類型
string[]
sectionColours 預設值
預設值為
["#fff"]