流程圖配置綱要
https://mermaid.dev.org.tw/schemas/config.schema.json#/$defs/FlowchartDiagramConfig
包含流程圖特定配置的物件
抽象 | 可擴展 | 狀態 | 可識別 | 自訂屬性 | 額外屬性 | 存取限制 | 定義於 |
---|---|---|---|---|---|---|---|
可以實例化 | 否 | 未知狀態 | 否 | 禁止 | 允許 | 無 | config.schema.json* |
FlowchartDiagramConfig 類型
物件
(流程圖配置)
全部
FlowchartDiagramConfig 屬性
屬性 | 類型 | 必要 | 可為空值 | 定義者 |
---|---|---|---|---|
titleTopMargin | 整數 | 必要 | 不可為空值 | Mermaid 配置 |
subGraphTitleMargin | 物件 | 必要 | 不可為空值 | Mermaid 配置 |
arrowMarkerAbsolute | 布林值 | 選用 | 不可為空值 | Mermaid 配置 |
diagramPadding | 整數 | 必要 | 不可為空值 | Mermaid 配置 |
htmlLabels | 布林值 | 必要 | 不可為空值 | Mermaid 配置 |
nodeSpacing | 整數 | 必要 | 不可為空值 | Mermaid 配置 |
rankSpacing | 整數 | 必要 | 不可為空值 | Mermaid 配置 |
curve | 字串 | 必要 | 不可為空值 | Mermaid 配置 |
padding | 數字 | 選用 | 不可為空值 | Mermaid 配置 |
defaultRenderer | 字串 | 必要 | 不可為空值 | Mermaid 配置 |
wrappingWidth | 數字 | 必要 | 不可為空值 | Mermaid 配置 |
titleTopMargin
圖表上方文字的頂部邊距
titleTopMargin
為必要
類型:
整數
不可為空值
定義於:Mermaid 配置
titleTopMargin 類型
整數
titleTopMargin 約束
最小值:此數字的值必須大於或等於:0
titleTopMargin 預設值
預設值為
25
subGraphTitleMargin
定義子圖標題的頂部/底部邊距
subGraphTitleMargin
為必要
類型:
物件
(詳細資料)不可為空值
定義於:Mermaid 配置
subGraphTitleMargin 類型
物件
(詳細資料)
subGraphTitleMargin 預設值
預設值為
{
"top": 0,
"bottom": 0
}
arrowMarkerAbsolute
arrowMarkerAbsolute
為選用
類型:
布林值
不可為空值
定義於:Mermaid 配置
arrowMarkerAbsolute 類型
布林值
diagramPadding
整個圖表周圍的邊距量,以便嵌入的圖表具有邊界,以像素表示。
diagramPadding
為必要
類型:
整數
不可為空值
定義於:Mermaid 配置
diagramPadding 類型
整數
diagramPadding 約束
最小值:此數字的值必須大於或等於:0
diagramPadding 預設值
預設值為
20
htmlLabels
用於設定是否應使用 HTML 標籤來呈現邊緣上的標籤的旗標。
htmlLabels
為必要
類型:
布林值
不可為空值
定義於:Mermaid 配置
htmlLabels 類型
布林值
htmlLabels 預設值
預設值為
true
nodeSpacing
定義同一層級上節點之間的間距
適用於 TB(由上到下)或 BT(由下到上)圖形的水平間距,以及 LR 和 RL 圖形的垂直間距。
nodeSpacing
為必要
類型:
整數
不可為空值
定義於:Mermaid 配置
nodeSpacing 類型
整數
nodeSpacing 約束
最小值:此數字的值必須大於或等於:0
nodeSpacing 預設值
預設值為
50
rankSpacing
定義不同層級上節點之間的間距
適用於 TB(由上到下)或 BT(由下到上)圖形的水平間距,以及 LR 和 RL 圖形的垂直間距。
rankSpacing
為必要
類型:
整數
不可為空值
定義於:Mermaid 配置
rankSpacing 類型
整數
rankSpacing 約束
最小值:此數字的值必須大於或等於:0
rankSpacing 預設值
預設值為
50
curve
定義 Mermaid 如何為流程圖呈現曲線。
curve
為必要
類型:
字串
不可為空值
定義於:Mermaid 配置
curve 類型
字串
curve 約束
列舉:此屬性的值必須等於下列其中一個值
值 | 說明 |
---|---|
"basis" | |
"linear" | |
"cardinal" |
curve 預設值
預設值為
"basis"
padding
表示標籤與形狀之間的邊距
僅在新實驗性渲染中使用。
padding
為選用
類型:
數字
不可為空值
定義於:Mermaid 配置
padding 類型
數字
padding 預設值
預設值為
15
defaultRenderer
決定用於渲染的渲染引擎。
defaultRenderer
為必要
類型:
字串
不可為空值
定義於:Mermaid 配置
defaultRenderer 類型
字串
defaultRenderer 約束
列舉:此屬性的值必須等於下列其中一個值
值 | 說明 |
---|---|
"dagre-d3" | [dagre-d3-es](https://www.npmjs.com/package/dagre-d3-es) 函式庫。 |
"dagre-wrapper" | 在 Mermaid 中實作的 Dagre 包裝函式 |
"elk" | 使用 [elkjs](https://github.com/kieler/elkjs) 進行配置 |
defaultRenderer 預設值
預設值為
"dagre-wrapper"
wrappingWidth
文字會換行的節點寬度。
當使用 Markdown 字串時,文字會自動換行,此值設定文字在新行繼續之前的最大寬度。
wrappingWidth
為必要
類型:
數字
不可為空值
定義於:Mermaid 配置
wrappingWidth 類型
數字
wrappingWidth 預設值
預設值為
200