跳至内容

流程图配置模式

txt
https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/FlowchartDiagramConfig

包含特定于流程图的配置的对象

抽象可扩展状态可识别自定义属性附加属性访问限制定义于
可以实例化未知状态禁止允许config.schema.json*

流程图配置类型

object (流程图配置)

全部

流程图配置属性

属性类型必需可空定义于
titleTopMargininteger必需不可为空Mermaid 配置
subGraphTitleMarginobject必需不可为空Mermaid 配置
arrowMarkerAbsoluteboolean可选不可为空Mermaid 配置
diagramPaddinginteger必需不可为空Mermaid 配置
htmlLabelsboolean必需不可为空Mermaid 配置
nodeSpacinginteger必需不可为空Mermaid 配置
rankSpacinginteger必需不可为空Mermaid 配置
curvestring必需不可为空Mermaid 配置
paddingnumber可选不可为空Mermaid 配置
defaultRendererstring必需不可为空Mermaid 配置
wrappingWidthnumber必需不可为空Mermaid 配置

titleTopMargin

图表上方的文本的顶部边距

titleTopMargin

titleTopMargin 类型

integer

titleTopMargin 约束

最小值:此数字的值必须大于或等于:0

titleTopMargin 默认值

默认值为

json
25

subGraphTitleMargin

定义子图标题的顶部/底部边距

subGraphTitleMargin

subGraphTitleMargin 类型

object (详情)

subGraphTitleMargin 默认值

默认值为

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

arrowMarkerAbsolute

arrowMarkerAbsolute

arrowMarkerAbsolute 类型

boolean

diagramPadding

围绕整个图表的填充量,以便嵌入的图表具有边距,以像素表示。

diagramPadding

diagramPadding 类型

integer

diagramPadding 约束

最小值:此数字的值必须大于或等于:0

diagramPadding 默认值

默认值为

json
20

htmlLabels

用于设置是否应使用 html 标签来渲染边上的标签的标志。

htmlLabels

htmlLabels 类型

boolean

htmlLabels 默认值

默认值为

json
true

nodeSpacing

定义同一级别上的节点之间的间距

适用于 TB(从上到下)或 BT(从下到上)图的水平间距,以及 LR 和 RL 图的垂直间距。

nodeSpacing

nodeSpacing 类型

integer

nodeSpacing 约束

最小值:此数字的值必须大于或等于:0

nodeSpacing 默认值

默认值为

json
50

rankSpacing

定义不同级别上的节点之间的间距

适用于 TB(从上到下)或 BT(从下到上)图的水平间距,以及 LR 和 RL 图的垂直间距。

rankSpacing

rankSpacing 类型

integer

rankSpacing 约束

最小值:此数字的值必须大于或等于:0

rankSpacing 默认值

默认值为

json
50

curve

定义 Mermaid 如何渲染流程图的曲线。

curve

curve 类型

string

curve 约束

枚举:此属性的值必须等于以下值之一

解释
"basis"
"linear"
"cardinal"

curve 默认值

默认值为

json
"basis"

padding

表示标签与形状之间的填充

仅在新的实验性渲染中使用。

padding

padding 类型

number

padding 默认值

默认值为

json
15

defaultRenderer

决定要用于渲染的渲染引擎。

defaultRenderer

defaultRenderer 类型

string

defaultRenderer 约束

枚举:此属性的值必须等于以下值之一

解释
"dagre-d3"[dagre-d3-es](https://npmjs.net.cn/package/dagre-d3-es) 库。
"dagre-wrapper"在 Mermaid 中实现的 dagre 包装器
"elk"使用 [elkjs](https://github.com/kieler/elkjs) 布局

defaultRenderer 默认值

默认值为

json
"dagre-wrapper"

wrappingWidth

文本换行的节点宽度。

当使用 markdown 字符串时,文本会自动换行,此值设置文本在继续到新行之前允许的最大宽度。

wrappingWidth

wrappingWidth 类型

number

wrappingWidth 默认值

默认值为

json
200