跳至内容

旅程图配置模式

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

包含旅程图特定配置的对象

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

JourneyDiagramConfig 类型

object (旅程图配置)

all of

JourneyDiagramConfig 属性

属性类型必需可空定义于
diagramMarginXinteger必需不可为空Mermaid 配置
diagramMarginYinteger必需不可为空Mermaid 配置
leftMargininteger必需不可为空Mermaid 配置
widthinteger必需不可为空Mermaid 配置
heightinteger必需不可为空Mermaid 配置
boxMargininteger必需不可为空Mermaid 配置
boxTextMargininteger必需不可为空Mermaid 配置
noteMargininteger必需不可为空Mermaid 配置
messageMargininteger必需不可为空Mermaid 配置
messageAlignstring必需不可为空Mermaid 配置
bottomMarginAdjinteger必需不可为空Mermaid 配置
rightAnglesboolean必需不可为空Mermaid 配置
taskFontSize多个可选不可为空Mermaid 配置
taskFontFamilystring可选不可为空Mermaid 配置
taskMarginnumber可选不可为空Mermaid 配置
activationWidthnumber可选不可为空Mermaid 配置
textPlacementstring可选不可为空Mermaid 配置
actorColoursarray可选不可为空Mermaid 配置
sectionFillsarray可选不可为空Mermaid 配置
sectionColoursarray可选不可为空Mermaid 配置

diagramMarginX

C4 图表左右两侧的边距,必须为正值。

diagramMarginX

diagramMarginX 类型

integer

diagramMarginX 约束

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

diagramMarginX 默认值

默认值为

json
50

diagramMarginY

C4 图表上下两侧的边距,必须为正值。

diagramMarginY

diagramMarginY 类型

integer

diagramMarginY 约束

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

diagramMarginY 默认值

默认值为

json
10

leftMargin

参与者之间的边距

leftMargin

leftMargin 类型

integer

leftMargin 约束

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

leftMargin 默认值

默认值为

json
150

width

参与者框的宽度

width

width 类型

integer

width 约束

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

width 默认值

默认值为

json
150

height

参与者框的高度

height

height 类型

integer

height 约束

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

height 默认值

默认值为

json
50

boxMargin

循环框周围的边距

boxMargin

boxMargin 类型

integer

boxMargin 约束

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

boxMargin 默认值

默认值为

json
10

boxTextMargin

循环/alt/opt 框中文字周围的边距

boxTextMargin

boxTextMargin 类型

integer

boxTextMargin 约束

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

boxTextMargin 默认值

默认值为

json
5

noteMargin

注释周围的边距

noteMargin

noteMargin 类型

integer

noteMargin 约束

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

noteMargin 默认值

默认值为

json
10

messageMargin

消息之间的间隔。

messageMargin

messageMargin 类型

integer

messageMargin 约束

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

messageMargin 默认值

默认值为

json
35

messageAlign

多行消息的对齐方式

messageAlign

messageAlign 类型

string

messageAlign 约束

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

说明
"left"
"center"
"right"

messageAlign 默认值

默认值为

json
"center"

bottomMarginAdj

向下延长图表的边缘。

根据 CSS 样式,这可能需要调整。

bottomMarginAdj

bottomMarginAdj 类型

integer

bottomMarginAdj 约束

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

bottomMarginAdj 默认值

默认值为

json
1

rightAngles

弯曲箭头变为直角

这将显示以相同节点开始和结束的箭头为直角,而不是曲线。

rightAngles

rightAngles 类型

boolean

taskFontSize

taskFontSize

  • 是可选的

  • 类型: 以下任意一种: stringnumber (详情)

  • 不可为空

  • 定义于: Mermaid 配置

taskFontSize 类型

以下任意一种: stringnumber (详情)

taskFontSize 默认值

默认值为

json
14

taskFontFamily

taskFontFamily

taskFontFamily 类型

string

taskFontFamily 默认值

默认值为

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

taskMargin

taskMargin

taskMargin 类型

number

taskMargin 默认值

默认值为

json
50

activationWidth

激活框的宽度

activationWidth

activationWidth 类型

number

activationWidth 默认值

默认值为

json
10

textPlacement

文本放置方式: tspan | fo | old 仅文本(与以前相同)

textPlacement

textPlacement 类型

string

textPlacement 默认值

默认值为

json
"fo"

actorColours

actorColours

actorColours 类型

string[]

actorColours 默认值

默认值为

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

sectionFills

sectionFills

sectionFills 类型

string[]

sectionFills 默认值

默认值为

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

sectionColours

sectionColours

sectionColours 类型

string[]

sectionColours 默认值

默认值为

json
["#fff"]