跳至內容

流程圖配置綱要

txt
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

titleTopMargin 類型

整數

titleTopMargin 約束

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

titleTopMargin 預設值

預設值為

json
25

subGraphTitleMargin

定義子圖標題的頂部/底部邊距

subGraphTitleMargin

subGraphTitleMargin 類型

物件 (詳細資料)

subGraphTitleMargin 預設值

預設值為

json
{
  "top": 0,
  "bottom": 0
}

arrowMarkerAbsolute

arrowMarkerAbsolute

arrowMarkerAbsolute 類型

布林值

diagramPadding

整個圖表周圍的邊距量,以便嵌入的圖表具有邊界,以像素表示。

diagramPadding

diagramPadding 類型

整數

diagramPadding 約束

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

diagramPadding 預設值

預設值為

json
20

htmlLabels

用於設定是否應使用 HTML 標籤來呈現邊緣上的標籤的旗標。

htmlLabels

htmlLabels 類型

布林值

htmlLabels 預設值

預設值為

json
true

nodeSpacing

定義同一層級上節點之間的間距

適用於 TB(由上到下)或 BT(由下到上)圖形的水平間距,以及 LR 和 RL 圖形的垂直間距。

nodeSpacing

nodeSpacing 類型

整數

nodeSpacing 約束

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

nodeSpacing 預設值

預設值為

json
50

rankSpacing

定義不同層級上節點之間的間距

適用於 TB(由上到下)或 BT(由下到上)圖形的水平間距,以及 LR 和 RL 圖形的垂直間距。

rankSpacing

rankSpacing 類型

整數

rankSpacing 約束

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

rankSpacing 預設值

預設值為

json
50

curve

定義 Mermaid 如何為流程圖呈現曲線。

curve

curve 類型

字串

curve 約束

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

說明
"basis"
"linear"
"cardinal"

curve 預設值

預設值為

json
"basis"

padding

表示標籤與形狀之間的邊距

僅在新實驗性渲染中使用。

padding

padding 類型

數字

padding 預設值

預設值為

json
15

defaultRenderer

決定用於渲染的渲染引擎。

defaultRenderer

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 預設值

預設值為

json
"dagre-wrapper"

wrappingWidth

文字會換行的節點寬度。

當使用 Markdown 字串時,文字會自動換行,此值設定文字在新行繼續之前的最大寬度。

wrappingWidth

wrappingWidth 類型

數字

wrappingWidth 預設值

預設值為

json
200