Mermaid 配置模式
https://mermaid.npmjs.net.cn/schemas/config.schema.json
抽象 | 可扩展 | 状态 | 可识别 | 自定义属性 | 附加属性 | 访问限制 | 定义于 |
---|---|---|---|---|---|---|---|
可实例化 | 否 | 未知状态 | 否 | 禁止 | 禁止 | 无 | config.schema.json |
Mermaid 配置类型
object
(Mermaid 配置)
Mermaid 配置属性
theme
主题,CSS 样式表。您也可以使用 themeCSS
覆盖此值。
theme
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
theme 类型
string
theme 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"default" | |
"base" | |
"dark" | |
"forest" | |
"neutral" | |
"null" | 可设置为禁用任何预定义的 mermaid 主题 |
theme 默认值
默认值为
"default"
themeVariables
themeVariables
是可选的
类型:未知
不可为空
定义于:Mermaid 配置
tsType:
any
themeVariables 类型
未知
themeCSS
themeCSS
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
themeCSS 类型
string
look
定义要用于图表的主要外观。
look
是必需的
类型:
string
不可为空
定义于:Mermaid 配置
look 类型
string
look 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"classic" | |
"handDrawn" |
look 默认值
默认值为
"classic"
handDrawnSeed
定义使用 handDrawn 外观时要使用的种子。这对于自动化测试很重要,因为它们总是会发现没有种子时的差异。默认值为 0,它会提供随机种子。
handDrawnSeed
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
handDrawnSeed 类型
number
layout
定义要用于渲染图表的布局算法。
layout
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
layout 类型
string
layout 默认值
默认值为
"dagre"
maxTextSize
用户文本图表的最大允许大小
maxTextSize
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
maxTextSize 类型
number
maxTextSize 默认值
默认值为
50000
maxEdges
定义可以在图表中绘制的最大边数。
maxEdges
是可选的
类型:
integer
不可为空
定义于:Mermaid 配置
maxEdges 类型
integer
maxEdges 约束
最小值:此数字的值必须大于或等于:0
maxEdges 默认值
默认值为
500
elk
elk
是可选的
类型:
object
(详细信息)不可为空
定义于:Mermaid 配置
elk 类型
object
(详细信息)
darkMode
darkMode
是可选的
类型:
boolean
不可为空
定义于:Mermaid 配置
darkMode 类型
boolean
htmlLabels
htmlLabels
是可选的
类型:
boolean
不可为空
定义于:Mermaid 配置
htmlLabels 类型
boolean
fontFamily
指定要在渲染的图表中使用的字体。可以是任何可能的 CSS font-family
。参见 https://mdn.org.cn/en-US/docs/Web/CSS/font-family
fontFamily
是必需的
类型:
string
不可为空
定义于:Mermaid 配置
fontFamily 类型
string
fontFamily 默认值
默认值为
"\"trebuchet ms\", verdana, arial, sans-serif;"
altFontFamily
altFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
altFontFamily 类型
string
logLevel
此选项决定 mermaid 要使用的日志记录量。
logLevel
是必需的
类型:以下任何一个:
string
或number
(详细信息)不可为空
定义在: Mermaid 配置
logLevel 类型
以下任一: string
或 number
(详情)
logLevel 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"trace" | 等效于 0 |
0 | |
"debug" | 等效于 1 |
1 | |
"info" | 等效于 2 |
2 | |
"warn" | 等效于 3 |
3 | |
"error" | 等效于 4 |
4 | |
"fatal" | 等效于 5 (默认) |
5 |
logLevel 默认值
默认值为
5
securityLevel
解析图表的信任级别
securityLevel
是必需的
类型:
string
不可为空
定义在: Mermaid 配置
securityLevel 类型
string
securityLevel 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"strict" | (**默认**) 文本中的 HTML 标签被编码,并且点击功能被禁用。 |
"loose" | 文本中的 HTML 标签被允许,并且点击功能被启用。 |
"antiscript" | 文本中的 HTML 标签被允许(仅删除脚本元素),并且点击功能被启用。 |
"sandbox" | 使用此安全级别,所有渲染都在沙盒 iframe 中进行。这可以防止任何 JavaScript 在上下文中运行。这可能会阻碍图表的交互功能,例如脚本、序列图中的弹出窗口或指向其他选项卡或目标的链接等。 |
securityLevel 默认值
默认值为
"strict"
startOnLoad
指示 mermaid 是否在页面加载时启动
startOnLoad
是必需的
类型:
boolean
不可为空
定义在: Mermaid 配置
startOnLoad 类型
boolean
startOnLoad 默认值
默认值为
true
arrowMarkerAbsolute
控制 html 代码中的箭头标记是绝对路径还是锚点。这在您使用 base 标签设置时很重要。
arrowMarkerAbsolute
是必需的
类型:
boolean
不可为空
定义在: Mermaid 配置
arrowMarkerAbsolute 类型
boolean
secure
此选项控制哪些 currentConfig
键被视为安全,并且只能通过调用 mermaid.initialize
来更改。这可以防止恶意图表指令覆盖网站的默认安全性。
secure
是可选的
类型:
string[]
不可为空
定义在: Mermaid 配置
secure 类型
string[]
secure 默认值
默认值为
["secure", "securityLevel", "startOnLoad", "maxTextSize", "suppressErrorRendering", "maxEdges"]
legacyMathML
此选项指定 Mermaid 是否可以预期依赖项包含 KaTeX 样式表,以供没有自己的 MathML 实现的浏览器使用。如果此选项被禁用且不支持 MathML,则数学公式将被警告信息替换。如果此选项被启用且不支持 MathML,则 Mermaid 将回退到 KaTeX 的传统渲染方式。
legacyMathML
是可选的
类型:
boolean
不可为空
定义在: Mermaid 配置
legacyMathML 类型
boolean
forceLegacyMathML
此选项强制 Mermaid 依赖 KaTeX 自己的样式表来渲染 MathML。由于操作系统字体和浏览器 MathML 实现之间的差异,如果一致的渲染很重要,则建议使用此选项。如果设置为 true,则忽略 legacyMathML。
forceLegacyMathML
是可选的
类型:
boolean
不可为空
定义在: Mermaid 配置
forceLegacyMathML 类型
boolean
deterministicIds
此选项控制 SVG 中节点生成的 ID 是随机生成还是基于种子生成。如果设置为 false
,则 ID 是根据当前日期生成的,因此不是确定性的。这是默认行为。
如果您将文件签入到源代码控制中(例如 git),并且除非内容发生更改,否则不应更改,这很重要。
deterministicIds
是可选的
类型:
boolean
不可为空
定义在: Mermaid 配置
deterministicIds 类型
boolean
deterministicIDSeed
此选项是确定性 ID 的可选种子。如果设置为 undefined
但 deterministicIds 为 true
,则使用简单的数字迭代器。您可以将此属性设置为基于静态字符串的种子。
deterministicIDSeed
是可选的
类型:
string
不可为空
定义在: Mermaid 配置
deterministicIDSeed 类型
string
flowchart
包含针对流程图的特定配置的对象
flowchart
是必需的
类型:
object
(流程图配置)不可为空
定义在: Mermaid 配置
flowchart 类型
object
(流程图配置)
所有
sequence
包含针对序列图的特定配置的对象
sequence
是必需的
类型:
object
(序列图配置)不可为空
定义在: Mermaid 配置
sequence 类型
object
(序列图配置)
所有
gantt
包含针对甘特图的特定配置的对象
gantt
是必需的
类型:
object
(甘特图配置)不可为空
定义在: Mermaid 配置
gantt 类型
object
(甘特图配置)
所有
journey
包含针对旅程图的特定配置的对象
journey
是必需的
类型:
object
(旅程图配置)不可为空
定义在: Mermaid 配置
journey 类型
object
(旅程图配置)
所有
timeline
timeline
是可选的
类型:
object
(时间线图配置)不可为空
定义在: Mermaid 配置
timeline 类型
object
(时间线图配置)
所有
class
class
是必需的
类型:
object
(类图配置)不可为空
定义在: Mermaid 配置
class 类型
object
(类图配置)
所有
state
包含针对实体关系图的特定配置的对象
state
是必需的
类型:
object
(状态图配置)不可为空
定义在: Mermaid 配置
state 类型
object
(状态图配置)
所有
er
包含针对实体关系图的特定配置的对象
er
是必需的
类型:
object
(ER 图配置)不可为空
定义在: Mermaid 配置
er 类型
object
(ER 图配置)
所有
pie
pie
是必需的
类型:
object
(饼图配置)不可为空
定义在: Mermaid 配置
pie 类型
object
(饼图配置)
所有
quadrantChart
quadrantChart
是必需的
类型:
object
(象限图配置)不可为空
定义在: Mermaid 配置
quadrantChart 类型
object
(象限图配置)
所有
xyChart
此对象包含针对 XY 图表的特定配置
xyChart
是必需的
类型:
object
(XY 图表配置)不可为空
定义在: Mermaid 配置
xyChart 类型
object
(XY 图表配置)
所有
requirement
包含针对 req 图表的特定配置的对象
requirement
是必需的
类型:
object
(需求图配置)不可为空
定义在: Mermaid 配置
需求类型
object
(需求图配置)
所有
架构
包含架构图特定配置的对象
architecture
是必需的
类型:
object
(架构图配置)不可为空
定义于: Mermaid 配置
架构类型
object
(架构图配置)
所有
思维导图
包含思维导图特定配置的对象
mindmap
是必需的
类型:
object
(思维导图配置)不可为空
定义于: Mermaid 配置
思维导图类型
object
(思维导图配置)
所有
看板
包含看板图特定配置的对象
kanban
是必需的
类型:
object
(看板图配置)不可为空
定义于: Mermaid 配置
看板类型
object
(看板图配置)
所有
gitGraph
gitGraph
是必需的
类型:
object
(Git Graph 图配置)不可为空
定义于: Mermaid 配置
gitGraph 类型
object
(Git Graph 图配置)
所有
c4
包含 c4 图特定配置的对象
c4
是必需的
类型:
object
(C4 图配置)不可为空
定义于: Mermaid 配置
c4 类型
object
(C4 图配置)
所有
sankey
包含 sankey 图特定配置的对象。
sankey
是必需的
类型:
object
(Sankey 图配置)不可为空
定义于: Mermaid 配置
sankey 类型
object
(Sankey 图配置)
所有
数据包
包含数据包图特定配置的对象。
packet
是必需的
类型:
object
(数据包图配置)不可为空
定义于: Mermaid 配置
数据包类型
object
(数据包图配置)
所有
块
包含块图特定配置的对象。
block
是必需的
类型:
object
(块图配置)不可为空
定义于: Mermaid 配置
块类型
object
(块图配置)
所有
dompurifyConfig
传递给dompurify
库的配置选项。
dompurifyConfig
是可选的
类型:
object
(DOM Purify 配置)不可为空
定义于: Mermaid 配置
tsType:
import('dompurify').Config
dompurifyConfig 类型
object
(DOM Purify 配置)
wrap
wrap
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
wrap 类型
boolean
fontSize
fontSize
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
fontSize 类型
number
fontSize 默认值
默认值为
16
markdownAutoWrap
markdownAutoWrap
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
markdownAutoWrap 类型
boolean
markdownAutoWrap 默认值
默认值为
true
suppressErrorRendering
阻止在 DOM 中插入 'Syntax error' 图表。这在您想控制应用程序中如何处理语法错误时很有用。
suppressErrorRendering
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
suppressErrorRendering 类型
boolean
Mermaid 配置定义
定义组 BaseDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/BaseDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
useWidth | number | 可选 | 不可为空 | Mermaid 配置 |
useMaxWidth | boolean | 可选 | 不可为空 | Mermaid 配置 |
useWidth
useWidth
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
useWidth 类型
number
useMaxWidth
当该标志设置为true
时,高度和宽度设置为 100%,然后根据可用空间进行缩放。如果设置为false
,则使用所需的绝对空间。
useMaxWidth
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
useMaxWidth 类型
boolean
useMaxWidth 默认值
默认值为
true
定义组 C4DiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/C4DiagramConfig" }
diagramMarginX
c4 图表左右的边距,必须为正值。
diagramMarginX
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
diagramMarginX 类型
integer
图表横向边距约束
最小值:此数字的值必须大于或等于:0
图表横向边距默认值
默认值为
50
图表纵向边距
c4 图表上下边距,必须为正值。
diagramMarginY
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
图表纵向边距类型
integer
图表纵向边距约束
最小值:此数字的值必须大于或等于:0
图表纵向边距默认值
默认值为
10
c4 图形边距
图形之间的边距
c4ShapeMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
c4 图形边距类型
integer
c4 图形边距约束
最小值:此数字的值必须大于或等于:0
c4 图形边距默认值
默认值为
50
c4 图形内边距
图形内部的边距
c4ShapePadding
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
c4 图形内边距类型
integer
c4 图形内边距约束
最小值:此数字的值必须大于或等于:0
c4 图形内边距默认值
默认值为
20
宽度
人员框的宽度
width
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
宽度类型
integer
宽度约束
最小值:此数字的值必须大于或等于:0
宽度默认值
默认值为
216
高度
人员框的高度
height
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
高度类型
integer
高度约束
最小值:此数字的值必须大于或等于:0
高度默认值
默认值为
60
框边距
框周围的边距
boxMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
框边距类型
integer
框边距约束
最小值:此数字的值必须大于或等于:0
框边距默认值
默认值为
10
c4 图形每行数量
每行放置的图形数量。
c4ShapeInRow
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
c4 图形每行数量类型
integer
c4 图形每行数量约束
最小值:此数字的值必须大于或等于:0
c4 图形每行数量默认值
默认值为
4
下一行横向边距
nextLinePaddingX
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
下一行横向边距类型
number
c4 区域每行数量
每行放置的区域数量。
c4BoundaryInRow
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
c4 区域每行数量类型
integer
c4 区域每行数量约束
最小值:此数字的值必须大于或等于:0
c4 区域每行数量默认值
默认值为
2
人员字体大小
设置图表中人员形状的字体大小
personFontSize
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
人员字体大小类型
以下之一:string
或 number
(详情)
人员字体大小默认值
默认值为
14
人员字体
设置图表中人员形状的字体
personFontFamily
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
人员字体类型
string
人员字体默认值
默认值为
"\"Open Sans\", sans-serif"
人员字体粗细
设置图表中人员形状的字体
personFontWeight
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
人员字体粗细类型
以下之一:string
或 number
(详情)
人员字体粗细默认值
默认值为
"normal"
外部人员字体大小
设置图表中外部人员形状的字体大小
external_personFontSize
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
外部人员字体大小类型
以下之一:string
或 number
(详情)
外部人员字体大小默认值
默认值为
14
外部人员字体
设置图表中外部人员形状的字体
external_personFontFamily
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
外部人员字体类型
string
外部人员字体默认值
默认值为
"\"Open Sans\", sans-serif"
外部人员字体粗细
设置图表中外部人员形状的字体粗细
external_personFontWeight
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
外部人员字体粗细类型
以下之一:string
或 number
(详情)
外部人员字体粗细默认值
默认值为
"normal"
系统字体大小
设置图表中系统形状的字体大小
systemFontSize
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
系统字体大小类型
以下之一:string
或 number
(详情)
系统字体大小默认值
默认值为
14
系统字体
设置图表中系统形状的字体
systemFontFamily
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
系统字体类型
string
系统字体默认值
默认值为
"\"Open Sans\", sans-serif"
系统字体粗细
设置图表中系统形状的字体粗细
systemFontWeight
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
系统字体粗细类型
以下之一:string
或 number
(详情)
系统字体粗细默认值
默认值为
"normal"
外部系统字体大小
设置图表中外部系统形状的字体大小
external_systemFontSize
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
外部系统字体大小类型
以下之一:string
或 number
(详情)
external_systemFontSize 默认值
默认值为
14
external_systemFontFamily
此属性设置图表中外部系统形状的字体系列
external_systemFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_systemFontFamily 类型
string
external_systemFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
external_systemFontWeight
此属性设置图表中外部系统形状的字体粗细
external_systemFontWeight
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_systemFontWeight 类型
以下之一:string
或 number
(详情)
external_systemFontWeight 默认值
默认值为
"normal"
system_dbFontSize
此属性设置图表中系统数据库形状的字体大小
system_dbFontSize
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
system_dbFontSize 类型
以下之一:string
或 number
(详情)
system_dbFontSize 默认值
默认值为
14
system_dbFontFamily
此属性设置图表中系统数据库形状的字体系列
system_dbFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
system_dbFontFamily 类型
string
system_dbFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
system_dbFontWeight
此属性设置图表中系统数据库形状的字体粗细
system_dbFontWeight
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
system_dbFontWeight 类型
以下之一:string
或 number
(详情)
system_dbFontWeight 默认值
默认值为
"normal"
external_system_dbFontSize
此属性设置图表中外部系统数据库形状的字体大小
external_system_dbFontSize
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_system_dbFontSize 类型
以下之一:string
或 number
(详情)
external_system_dbFontSize 默认值
默认值为
14
external_system_dbFontFamily
此属性设置图表中外部系统数据库形状的字体系列
external_system_dbFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_system_dbFontFamily 类型
string
external_system_dbFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
external_system_dbFontWeight
此属性设置图表中外部系统数据库形状的字体粗细
external_system_dbFontWeight
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_system_dbFontWeight 类型
以下之一:string
或 number
(详情)
external_system_dbFontWeight 默认值
默认值为
"normal"
system_queueFontSize
此属性设置图表中系统队列形状的字体大小
system_queueFontSize
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
system_queueFontSize 类型
以下之一:string
或 number
(详情)
system_queueFontSize 默认值
默认值为
14
system_queueFontFamily
此属性设置图表中系统队列形状的字体系列
system_queueFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
system_queueFontFamily 类型
string
system_queueFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
system_queueFontWeight
此属性设置图表中系统队列形状的字体粗细
system_queueFontWeight
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
system_queueFontWeight 类型
以下之一:string
或 number
(详情)
system_queueFontWeight 默认值
默认值为
"normal"
external_system_queueFontSize
此属性设置图表中外部系统队列形状的字体大小
external_system_queueFontSize
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_system_queueFontSize 类型
以下之一:string
或 number
(详情)
external_system_queueFontSize 默认值
默认值为
14
external_system_queueFontFamily
此属性设置图表中外部系统队列形状的字体系列
external_system_queueFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_system_queueFontFamily 类型
string
external_system_queueFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
external_system_queueFontWeight
此属性设置图表中外部系统队列形状的字体粗细
external_system_queueFontWeight
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_system_queueFontWeight 类型
以下之一:string
或 number
(详情)
external_system_queueFontWeight 默认值
默认值为
"normal"
boundaryFontSize
此属性设置图表中边界形状的字体大小
boundaryFontSize
是可选的
类型:以下之一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
boundaryFontSize 类型
以下之一:string
或 number
(详情)
boundaryFontSize 默认值
默认值为
14
boundaryFontFamily
此属性设置图表中边界形状的字体系列
boundaryFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
boundaryFontFamily 类型
string
boundaryFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
boundaryFontWeight
这将设置图表中边界形状的字体粗细。
boundaryFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
boundaryFontWeight 类型
以下任一:string
或 number
(详情)
boundaryFontWeight 默认值
默认值为
"normal"
messageFontSize
这将设置图表中消息形状的字体大小。
messageFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
messageFontSize 类型
以下任一:string
或 number
(详情)
messageFontSize 默认值
默认值为
12
messageFontFamily
这将设置图表中消息形状的字体系列。
messageFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
messageFontFamily 类型
string
messageFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
messageFontWeight
这将设置图表中消息形状的字体粗细。
messageFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
messageFontWeight 类型
以下任一:string
或 number
(详情)
messageFontWeight 默认值
默认值为
"normal"
containerFontSize
这将设置图表中容器形状的字体大小。
containerFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
containerFontSize 类型
以下任一:string
或 number
(详情)
containerFontSize 默认值
默认值为
14
containerFontFamily
这将设置图表中容器形状的字体系列。
containerFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
containerFontFamily 类型
string
containerFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
containerFontWeight
这将设置图表中容器形状的字体粗细。
containerFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
containerFontWeight 类型
以下任一:string
或 number
(详情)
containerFontWeight 默认值
默认值为
"normal"
external_containerFontSize
这将设置图表中外部容器形状的字体大小。
external_containerFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_containerFontSize 类型
以下任一:string
或 number
(详情)
external_containerFontSize 默认值
默认值为
14
external_containerFontFamily
这将设置图表中外部容器形状的字体系列。
external_containerFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_containerFontFamily 类型
string
external_containerFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
external_containerFontWeight
这将设置图表中外部容器形状的字体粗细。
external_containerFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_containerFontWeight 类型
以下任一:string
或 number
(详情)
external_containerFontWeight 默认值
默认值为
"normal"
container_dbFontSize
这将设置图表中容器数据库形状的字体大小。
container_dbFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
container_dbFontSize 类型
以下任一:string
或 number
(详情)
container_dbFontSize 默认值
默认值为
14
container_dbFontFamily
这将设置图表中容器数据库形状的字体系列。
container_dbFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
container_dbFontFamily 类型
string
container_dbFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
container_dbFontWeight
这将设置图表中容器数据库形状的字体粗细。
container_dbFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
container_dbFontWeight 类型
以下任一:string
或 number
(详情)
container_dbFontWeight 默认值
默认值为
"normal"
external_container_dbFontSize
这将设置图表中外部容器数据库形状的字体大小。
external_container_dbFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_container_dbFontSize 类型
以下任一:string
或 number
(详情)
external_container_dbFontSize 默认值
默认值为
14
external_container_dbFontFamily
这将设置图表中外部容器数据库形状的字体系列。
external_container_dbFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_container_dbFontFamily 类型
string
external_container_dbFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
external_container_dbFontWeight
这将设置图表中外部容器数据库形状的字体粗细。
external_container_dbFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_container_dbFontWeight 类型
以下任一:string
或 number
(详情)
external_container_dbFontWeight 默认值
默认值为
"normal"
container_queueFontSize
这将设置图表中容器队列形状的字体大小。
container_queueFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
container_queueFontSize 类型
以下任一:string
或 number
(详情)
container_queueFontSize 默认值
默认值为
14
container_queueFontFamily
这将设置图表中 Container Queue 形状的字体系列
container_queueFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
container_queueFontFamily 类型
string
container_queueFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
container_queueFontWeight
这将设置图表中 Container Queue 形状的字体粗细
container_queueFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
container_queueFontWeight 类型
以下任一:string
或 number
(详情)
container_queueFontWeight 默认值
默认值为
"normal"
external_container_queueFontSize
这将设置图表中 External Container Queue 形状的字体大小
external_container_queueFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_container_queueFontSize 类型
以下任一:string
或 number
(详情)
external_container_queueFontSize 默认值
默认值为
14
external_container_queueFontFamily
这将设置图表中 External Container Queue 形状的字体系列
external_container_queueFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_container_queueFontFamily 类型
string
external_container_queueFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
external_container_queueFontWeight
这将设置图表中 External Container Queue 形状的字体粗细
external_container_queueFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_container_queueFontWeight 类型
以下任一:string
或 number
(详情)
external_container_queueFontWeight 默认值
默认值为
"normal"
componentFontSize
这将设置图表中 Component 形状的字体大小
componentFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
componentFontSize 类型
以下任一:string
或 number
(详情)
componentFontSize 默认值
默认值为
14
componentFontFamily
这将设置图表中 Component 形状的字体系列
componentFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
componentFontFamily 类型
string
componentFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
componentFontWeight
这将设置图表中 Component 形状的字体粗细
componentFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
componentFontWeight 类型
以下任一:string
或 number
(详情)
componentFontWeight 默认值
默认值为
"normal"
external_componentFontSize
这将设置图表中 External Component 形状的字体大小
external_componentFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_componentFontSize 类型
以下任一:string
或 number
(详情)
external_componentFontSize 默认值
默认值为
14
external_componentFontFamily
这将设置图表中 External Component 形状的字体系列
external_componentFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_componentFontFamily 类型
string
external_componentFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
external_componentFontWeight
这将设置图表中 External Component 形状的字体粗细
external_componentFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_componentFontWeight 类型
以下任一:string
或 number
(详情)
external_componentFontWeight 默认值
默认值为
"normal"
component_dbFontSize
这将设置图表中 Component DB 形状的字体大小
component_dbFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
component_dbFontSize 类型
以下任一:string
或 number
(详情)
component_dbFontSize 默认值
默认值为
14
component_dbFontFamily
这将设置图表中 Component DB 形状的字体系列
component_dbFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
component_dbFontFamily 类型
string
component_dbFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
component_dbFontWeight
这将设置图表中 Component DB 形状的字体粗细
component_dbFontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
component_dbFontWeight 类型
以下任一:string
或 number
(详情)
component_dbFontWeight 默认值
默认值为
"normal"
external_component_dbFontSize
这将设置图表中 External Component DB 形状的字体大小
external_component_dbFontSize
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
external_component_dbFontSize 类型
以下任一:string
或 number
(详情)
external_component_dbFontSize 默认值
默认值为
14
external_component_dbFontFamily
这将设置图表中 External Component DB 形状的字体系列
external_component_dbFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_component_dbFontFamily 类型
string
external_component_dbFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
external_component_dbFontWeight
这设置了图表中外部组件数据库形状的字体粗细。
external_component_dbFontWeight
是可选的
类型: 以下任意之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
external_component_dbFontWeight 类型
以下任意之一:string
或 number
(详情)
external_component_dbFontWeight 默认值
默认值为
"normal"
component_queueFontSize
这设置了图表中组件队列形状的字体大小。
component_queueFontSize
是可选的
类型: 以下任意之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
component_queueFontSize 类型
以下任意之一:string
或 number
(详情)
component_queueFontSize 默认值
默认值为
14
component_queueFontFamily
这设置了图表中组件队列形状的字体家族。
component_queueFontFamily
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
component_queueFontFamily 类型
string
component_queueFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
component_queueFontWeight
这设置了图表中组件队列形状的字体粗细。
component_queueFontWeight
是可选的
类型: 以下任意之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
component_queueFontWeight 类型
以下任意之一:string
或 number
(详情)
component_queueFontWeight 默认值
默认值为
"normal"
external_component_queueFontSize
这设置了图表中外部组件队列形状的字体大小。
external_component_queueFontSize
是可选的
类型: 以下任意之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
external_component_queueFontSize 类型
以下任意之一:string
或 number
(详情)
external_component_queueFontSize 默认值
默认值为
14
external_component_queueFontFamily
这设置了图表中外部组件队列形状的字体家族。
external_component_queueFontFamily
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_component_queueFontFamily 类型
string
external_component_queueFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
external_component_queueFontWeight
这设置了图表中外部组件队列形状的字体粗细。
external_component_queueFontWeight
是可选的
类型: 以下任意之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
external_component_queueFontWeight 类型
以下任意之一:string
或 number
(详情)
external_component_queueFontWeight 默认值
默认值为
"normal"
wrap
这设置了图表的自动换行状态。
wrap
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
wrap 类型
boolean
wrap 默认值
默认值为
true
wrapPadding
这设置了图表的自动换行填充(仅两侧)。
wrapPadding
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
wrapPadding 类型
number
wrapPadding 默认值
默认值为
10
person_bg_color
person_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
person_bg_color 类型
string
person_bg_color 默认值
默认值为
"#08427B"
person_border_color
person_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
person_border_color 类型
string
person_border_color 默认值
默认值为
"#073B6F"
external_person_bg_color
external_person_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_person_bg_color 类型
string
external_person_bg_color 默认值
默认值为
"#686868"
external_person_border_color
external_person_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_person_border_color 类型
string
external_person_border_color 默认值
默认值为
"#8A8A8A"
system_bg_color
system_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
system_bg_color 类型
string
system_bg_color 默认值
默认值为
"#1168BD"
system_border_color
system_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
system_border_color 类型
string
system_border_color 默认值
默认值为
"#3C7FC0"
system_db_bg_color
system_db_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
system_db_bg_color 类型
string
system_db_bg_color 默认值
默认值为
"#1168BD"
system_db_border_color
system_db_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
system_db_border_color 类型
string
system_db_border_color 默认值
默认值为
"#3C7FC0"
system_queue_bg_color
system_queue_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
system_queue_bg_color 类型
string
system_queue_bg_color 默认值
默认值为
"#1168BD"
system_queue_border_color
system_queue_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
system_queue_border_color 类型
string
system_queue_border_color 默认值
默认值为
"#3C7FC0"
external_system_bg_color
external_system_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_system_bg_color 类型
string
external_system_bg_color 默认值
默认值为
"#999999"
external_system_border_color
external_system_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_system_border_color 类型
string
external_system_border_color 默认值
默认值为
"#8A8A8A"
external_system_db_bg_color
external_system_db_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_system_db_bg_color 类型
string
external_system_db_bg_color 默认值
默认值为
"#999999"
external_system_db_border_color
external_system_db_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_system_db_border_color 类型
string
external_system_db_border_color 默认值
默认值为
"#8A8A8A"
external_system_queue_bg_color
external_system_queue_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_system_queue_bg_color 类型
string
external_system_queue_bg_color 默认值
默认值为
"#999999"
external_system_queue_border_color
external_system_queue_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_system_queue_border_color 类型
string
external_system_queue_border_color 默认值
默认值为
"#8A8A8A"
container_bg_color
container_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
container_bg_color 类型
string
container_bg_color 默认值
默认值为
"#438DD5"
container_border_color
container_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
container_border_color 类型
string
container_border_color 默认值
默认值为
"#3C7FC0"
container_db_bg_color
container_db_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
container_db_bg_color 类型
string
container_db_bg_color 默认值
默认值为
"#438DD5"
container_db_border_color
container_db_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
container_db_border_color 类型
string
container_db_border_color 默认值
默认值为
"#3C7FC0"
container_queue_bg_color
container_queue_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
container_queue_bg_color 类型
string
container_queue_bg_color 默认值
默认值为
"#438DD5"
container_queue_border_color
container_queue_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
container_queue_border_color 类型
string
container_queue_border_color 默认值
默认值为
"#3C7FC0"
external_container_bg_color
external_container_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_container_bg_color 类型
string
external_container_bg_color 默认值
默认值为
"#B3B3B3"
external_container_border_color
external_container_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_container_border_color 类型
string
external_container_border_color 默认值
默认值为
"#A6A6A6"
external_container_db_bg_color
external_container_db_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_container_db_bg_color 类型
string
external_container_db_bg_color 默认值
默认值为
"#B3B3B3"
external_container_db_border_color
external_container_db_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_container_db_border_color 类型
string
external_container_db_border_color 默认值
默认值为
"#A6A6A6"
external_container_queue_bg_color
external_container_queue_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_container_queue_bg_color 类型
string
external_container_queue_bg_color 默认值
默认值为
"#B3B3B3"
external_container_queue_border_color
external_container_queue_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
external_container_queue_border_color 类型
string
external_container_queue_border_color 默认值
默认值为
"#A6A6A6"
component_bg_color
component_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
component_bg_color 类型
string
component_bg_color 默认值
默认值为
"#85BBF0"
component_border_color
component_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
component_border_color 类型
string
component_border_color 默认值
默认值为
"#78A8D8"
component_db_bg_color
component_db_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
component_db_bg_color 类型
string
component_db_bg_color 默认值
默认值为
"#85BBF0"
component_db_border_color
component_db_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
component_db_border_color 类型
string
component_db_border_color 默认值
默认值为
"#78A8D8"
component_queue_bg_color
component_queue_bg_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
component_queue_bg_color 类型
string
component_queue_bg_color 默认值
默认值为
"#85BBF0"
component_queue_border_color
component_queue_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
component_queue_border_color 类型
string
component_queue_border_color 默认值
默认值为
"#78A8D8"
external_component_bg_color
external_component_bg_color
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_component_bg_color 类型
string
external_component_bg_color 默认值
默认值为
"#CCCCCC"
external_component_border_color
external_component_border_color
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_component_border_color 类型
string
external_component_border_color 默认值
默认值为
"#BFBFBF"
external_component_db_bg_color
external_component_db_bg_color
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_component_db_bg_color 类型
string
external_component_db_bg_color 默认值
默认值为
"#CCCCCC"
external_component_db_border_color
external_component_db_border_color
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_component_db_border_color 类型
string
external_component_db_border_color 默认值
默认值为
"#BFBFBF"
external_component_queue_bg_color
external_component_queue_bg_color
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_component_queue_bg_color 类型
string
external_component_queue_bg_color 默认值
默认值为
"#CCCCCC"
external_component_queue_border_color
external_component_queue_border_color
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
external_component_queue_border_color 类型
string
external_component_queue_border_color 默认值
默认值为
"#BFBFBF"
personFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
personFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
personFont 类型
未知 (字体计算器)
external_personFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_personFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
external_personFont 类型
未知 (字体计算器)
systemFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
systemFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
systemFont 类型
未知 (字体计算器)
external_systemFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_systemFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
external_systemFont 类型
未知 (字体计算器)
system_dbFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
system_dbFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
system_dbFont 类型
未知 (字体计算器)
external_system_dbFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_system_dbFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
external_system_dbFont 类型
未知 (字体计算器)
system_queueFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
system_queueFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
system_queueFont 类型
未知 (字体计算器)
external_system_queueFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_system_queueFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
external_system_queueFont 类型
未知 (字体计算器)
containerFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
containerFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
containerFont 类型
未知 (字体计算器)
external_containerFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_containerFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
external_containerFont 类型
未知 (字体计算器)
container_dbFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
container_dbFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
container_dbFont 类型
未知 (字体计算器)
external_container_dbFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_container_dbFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
external_container_dbFont 类型
未知 (字体计算器)
container_queueFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
container_queueFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
container_queueFont 类型
未知 (字体计算器)
external_container_queueFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_container_queueFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
external_container_queueFont 类型
未知 (字体计算器)
componentFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
componentFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
componentFont 类型
未知 (字体计算器)
external_componentFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_componentFont
是可选的
类型:未知 (字体计算器)
不可为空
定义于:Mermaid 配置
tsType:
() => Partial<FontConfig>
external_componentFont 类型
未知 (字体计算器)
component_dbFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
component_dbFont
是可选的
类型: unknown (字体计算器)
不可为空
定义于: Mermaid 配置
tsType:
() => Partial<FontConfig>
component_dbFont 类型
unknown (字体计算器)
external_component_dbFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_component_dbFont
是可选的
类型: unknown (字体计算器)
不可为空
定义于: Mermaid 配置
tsType:
() => Partial<FontConfig>
external_component_dbFont 类型
unknown (字体计算器)
component_queueFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
component_queueFont
是可选的
类型: unknown (字体计算器)
不可为空
定义于: Mermaid 配置
tsType:
() => Partial<FontConfig>
component_queueFont 类型
unknown (字体计算器)
external_component_queueFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
external_component_queueFont
是可选的
类型: unknown (字体计算器)
不可为空
定义于: Mermaid 配置
tsType:
() => Partial<FontConfig>
external_component_queueFont 类型
unknown (字体计算器)
boundaryFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
boundaryFont
是可选的
类型: unknown (字体计算器)
不可为空
定义于: Mermaid 配置
tsType:
() => Partial<FontConfig>
boundaryFont 类型
unknown (字体计算器)
messageFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
messageFont
是可选的
类型: unknown (字体计算器)
不可为空
定义于: Mermaid 配置
tsType:
() => Partial<FontConfig>
messageFont 类型
unknown (字体计算器)
定义组 GitGraphDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/GitGraphDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
titleTopMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
diagramPadding | number | 可选 | 不可为空 | Mermaid 配置 |
nodeLabel | 合并 | 可选 | 不可为空 | Mermaid 配置 |
mainBranchName | string | 可选 | 不可为空 | Mermaid 配置 |
mainBranchOrder | number | 可选 | 不可为空 | Mermaid 配置 |
showCommitLabel | boolean | 可选 | 不可为空 | Mermaid 配置 |
showBranches | boolean | 可选 | 不可为空 | Mermaid 配置 |
rotateCommitLabel | boolean | 可选 | 不可为空 | Mermaid 配置 |
parallelCommits | boolean | 可选 | 不可为空 | Mermaid 配置 |
arrowMarkerAbsolute | boolean | 可选 | 不可为空 | Mermaid 配置 |
titleTopMargin
图表上方的文本边距
titleTopMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
titleTopMargin 类型
integer
titleTopMargin 约束
最小值:此数字的值必须大于或等于:0
titleTopMargin 默认值
默认值为
25
diagramPadding
diagramPadding
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
diagramPadding 类型
number
diagramPadding 默认值
默认值为
8
nodeLabel
nodeLabel
是可选的
类型:
object
(详情)不可为空
定义于: Mermaid 配置
nodeLabel 类型
object
(详情)
所有
nodeLabel 默认值
默认值为
{
"width": 75,
"height": 100,
"x": -25,
"y": 0
}
mainBranchName
mainBranchName
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
mainBranchName 类型
string
mainBranchName 默认值
默认值为
"main"
mainBranchOrder
mainBranchOrder
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
mainBranchOrder 类型
number
showCommitLabel
showCommitLabel
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
showCommitLabel 类型
boolean
showCommitLabel 默认值
默认值为
true
showBranches
showBranches
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
showBranches 类型
boolean
showBranches 默认值
默认值为
true
rotateCommitLabel
rotateCommitLabel
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
rotateCommitLabel 类型
boolean
rotateCommitLabel 默认值
默认值为
true
parallelCommits
parallelCommits
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
parallelCommits 类型
boolean
arrowMarkerAbsolute
控制 html 代码中的箭头标记是绝对路径还是锚点。这在您使用 base 标签设置时很重要。
arrowMarkerAbsolute
是可选的
类型:
boolean
不可为空
定义在: Mermaid 配置
arrowMarkerAbsolute 类型
boolean
定义组 NodeLabel
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/NodeLabel" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
width | number | 可选 | 不可为空 | Mermaid 配置 |
height | number | 可选 | 不可为空 | Mermaid 配置 |
x | number | 可选 | 不可为空 | Mermaid 配置 |
y | number | 可选 | 不可为空 | Mermaid 配置 |
width
width
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
width 类型
number
height
height
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
height 类型
number
x
x
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
x 类型
number
y
y
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
y 类型
number
定义组 RequirementDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/RequirementDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
rect_fill | string | 可选 | 不可为空 | Mermaid 配置 |
text_color | string | 可选 | 不可为空 | Mermaid 配置 |
rect_border_size | string | 可选 | 不可为空 | Mermaid 配置 |
rect_border_color | string | 可选 | 不可为空 | Mermaid 配置 |
rect_min_width | number | 可选 | 不可为空 | Mermaid 配置 |
rect_min_height | number | 可选 | 不可为空 | Mermaid 配置 |
fontSize | number | 可选 | 不可为空 | Mermaid 配置 |
rect_padding | number | 可选 | 不可为空 | Mermaid 配置 |
line_height | number | 可选 | 不可为空 | Mermaid 配置 |
rect_fill
rect_fill
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
rect_fill 类型
string
rect_fill 默认值
默认值为
"#f9f9f9"
text_color
text_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
text_color 类型
string
text_color 默认值
默认值为
"#333"
rect_border_size
rect_border_size
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
rect_border_size 类型
string
rect_border_size 默认值
默认值为
"0.5px"
rect_border_color
rect_border_color
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
rect_border_color 类型
string
rect_border_color 默认值
默认值为
"#bbb"
rect_min_width
rect_min_width
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
rect_min_width 类型
number
rect_min_width 默认值
默认值为
200
rect_min_height
rect_min_height
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
rect_min_height 类型
number
rect_min_height 默认值
默认值为
200
fontSize
fontSize
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
fontSize 类型
number
fontSize 默认值
默认值为
14
rect_padding
rect_padding
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
rect_padding 类型
number
rect_padding 默认值
默认值为
10
line_height
line_height
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
line_height 类型
number
line_height 默认值
默认值为
20
定义组 ArchitectureDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/ArchitectureDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
padding | number | 必需 | 不可为空 | Mermaid 配置 |
iconSize | number | 必需 | 不可为空 | Mermaid 配置 |
fontSize | number | 必需 | 不可为空 | Mermaid 配置 |
padding
padding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
padding 类型
number
padding 默认值
默认值为
40
iconSize
iconSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
iconSize 类型
number
iconSize 默认值
默认值为
80
fontSize
fontSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
fontSize 类型
number
fontSize 默认值
默认值为
16
定义组 MindmapDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/MindmapDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
padding | number | 必需 | 不可为空 | Mermaid 配置 |
maxNodeWidth | number | 必需 | 不可为空 | Mermaid 配置 |
padding
padding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
padding 类型
number
padding 默认值
默认值为
10
maxNodeWidth
maxNodeWidth
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
maxNodeWidth 类型
number
maxNodeWidth 默认值
默认值为
200
定义组 KanbanDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/KanbanDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
padding | number | 可选 | 不可为空 | Mermaid 配置 |
sectionWidth | number | 可选 | 不可为空 | Mermaid 配置 |
ticketBaseUrl | string | 可选 | 不可为空 | Mermaid 配置 |
padding
padding
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
padding 类型
number
padding 默认值
默认值为
8
sectionWidth
sectionWidth
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
sectionWidth 类型
number
sectionWidth 默认值
默认值为
200
ticketBaseUrl
ticketBaseUrl
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
ticketBaseUrl 类型
string
定义组 PieDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/PieDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
textPosition | number | 可选 | 不可为空 | Mermaid 配置 |
textPosition
切片标签的轴向位置,从中心点为 0,到外边缘为 1。
textPosition
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
textPosition 类型
number
textPosition 约束
最大值: 该数字的值必须小于或等于: 1
最小值:此数字的值必须大于或等于:0
textPosition 默认值
默认值为
0.75
定义组 QuadrantChartConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/QuadrantChartConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
chartWidth | number | 必需 | 不可为空 | Mermaid 配置 |
chartHeight | number | 必需 | 不可为空 | Mermaid 配置 |
titleFontSize | number | 必需 | 不可为空 | Mermaid 配置 |
titlePadding | number | 必需 | 不可为空 | Mermaid 配置 |
quadrantPadding | number | 必需 | 不可为空 | Mermaid 配置 |
xAxisLabelPadding | number | 必需 | 不可为空 | Mermaid 配置 |
yAxisLabelPadding | number | 必需 | 不可为空 | Mermaid 配置 |
xAxisLabelFontSize | number | 必需 | 不可为空 | Mermaid 配置 |
yAxisLabelFontSize | number | 必需 | 不可为空 | Mermaid 配置 |
quadrantLabelFontSize | number | 必需 | 不可为空 | Mermaid 配置 |
quadrantTextTopPadding | number | 必需 | 不可为空 | Mermaid 配置 |
pointTextPadding | number | 必需 | 不可为空 | Mermaid 配置 |
pointLabelFontSize | number | 必需 | 不可为空 | Mermaid 配置 |
pointRadius | number | 必需 | 不可为空 | Mermaid 配置 |
xAxisPosition | string | 必需 | 不可为空 | Mermaid 配置 |
yAxisPosition | string | 必需 | 不可为空 | Mermaid 配置 |
quadrantInternalBorderStrokeWidth | number | 必需 | 不可为空 | Mermaid 配置 |
quadrantExternalBorderStrokeWidth | number | 必需 | 不可为空 | Mermaid 配置 |
chartWidth
图表宽度
chartWidth
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
chartWidth 类型
number
chartWidth 约束
最小值:此数字的值必须大于或等于:0
chartWidth 默认值
默认值为
500
chartHeight
图表高度
chartHeight
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
chartHeight 类型
number
chartHeight 约束
最小值:此数字的值必须大于或等于:0
chartHeight 默认值
默认值为
500
titleFontSize
图表标题上下填充
titleFontSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
titleFontSize 类型
number
titleFontSize 约束
最小值:此数字的值必须大于或等于:0
titleFontSize 默认值
默认值为
20
titlePadding
象限方形周围的填充
titlePadding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
titlePadding 类型
number
titlePadding 约束
最小值:此数字的值必须大于或等于:0
titlePadding 默认值
默认值为
10
quadrantPadding
如果象限渲染在顶部,则象限标题从顶部的填充
quadrantPadding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
quadrantPadding 类型
number
quadrantPadding 约束
最小值:此数字的值必须大于或等于:0
quadrantPadding 默认值
默认值为
5
xAxisLabelPadding
x 轴标签周围的填充
xAxisLabelPadding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
xAxisLabelPadding 类型
number
xAxisLabelPadding 约束
最小值:此数字的值必须大于或等于:0
xAxisLabelPadding 默认值
默认值为
5
yAxisLabelPadding
y 轴标签周围的填充
yAxisLabelPadding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
yAxisLabelPadding 类型
number
yAxisLabelPadding 约束
最小值:此数字的值必须大于或等于:0
yAxisLabelPadding 默认值
默认值为
5
xAxisLabelFontSize
x 轴标签字体大小
xAxisLabelFontSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
xAxisLabelFontSize 类型
number
xAxisLabelFontSize 约束
最小值:此数字的值必须大于或等于:0
xAxisLabelFontSize 默认值
默认值为
16
yAxisLabelFontSize
y 轴标签字体大小
yAxisLabelFontSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
yAxisLabelFontSize 类型
number
yAxisLabelFontSize 约束
最小值:此数字的值必须大于或等于:0
yAxisLabelFontSize 默认值
默认值为
16
quadrantLabelFontSize
象限标题字体大小
quadrantLabelFontSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
quadrantLabelFontSize 类型
number
quadrantLabelFontSize 约束
最小值:此数字的值必须大于或等于:0
quadrantLabelFontSize 默认值
默认值为
16
quadrantTextTopPadding
如果象限渲染在顶部,则象限标题从顶部的填充
quadrantTextTopPadding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
quadrantTextTopPadding 类型
number
quadrantTextTopPadding 约束
最小值:此数字的值必须大于或等于:0
quadrantTextTopPadding 默认值
默认值为
5
pointTextPadding
点和点标签之间的填充
pointTextPadding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
pointTextPadding 类型
number
pointTextPadding 约束
最小值:此数字的值必须大于或等于:0
pointTextPadding 默认值
默认值为
5
pointLabelFontSize
点标题的字体大小
pointLabelFontSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
pointLabelFontSize 类型
number
pointLabelFontSize 约束
最小值:此数字的值必须大于或等于:0
pointLabelFontSize 默认值
默认值为
12
pointRadius
要绘制的点的半径
pointRadius
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
pointRadius 类型
number
pointRadius 约束
最小值:此数字的值必须大于或等于:0
pointRadius 默认值
默认值为
5
xAxisPosition
x 轴标签的位置
xAxisPosition
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
xAxisPosition 类型
string
xAxisPosition 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"top" | |
"bottom" |
xAxisPosition 默认值
默认值为
"top"
yAxisPosition
y 轴标签的位置
yAxisPosition
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
yAxisPosition 类型
string
yAxisPosition 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"left" | |
"right" |
yAxisPosition 默认值
默认值为
"left"
quadrantInternalBorderStrokeWidth
四边形内部边框的线宽
quadrantInternalBorderStrokeWidth
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
quadrantInternalBorderStrokeWidth 类型
number
quadrantInternalBorderStrokeWidth 约束
最小值:此数字的值必须大于或等于:0
quadrantInternalBorderStrokeWidth 默认值
默认值为
1
quadrantExternalBorderStrokeWidth
四边形外部边框的线宽
quadrantExternalBorderStrokeWidth
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
quadrantExternalBorderStrokeWidth 类型
number
quadrantExternalBorderStrokeWidth 约束
最小值:此数字的值必须大于或等于:0
quadrantExternalBorderStrokeWidth 默认值
默认值为
2
定义组 XYChartAxisConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/XYChartAxisConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
showLabel | boolean | 必需 | 不可为空 | Mermaid 配置 |
labelFontSize | number | 必需 | 不可为空 | Mermaid 配置 |
labelPadding | number | 必需 | 不可为空 | Mermaid 配置 |
showTitle | boolean | 必需 | 不可为空 | Mermaid 配置 |
titleFontSize | number | 必需 | 不可为空 | Mermaid 配置 |
titlePadding | number | 必需 | 不可为空 | Mermaid 配置 |
showTick | boolean | 必需 | 不可为空 | Mermaid 配置 |
tickLength | number | 必需 | 不可为空 | Mermaid 配置 |
tickWidth | number | 必需 | 不可为空 | Mermaid 配置 |
showAxisLine | boolean | 必需 | 不可为空 | Mermaid 配置 |
axisLineWidth | number | 必需 | 不可为空 | Mermaid 配置 |
showLabel
是否显示轴标签(刻度文本)
showLabel
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
showLabel 类型
boolean
showLabel 默认值
默认值为
true
labelFontSize
轴标签(刻度文本)的字体大小
labelFontSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
labelFontSize 类型
number
labelFontSize 约束
最小值: 此数字的值必须大于或等于: 1
labelFontSize 默认值
默认值为
14
labelPadding
轴标签(刻度文本)的上下间距
labelPadding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
labelPadding 类型
number
labelPadding 约束
最小值:此数字的值必须大于或等于:0
labelPadding 默认值
默认值为
5
showTitle
是否显示轴标题
showTitle
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
showTitle 类型
boolean
showTitle 默认值
默认值为
true
titleFontSize
轴标题的字体大小
titleFontSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
titleFontSize 类型
number
titleFontSize 约束
最小值: 此数字的值必须大于或等于: 1
titleFontSize 默认值
默认值为
16
titlePadding
轴标题的上下间距
titlePadding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
titlePadding 类型
number
titlePadding 约束
最小值:此数字的值必须大于或等于:0
titlePadding 默认值
默认值为
5
showTick
是否显示轴刻度线
showTick
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
showTick 类型
boolean
showTick 默认值
默认值为
true
tickLength
轴刻度线的长度
tickLength
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
tickLength 类型
number
tickLength 约束
最小值: 此数字的值必须大于或等于: 1
tickLength 默认值
默认值为
5
tickWidth
轴刻度线的宽度
tickWidth
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
tickWidth 类型
number
tickWidth 约束
最小值: 此数字的值必须大于或等于: 1
tickWidth 默认值
默认值为
2
showAxisLine
显示横跨轴的线
showAxisLine
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
showAxisLine 类型
boolean
showAxisLine 默认值
默认值为
true
axisLineWidth
轴线的宽度
axisLineWidth
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
axisLineWidth 类型
number
axisLineWidth 约束
最小值: 此数字的值必须大于或等于: 1
axisLineWidth 默认值
默认值为
2
定义组 XYChartConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/XYChartConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
width | number | 必需 | 不可为空 | Mermaid 配置 |
height | number | 必需 | 不可为空 | Mermaid 配置 |
titleFontSize | number | 必需 | 不可为空 | Mermaid 配置 |
titlePadding | number | 必需 | 不可为空 | Mermaid 配置 |
showTitle | boolean | 必需 | 不可为空 | Mermaid 配置 |
xAxis | object | 必需 | 不可为空 | Mermaid 配置 |
yAxis | object | 必需 | 不可为空 | Mermaid 配置 |
chartOrientation | 未指定 | 必需 | 不可为空 | Mermaid 配置 |
plotReservedSpacePercent | number | 必需 | 不可为空 | Mermaid 配置 |
width
图表宽度
width
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
width 类型
number
width 约束
最小值: 此数字的值必须大于或等于: 1
width 默认值
默认值为
700
height
图表高度
height
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
height 类型
number
height 约束
最小值: 此数字的值必须大于或等于: 1
height 默认值
默认值为
500
titleFontSize
图表标题的字体大小
titleFontSize
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
titleFontSize 类型
number
titleFontSize 约束
最小值: 此数字的值必须大于或等于: 1
titleFontSize 默认值
默认值为
20
titlePadding
图表标题顶部和底部的间距
titlePadding
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
titlePadding 类型
number
titlePadding 约束
最小值:此数字的值必须大于或等于:0
titlePadding 默认值
默认值为
10
showTitle
是否显示图表标题
showTitle
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
showTitle 类型
boolean
showTitle 默认值
默认值为
true
xAxis
此对象包含 XYChart 轴配置
xAxis
是必需的
类型:
object
(XYChart 轴配置)不可为空
定义于: Mermaid 配置
xAxis 类型
object
(XYChart 轴配置)
xAxis 默认值
默认值为
{
"$ref": "#/$defs/XYChartAxisConfig",
"title": "XYChart axis config",
"description": "This object contains configuration for XYChart axis config",
"type": "object",
"unevaluatedProperties": true,
"required": [
"showLabel",
"labelFontSize",
"labelPadding",
"showTitle",
"titleFontSize",
"titlePadding",
"showTick",
"tickLength",
"tickWidth",
"showAxisLine",
"axisLineWidth"
],
"properties": {
"showLabel": {
"description": "Should show the axis labels (tick text)",
"type": "boolean",
"default": true
},
"labelFontSize": {
"description": "font size of the axis labels (tick text)",
"type": "number",
"default": 14,
"minimum": 1
},
"labelPadding": {
"description": "top and bottom space from axis label (tick text)",
"type": "number",
"default": 5,
"minimum": 0
},
"showTitle": {
"description": "Should show the axis title",
"type": "boolean",
"default": true
},
"titleFontSize": {
"description": "font size of the axis title",
"type": "number",
"default": 16,
"minimum": 1
},
"titlePadding": {
"description": "top and bottom space from axis title",
"type": "number",
"default": 5,
"minimum": 0
},
"showTick": {
"description": "Should show the axis tick lines",
"type": "boolean",
"default": true
},
"tickLength": {
"description": "length of the axis tick lines",
"type": "number",
"default": 5,
"minimum": 1
},
"tickWidth": {
"description": "width of the axis tick lines",
"type": "number",
"default": 2,
"minimum": 1
},
"showAxisLine": {
"description": "Show line across the axis",
"type": "boolean",
"default": true
},
"axisLineWidth": {
"description": "Width of the axis line",
"type": "number",
"default": 2,
"minimum": 1
}
}
}
yAxis
此对象包含 XYChart 轴配置
yAxis
是必需的
类型:
object
(XYChart 轴配置)不可为空
定义于: Mermaid 配置
yAxis 类型
object
(XYChart 轴配置)
yAxis 默认值
默认值为
{
"$ref": "#/$defs/XYChartAxisConfig",
"title": "XYChart axis config",
"description": "This object contains configuration for XYChart axis config",
"type": "object",
"unevaluatedProperties": true,
"required": [
"showLabel",
"labelFontSize",
"labelPadding",
"showTitle",
"titleFontSize",
"titlePadding",
"showTick",
"tickLength",
"tickWidth",
"showAxisLine",
"axisLineWidth"
],
"properties": {
"showLabel": {
"description": "Should show the axis labels (tick text)",
"type": "boolean",
"default": true
},
"labelFontSize": {
"description": "font size of the axis labels (tick text)",
"type": "number",
"default": 14,
"minimum": 1
},
"labelPadding": {
"description": "top and bottom space from axis label (tick text)",
"type": "number",
"default": 5,
"minimum": 0
},
"showTitle": {
"description": "Should show the axis title",
"type": "boolean",
"default": true
},
"titleFontSize": {
"description": "font size of the axis title",
"type": "number",
"default": 16,
"minimum": 1
},
"titlePadding": {
"description": "top and bottom space from axis title",
"type": "number",
"default": 5,
"minimum": 0
},
"showTick": {
"description": "Should show the axis tick lines",
"type": "boolean",
"default": true
},
"tickLength": {
"description": "length of the axis tick lines",
"type": "number",
"default": 5,
"minimum": 1
},
"tickWidth": {
"description": "width of the axis tick lines",
"type": "number",
"default": 2,
"minimum": 1
},
"showAxisLine": {
"description": "Show line across the axis",
"type": "boolean",
"default": true
},
"axisLineWidth": {
"description": "Width of the axis line",
"type": "number",
"default": 2,
"minimum": 1
}
}
}
chartOrientation
如何绘制图表,水平或垂直
chartOrientation
是必需的
类型:未知
不可为空
定义于: Mermaid 配置
tsType:
"vertical" | "horizontal"
chartOrientation 类型
未知
chartOrientation 默认值
默认值为
"vertical"
plotReservedSpacePercent
图表中绘图所占空间的最小百分比
plotReservedSpacePercent
是必需的
类型:
number
不可为空
定义于: Mermaid 配置
plotReservedSpacePercent 类型
number
plotReservedSpacePercent 约束
最小值: 此数字的值必须大于或等于: 30
plotReservedSpacePercent 默认值
默认值为
50
定义组 ErDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/ErDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
titleTopMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
diagramPadding | integer | 必需 | 不可为空 | Mermaid 配置 |
layoutDirection | string | 必需 | 不可为空 | Mermaid 配置 |
minEntityWidth | integer | 必需 | 不可为空 | Mermaid 配置 |
minEntityHeight | integer | 必需 | 不可为空 | Mermaid 配置 |
entityPadding | integer | 必需 | 不可为空 | Mermaid 配置 |
stroke | string | 必需 | 不可为空 | Mermaid 配置 |
fill | string | 必需 | 不可为空 | Mermaid 配置 |
fontSize | integer | 可选 | 不可为空 | Mermaid 配置 |
titleTopMargin
图表上方的文本边距
titleTopMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
titleTopMargin 类型
integer
titleTopMargin 约束
最小值:此数字的值必须大于或等于:0
titleTopMargin 默认值
默认值为
25
diagramPadding
图表周围的填充量,用于为嵌入的图表设置边距,以像素为单位。
diagramPadding
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
diagramPadding 类型
integer
diagramPadding 约束
最小值:此数字的值必须大于或等于:0
diagramPadding 默认值
默认值为
20
layoutDirection
实体布局的方向偏差
layoutDirection
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
layoutDirection 类型
string
layoutDirection 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"TB" | 从上到下 |
"BT" | 从下到上 |
"LR" | 从左到右 |
"RL" | 从右到左 |
layoutDirection 默认值
默认值为
"TB"
minEntityWidth
实体框的最小宽度。以像素为单位。
minEntityWidth
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
minEntityWidth 类型
integer
minEntityWidth 约束
最小值:此数字的值必须大于或等于:0
minEntityWidth 默认值
默认值为
100
minEntityHeight
实体框的最小高度。以像素为单位。
minEntityHeight
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
minEntityHeight 类型
integer
minEntityHeight 约束
最小值:此数字的值必须大于或等于:0
minEntityHeight 默认值
默认值为
75
entityPadding
实体框内文本与包围框边框之间的最小内部填充量。以像素为单位。
entityPadding
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
entityPadding 类型
integer
entityPadding 约束
最小值:此数字的值必须大于或等于:0
entityPadding 默认值
默认值为
15
stroke
框边缘和线的描边颜色。
stroke
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
stroke 类型
string
stroke 默认值
默认值为
"gray"
fill
实体框的填充颜色
fill
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
fill 类型
string
fill 默认值
默认值为
"honeydew"
fontSize
字体大小(以表示像素数的整数表示)
fontSize
是可选的
类型:
integer
不可为空
定义于: Mermaid 配置
fontSize 类型
integer
fontSize 约束
最小值:此数字的值必须大于或等于:0
fontSize 默认值
默认值为
12
定义组 StateDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/StateDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
titleTopMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
arrowMarkerAbsolute | boolean | 可选 | 不可为空 | Mermaid 配置 |
dividerMargin | number | 可选 | 不可为空 | Mermaid 配置 |
sizeUnit | number | 可选 | 不可为空 | Mermaid 配置 |
padding | number | 可选 | 不可为空 | Mermaid 配置 |
textHeight | number | 可选 | 不可为空 | Mermaid 配置 |
titleShift | number | 可选 | 不可为空 | Mermaid 配置 |
noteMargin | number | 可选 | 不可为空 | Mermaid 配置 |
nodeSpacing | integer | 可选 | 不可为空 | Mermaid 配置 |
rankSpacing | integer | 可选 | 不可为空 | Mermaid 配置 |
forkWidth | number | 可选 | 不可为空 | Mermaid 配置 |
forkHeight | number | 可选 | 不可为空 | Mermaid 配置 |
miniPadding | number | 可选 | 不可为空 | Mermaid 配置 |
fontSizeFactor | number | 可选 | 不可为空 | Mermaid 配置 |
fontSize | number | 可选 | 不可为空 | Mermaid 配置 |
labelHeight | number | 可选 | 不可为空 | Mermaid 配置 |
edgeLengthFactor | string | 可选 | 不可为空 | Mermaid 配置 |
compositTitleSize | number | 可选 | 不可为空 | Mermaid 配置 |
radius | number | 可选 | 不可为空 | Mermaid 配置 |
defaultRenderer | string | 必需 | 不可为空 | Mermaid 配置 |
titleTopMargin
图表上方的文本边距
titleTopMargin
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
titleTopMargin 类型
integer
titleTopMargin 约束
最小值:此数字的值必须大于或等于:0
titleTopMargin 默认值
默认值为
25
arrowMarkerAbsolute
arrowMarkerAbsolute
是可选的
类型:
boolean
不可为空
定义于:Mermaid 配置
arrowMarkerAbsolute 类型
boolean
dividerMargin
dividerMargin
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
dividerMargin 类型
number
dividerMargin 默认值
默认值为
10
sizeUnit
sizeUnit
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
sizeUnit 类型
number
sizeUnit 默认值
默认值为
5
padding
padding
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
padding 类型
number
padding 默认值
默认值为
8
textHeight
textHeight
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
textHeight 类型
number
textHeight 默认值
默认值为
10
titleShift
titleShift
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
titleShift 类型
number
titleShift 默认值
默认值为
-15
noteMargin
noteMargin
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
noteMargin 类型
number
noteMargin 默认值
默认值为
10
nodeSpacing
nodeSpacing
是可选的
类型:
integer
不可为空
定义于:Mermaid 配置
nodeSpacing 类型
integer
nodeSpacing 约束
最小值:此数字的值必须大于或等于:0
rankSpacing
rankSpacing
是可选的
类型:
integer
不可为空
定义于:Mermaid 配置
rankSpacing 类型
integer
rankSpacing 约束
最小值:此数字的值必须大于或等于:0
forkWidth
forkWidth
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
forkWidth 类型
number
forkWidth 默认值
默认值为
70
forkHeight
forkHeight
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
forkHeight 类型
number
forkHeight 默认值
默认值为
7
miniPadding
miniPadding
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
miniPadding 类型
number
miniPadding 默认值
默认值为
2
fontSizeFactor
字体大小系数,用于在dagre布局渲染之前猜测边标签的宽度。 如果/当切换字体时,可能需要更新。
fontSizeFactor
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
fontSizeFactor 类型
number
fontSizeFactor 默认值
默认值为
5.02
fontSize
fontSize
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
fontSize 类型
number
fontSize 默认值
默认值为
24
labelHeight
labelHeight
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
labelHeight 类型
number
labelHeight 默认值
默认值为
16
edgeLengthFactor
edgeLengthFactor
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
edgeLengthFactor 类型
string
edgeLengthFactor 默认值
默认值为
"20"
compositTitleSize
compositTitleSize
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
compositTitleSize 类型
number
compositTitleSize 默认值
默认值为
35
radius
radius
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
radius 类型
number
radius 默认值
默认值为
5
defaultRenderer
决定用于渲染的渲染引擎。
defaultRenderer
是必需的
类型:
string
不可为空
定义于:Mermaid 配置
defaultRenderer 类型
string
defaultRenderer 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"dagre-d3" | The [dagre-d3-es](https://npmjs.net.cn/package/dagre-d3-es) library. |
"dagre-wrapper" | 在 mermaid 中实现的 dagre 包装器 |
"elk" | 使用 [elkjs](https://github.com/kieler/elkjs) 进行布局 |
defaultRenderer 默认值
默认值为
"dagre-wrapper"
定义组 ClassDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/ClassDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
titleTopMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
arrowMarkerAbsolute | boolean | 可选 | 不可为空 | Mermaid 配置 |
dividerMargin | number | 可选 | 不可为空 | Mermaid 配置 |
padding | number | 可选 | 不可为空 | Mermaid 配置 |
textHeight | number | 可选 | 不可为空 | Mermaid 配置 |
defaultRenderer | string | 必需 | 不可为空 | Mermaid 配置 |
nodeSpacing | integer | 可选 | 不可为空 | Mermaid 配置 |
rankSpacing | integer | 可选 | 不可为空 | Mermaid 配置 |
diagramPadding | integer | 可选 | 不可为空 | Mermaid 配置 |
htmlLabels | boolean | 可选 | 不可为空 | Mermaid 配置 |
hideEmptyMembersBox | boolean | 可选 | 不可为空 | Mermaid 配置 |
titleTopMargin
图表上方的文本边距
titleTopMargin
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
titleTopMargin 类型
integer
titleTopMargin 约束
最小值:此数字的值必须大于或等于:0
titleTopMargin 默认值
默认值为
25
arrowMarkerAbsolute
控制 html 代码中的箭头标记是绝对路径还是锚点。这在您使用 base 标签设置时很重要。
arrowMarkerAbsolute
是可选的
类型:
boolean
不可为空
定义在: Mermaid 配置
arrowMarkerAbsolute 类型
boolean
dividerMargin
dividerMargin
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
dividerMargin 类型
number
dividerMargin 默认值
默认值为
10
padding
padding
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
padding 类型
number
padding 默认值
默认值为
5
textHeight
textHeight
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
textHeight 类型
number
textHeight 默认值
默认值为
10
defaultRenderer
决定用于渲染的渲染引擎。
defaultRenderer
是必需的
类型:
string
不可为空
定义于:Mermaid 配置
defaultRenderer 类型
string
defaultRenderer 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"dagre-d3" | The [dagre-d3-es](https://npmjs.net.cn/package/dagre-d3-es) library. |
"dagre-wrapper" | 在 mermaid 中实现的 dagre 包装器 |
"elk" | 使用 [elkjs](https://github.com/kieler/elkjs) 进行布局 |
defaultRenderer 默认值
默认值为
"dagre-wrapper"
nodeSpacing
nodeSpacing
是可选的
类型:
integer
不可为空
定义于: Mermaid 配置
nodeSpacing 类型
integer
nodeSpacing 约束
最小值:此数字的值必须大于或等于:0
rankSpacing
rankSpacing
是可选的
类型:
integer
不可为空
定义于: Mermaid 配置
rankSpacing 类型
integer
rankSpacing 约束
最小值:此数字的值必须大于或等于:0
diagramPadding
图表周围的填充量,用于为嵌入的图表设置边距,以像素为单位。
diagramPadding
是可选的
类型:
integer
不可为空
定义于: Mermaid 配置
diagramPadding 类型
integer
diagramPadding 约束
最小值:此数字的值必须大于或等于:0
diagramPadding 默认值
默认值为
20
htmlLabels
htmlLabels
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
htmlLabels 类型
boolean
hideEmptyMembersBox
hideEmptyMembersBox
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
hideEmptyMembersBox 类型
boolean
定义组 JourneyDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/JourneyDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
diagramMarginX | integer | 必需 | 不可为空 | Mermaid 配置 |
diagramMarginY | integer | 必需 | 不可为空 | Mermaid 配置 |
leftMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
width | integer | 必需 | 不可为空 | Mermaid 配置 |
height | integer | 必需 | 不可为空 | Mermaid 配置 |
boxMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
boxTextMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
noteMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
messageMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
messageAlign | string | 必需 | 不可为空 | Mermaid 配置 |
bottomMarginAdj | integer | 必需 | 不可为空 | Mermaid 配置 |
rightAngles | boolean | 必需 | 不可为空 | Mermaid 配置 |
taskFontSize | 多个 | 可选 | 不可为空 | Mermaid 配置 |
taskFontFamily | string | 可选 | 不可为空 | Mermaid 配置 |
taskMargin | number | 可选 | 不可为空 | Mermaid 配置 |
activationWidth | number | 可选 | 不可为空 | Mermaid 配置 |
textPlacement | string | 可选 | 不可为空 | Mermaid 配置 |
actorColours | array | 可选 | 不可为空 | Mermaid 配置 |
sectionFills | array | 可选 | 不可为空 | Mermaid 配置 |
sectionColours | array | 可选 | 不可为空 | Mermaid 配置 |
diagramMarginX
c4 图表左右的边距,必须为正值。
diagramMarginX
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
diagramMarginX 类型
integer
diagramMarginX 约束
最小值:此数字的值必须大于或等于:0
diagramMarginX 默认值
默认值为
50
diagramMarginY
c4 图表上下边距,必须为正值。
diagramMarginY
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
diagramMarginY 类型
integer
diagramMarginY 约束
最小值:此数字的值必须大于或等于:0
diagramMarginY 默认值
默认值为
10
leftMargin
演员之间的间距
leftMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
leftMargin 类型
integer
leftMargin 约束
最小值:此数字的值必须大于或等于:0
leftMargin 默认值
默认值为
150
width
演员框的宽度
width
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
width 类型
integer
width 约束
最小值:此数字的值必须大于或等于:0
width 默认值
默认值为
150
height
演员框的高度
height
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
height 类型
integer
height 约束
最小值:此数字的值必须大于或等于:0
height 默认值
默认值为
50
boxMargin
循环框周围的间距
boxMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
boxMargin 类型
integer
boxMargin 约束
最小值:此数字的值必须大于或等于:0
boxMargin 默认值
默认值为
10
boxTextMargin
循环/替代/可选框内文本周围的间距
boxTextMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
boxTextMargin 类型
integer
boxTextMargin 约束
最小值:此数字的值必须大于或等于:0
boxTextMargin 默认值
默认值为
5
noteMargin
注释周围的间距
noteMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
noteMargin 类型
integer
noteMargin 约束
最小值:此数字的值必须大于或等于:0
noteMargin 默认值
默认值为
10
messageMargin
消息之间的间距。
messageMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
messageMargin 类型
integer
messageMargin 约束
最小值:此数字的值必须大于或等于:0
messageMargin 默认值
默认值为
35
messageAlign
多行消息对齐
messageAlign
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
messageAlign 类型
string
messageAlign 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"left" | |
"center" | |
"right" |
messageAlign 默认值
默认值为
"center"
bottomMarginAdj
将图表的边缘向下延伸。
根据 css 样式,这可能需要调整。
bottomMarginAdj
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
bottomMarginAdj 类型
integer
bottomMarginAdj 约束
最小值:此数字的值必须大于或等于:0
bottomMarginAdj 默认值
默认值为
1
rightAngles
弯曲箭头变为直角
这将显示以相同节点开始和结束的箭头为直角,而不是曲线。
rightAngles
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
rightAngles 类型
boolean
taskFontSize
taskFontSize
是可选的
类型: 以下任意一种:
string
或number
(详情)不可为空
定义于: Mermaid 配置
taskFontSize 类型
以下任意一种: string
或 number
(详情)
taskFontSize 默认值
默认值为
14
taskFontFamily
taskFontFamily
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
taskFontFamily 类型
string
taskFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
taskMargin
taskMargin
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
taskMargin 类型
number
taskMargin 默认值
默认值为
50
activationWidth
激活框的宽度
activationWidth
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
activationWidth 类型
number
activationWidth 默认值
默认值为
10
textPlacement
文本放置位置:tspan | fo | 仅限旧版本文本,与之前相同
textPlacement
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
textPlacement 类型
string
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"]
定义组 TimelineDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/TimelineDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
diagramMarginX | integer | 必需 | 不可为空 | Mermaid 配置 |
diagramMarginY | integer | 必需 | 不可为空 | Mermaid 配置 |
leftMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
width | integer | 必需 | 不可为空 | Mermaid 配置 |
height | integer | 必需 | 不可为空 | Mermaid 配置 |
padding | number | 可选 | 不可为空 | Mermaid 配置 |
boxMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
boxTextMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
noteMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
messageMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
messageAlign | string | 必需 | 不可为空 | Mermaid 配置 |
bottomMarginAdj | integer | 必需 | 不可为空 | Mermaid 配置 |
rightAngles | boolean | 可选 | 不可为空 | Mermaid 配置 |
taskFontSize | 多个 | 可选 | 不可为空 | Mermaid 配置 |
taskFontFamily | string | 可选 | 不可为空 | Mermaid 配置 |
taskMargin | number | 可选 | 不可为空 | Mermaid 配置 |
activationWidth | number | 可选 | 不可为空 | Mermaid 配置 |
textPlacement | string | 可选 | 不可为空 | Mermaid 配置 |
actorColours | array | 可选 | 不可为空 | Mermaid 配置 |
sectionFills | array | 可选 | 不可为空 | Mermaid 配置 |
sectionColours | array | 可选 | 不可为空 | Mermaid 配置 |
disableMulticolor | boolean | 可选 | 不可为空 | Mermaid 配置 |
diagramMarginX
c4 图表左右的边距,必须为正值。
diagramMarginX
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
diagramMarginX 类型
integer
diagramMarginX 约束
最小值:此数字的值必须大于或等于:0
diagramMarginX 默认值
默认值为
50
diagramMarginY
c4 图表上下边距,必须为正值。
diagramMarginY
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
diagramMarginY 类型
integer
diagramMarginY 约束
最小值:此数字的值必须大于或等于:0
diagramMarginY 默认值
默认值为
10
leftMargin
演员之间的间距
leftMargin
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
leftMargin 类型
integer
leftMargin 约束
最小值:此数字的值必须大于或等于:0
leftMargin 默认值
默认值为
150
width
演员框的宽度
width
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
width 类型
integer
width 约束
最小值:此数字的值必须大于或等于:0
width 默认值
默认值为
150
height
演员框的高度
height
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
height 类型
integer
height 约束
最小值:此数字的值必须大于或等于:0
height 默认值
默认值为
50
padding
padding
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
padding 类型
number
boxMargin
循环框周围的间距
boxMargin
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
boxMargin 类型
integer
boxMargin 约束
最小值:此数字的值必须大于或等于:0
boxMargin 默认值
默认值为
10
boxTextMargin
循环/替代/可选框内文本周围的间距
boxTextMargin
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
boxTextMargin 类型
integer
boxTextMargin 约束
最小值:此数字的值必须大于或等于:0
boxTextMargin 默认值
默认值为
5
noteMargin
注释周围的间距
noteMargin
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
noteMargin 类型
integer
noteMargin 约束
最小值:此数字的值必须大于或等于:0
noteMargin 默认值
默认值为
10
messageMargin
消息之间的间距。
messageMargin
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
messageMargin 类型
integer
messageMargin 约束
最小值:此数字的值必须大于或等于:0
messageMargin 默认值
默认值为
35
messageAlign
多行消息对齐
messageAlign
是必需的
类型:
string
不可为空
定义于:Mermaid 配置
messageAlign 类型
string
messageAlign 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"left" | |
"center" | |
"right" |
messageAlign 默认值
默认值为
"center"
bottomMarginAdj
将图表的边缘向下延伸。
根据 css 样式,这可能需要调整。
bottomMarginAdj
是必需的
类型:
integer
不可为空
定义于:Mermaid 配置
bottomMarginAdj 类型
integer
bottomMarginAdj 约束
最小值:此数字的值必须大于或等于:0
bottomMarginAdj 默认值
默认值为
1
rightAngles
弯曲箭头变为直角
这将显示以相同节点开始和结束的箭头为直角,而不是曲线。
rightAngles
是可选的
类型:
boolean
不可为空
定义于:Mermaid 配置
rightAngles 类型
boolean
taskFontSize
taskFontSize
是可选的
类型:以下任一:
string
或number
(详细信息)不可为空
定义于:Mermaid 配置
taskFontSize 类型
以下任一:string
或 number
(详细信息)
taskFontSize 默认值
默认值为
14
taskFontFamily
taskFontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
taskFontFamily 类型
string
taskFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
taskMargin
taskMargin
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
taskMargin 类型
number
taskMargin 默认值
默认值为
50
activationWidth
激活框的宽度
activationWidth
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
activationWidth 类型
number
activationWidth 默认值
默认值为
10
textPlacement
文本放置位置:tspan | fo | 仅限旧版本文本,与之前相同
textPlacement
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
textPlacement 类型
string
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"]
disableMulticolor
disableMulticolor
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
disableMulticolor 类型
boolean
定义组 GanttDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/GanttDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
titleTopMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
barHeight | integer | 必需 | 不可为空 | Mermaid 配置 |
barGap | integer | 可选 | 不可为空 | Mermaid 配置 |
topPadding | integer | 必需 | 不可为空 | Mermaid 配置 |
rightPadding | integer | 必需 | 不可为空 | Mermaid 配置 |
leftPadding | integer | 必需 | 不可为空 | Mermaid 配置 |
gridLineStartPadding | integer | 必需 | 不可为空 | Mermaid 配置 |
fontSize | integer | 必需 | 不可为空 | Mermaid 配置 |
sectionFontSize | integer | 必需 | 不可为空 | Mermaid 配置 |
numberSectionStyles | integer | 必需 | 不可为空 | Mermaid 配置 |
axisFormat | string | 必需 | 不可为空 | Mermaid 配置 |
tickInterval | string | 可选 | 不可为空 | Mermaid 配置 |
topAxis | boolean | 必需 | 不可为空 | Mermaid 配置 |
displayMode | string | 可选 | 不可为空 | Mermaid 配置 |
weekday | string | 必需 | 不可为空 | Mermaid 配置 |
titleTopMargin
图表上方的文本边距
titleTopMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
titleTopMargin 类型
integer
titleTopMargin 约束
最小值:此数字的值必须大于或等于:0
titleTopMargin 默认值
默认值为
25
barHeight
图表中条形的的高度
barHeight
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
barHeight 类型
integer
barHeight 约束
最小值:此数字的值必须大于或等于:0
barHeight 默认值
默认值为
20
barGap
甘特图中不同活动之间的间距
barGap
是可选的
类型:
integer
不可为空
定义于: Mermaid 配置
barGap 类型
integer
barGap 约束
最小值:此数字的值必须大于或等于:0
barGap 默认值
默认值为
4
topPadding
标题和甘特图之间,以及轴和甘特图之间的间距。
topPadding
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
topPadding 类型
integer
topPadding 约束
最小值:此数字的值必须大于或等于:0
topPadding 默认值
默认值为
50
rightPadding
分配给活动右侧部分名称的空间
rightPadding
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
rightPadding 类型
integer
rightPadding 约束
最小值:此数字的值必须大于或等于:0
rightPadding 默认值
默认值为
75
leftPadding
分配给活动左侧部分名称的空间
leftPadding
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
leftPadding 类型
integer
leftPadding 约束
最小值:此数字的值必须大于或等于:0
leftPadding 默认值
默认值为
75
gridLineStartPadding
网格线的垂直起始位置
gridLineStartPadding
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
gridLineStartPadding 类型
integer
gridLineStartPadding 约束
最小值:此数字的值必须大于或等于:0
gridLineStartPadding 默认值
默认值为
35
fontSize
字体大小
fontSize
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
fontSize 类型
integer
fontSize 约束
最小值:此数字的值必须大于或等于:0
fontSize 默认值
默认值为
11
sectionFontSize
部分的字体大小
sectionFontSize
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
tsType:
string | number
sectionFontSize 类型
integer
sectionFontSize 约束
最小值:此数字的值必须大于或等于:0
sectionFontSize 默认值
默认值为
11
numberSectionStyles
交替部分样式的数量
numberSectionStyles
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
numberSectionStyles 类型
integer
numberSectionStyles 约束
最小值:此数字的值必须大于或等于:0
numberSectionStyles 默认值
默认值为
4
axisFormat
轴的日期/时间格式
这可能需要调整以匹配您的区域设置和偏好。
axisFormat
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
axisFormat 类型
string
axisFormat 默认值
默认值为
"%Y-%m-%d"
tickInterval
轴刻度
模式是
/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/;
tickInterval
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
tickInterval 类型
string
tickInterval 约束
模式: 字符串必须匹配以下正则表达式
/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/
topAxis
当设置此标志时,日期标签将添加到图表顶部
topAxis
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
topAxis 类型
boolean
displayMode
控制显示模式。
displayMode
是可选的
类型:
string
不可为空
定义于: Mermaid 配置
displayMode 类型
string
displayMode 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"" | |
"compact" | 允许在同一行显示多个任务。 |
weekday
基于周的间隔应从哪天开始
weekday
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
weekday 类型
string
weekday 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"monday" | |
"tuesday" | |
"wednesday" | |
"thursday" | |
"friday" | |
"saturday" | |
"sunday" |
weekday 默认值
默认值为
"sunday"
定义组 SequenceDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/SequenceDiagramConfig" }
arrowMarkerAbsolute
arrowMarkerAbsolute
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
arrowMarkerAbsolute 类型
boolean
hideUnusedParticipants
hideUnusedParticipants
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
hideUnusedParticipants 类型
boolean
activationWidth
激活矩形的宽度
activationWidth
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
activationWidth 类型
integer
activationWidth 约束
最小值:此数字的值必须大于或等于:0
activationWidth 默认值
默认值为
10
diagramMarginX
序列图左右两侧的边距
diagramMarginX
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
diagramMarginX 类型
integer
diagramMarginX 约束
最小值:此数字的值必须大于或等于:0
diagramMarginX 默认值
默认值为
50
diagramMarginY
序列图上下两侧的边距
diagramMarginY
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
diagramMarginY 类型
integer
diagramMarginY 约束
最小值:此数字的值必须大于或等于:0
diagramMarginY 默认值
默认值为
10
actorMargin
演员之间的间距
actorMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
actorMargin 类型
integer
actorMargin 约束
最小值:此数字的值必须大于或等于:0
actorMargin 默认值
默认值为
50
width
演员框的宽度
width
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
width 类型
integer
width 约束
最小值:此数字的值必须大于或等于:0
width 默认值
默认值为
150
height
演员框的高度
height
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
height 类型
integer
height 约束
最小值:此数字的值必须大于或等于:0
height 默认值
默认值为
50
boxMargin
循环框周围的间距
boxMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
boxMargin 类型
integer
boxMargin 约束
最小值:此数字的值必须大于或等于:0
boxMargin 默认值
默认值为
10
boxTextMargin
循环/替代/可选框内文本周围的间距
boxTextMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
boxTextMargin 类型
integer
boxTextMargin 约束
最小值:此数字的值必须大于或等于:0
boxTextMargin 默认值
默认值为
5
noteMargin
注释周围的间距
noteMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
noteMargin 类型
integer
noteMargin 约束
最小值:此数字的值必须大于或等于:0
noteMargin 默认值
默认值为
10
messageMargin
消息之间的间距。
messageMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
messageMargin 类型
integer
messageMargin 约束
最小值:此数字的值必须大于或等于:0
messageMargin 默认值
默认值为
35
messageAlign
多行消息对齐
messageAlign
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
messageAlign 类型
string
messageAlign 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"left" | |
"center" | |
"right" |
messageAlign 默认值
默认值为
"center"
mirrorActors
镜像图下方的角色
mirrorActors
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
mirrorActors 类型
boolean
mirrorActors 默认值
默认值为
true
forceMenus
强制角色弹出菜单始终可见(用于支持 E2E 测试)。
forceMenus
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
forceMenus 类型
boolean
bottomMarginAdj
将图表的边缘向下延伸。
根据 css 样式,这可能需要调整。
bottomMarginAdj
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
bottomMarginAdj 类型
integer
bottomMarginAdj 约束
最小值:此数字的值必须大于或等于:0
bottomMarginAdj 默认值
默认值为
1
rightAngles
弯曲箭头变为直角
这将显示以相同节点开始和结束的箭头为直角,而不是曲线。
rightAngles
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
rightAngles 类型
boolean
showSequenceNumbers
这将显示节点编号
showSequenceNumbers
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
showSequenceNumbers 类型
boolean
actorFontSize
这将设置角色描述的字体大小
actorFontSize
是必需的
类型: 以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
actorFontSize 类型
以下之一: string
或 number
(详情)
actorFontSize 默认值
默认值为
14
actorFontFamily
这将设置角色描述的字体系列
actorFontFamily
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
actorFontFamily 类型
string
actorFontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
actorFontWeight
这将设置角色描述的字体粗细
actorFontWeight
是必需的
类型: 以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
actorFontWeight 类型
以下之一: string
或 number
(详情)
actorFontWeight 默认值
默认值为
400
noteFontSize
这将设置角色附带笔记的字体大小
noteFontSize
是必需的
类型: 以下之一:
string
或number
(详情)不可为空
定义于: Mermaid 配置
noteFontSize 类型
以下之一: string
或 number
(详情)
noteFontSize 默认值
默认值为
14
noteFontFamily
设置与角色关联的备注的字体家族。
noteFontFamily
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
noteFontFamily 类型
string
noteFontFamily 默认值
默认值为
"\"trebuchet ms\", verdana, arial, sans-serif"
noteFontWeight
设置与角色关联的备注的字体粗细。
noteFontWeight
是必需的
类型: 以下之一:
string
或number
(详细信息)不可为空
定义于: Mermaid 配置
noteFontWeight 类型
以下之一: string
或 number
(详细信息)
noteFontWeight 默认值
默认值为
400
noteAlign
设置与角色关联的备注的文本对齐方式。
noteAlign
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
noteAlign 类型
string
noteAlign 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"left" | |
"center" | |
"right" |
noteAlign 默认值
默认值为
"center"
messageFontSize
设置角色消息的字体大小。
messageFontSize
是必需的
类型: 以下之一:
string
或number
(详细信息)不可为空
定义于: Mermaid 配置
messageFontSize 类型
以下之一: string
或 number
(详细信息)
messageFontSize 默认值
默认值为
16
messageFontFamily
设置角色消息的字体家族。
messageFontFamily
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
messageFontFamily 类型
string
messageFontFamily 默认值
默认值为
"\"trebuchet ms\", verdana, arial, sans-serif"
messageFontWeight
设置角色消息的字体粗细。
messageFontWeight
是必需的
类型: 以下之一:
string
或number
(详细信息)不可为空
定义于: Mermaid 配置
messageFontWeight 类型
以下之一: string
或 number
(详细信息)
messageFontWeight 默认值
默认值为
400
wrap
这设置了图表的自动换行状态。
wrap
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
wrap 类型
boolean
wrapPadding
这设置了图表的自动换行填充(仅两侧)。
wrapPadding
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
wrapPadding 类型
number
wrapPadding 默认值
默认值为
10
labelBoxWidth
设置循环框(循环、alt、opt、par)的宽度。
labelBoxWidth
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
labelBoxWidth 类型
number
labelBoxWidth 默认值
默认值为
50
labelBoxHeight
设置循环框(循环、alt、opt、par)的高度。
labelBoxHeight
是可选的
类型:
number
不可为空
定义于: Mermaid 配置
labelBoxHeight 类型
number
labelBoxHeight 默认值
默认值为
20
messageFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
messageFont
是可选的
类型: 未知 (字体计算器)
不可为空
定义于: Mermaid 配置
tsType:
() => Partial<FontConfig>
messageFont 类型
未知 (字体计算器)
noteFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
noteFont
是可选的
类型: 未知 (字体计算器)
不可为空
定义于: Mermaid 配置
tsType:
() => Partial<FontConfig>
noteFont 类型
未知 (字体计算器)
actorFont
返回 FontConfig
的 JavaScript 函数。
默认情况下,这些函数会返回相应的 *FontSize
、*FontFamily
和 *FontWeight
值。
例如,名为 boundaryFont
的字体计算器可以定义为
boundaryFont: function () {
return {
fontFamily: this.boundaryFontFamily,
fontSize: this.boundaryFontSize,
fontWeight: this.boundaryFontWeight,
};
}
actorFont
是可选的
类型: 未知 (字体计算器)
不可为空
定义于: Mermaid 配置
tsType:
() => Partial<FontConfig>
actorFont 类型
未知 (字体计算器)
定义组 FlowchartDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/FlowchartDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
titleTopMargin | integer | 必需 | 不可为空 | Mermaid 配置 |
subGraphTitleMargin | object | 必需 | 不可为空 | Mermaid 配置 |
arrowMarkerAbsolute | boolean | 可选 | 不可为空 | Mermaid 配置 |
diagramPadding | integer | 必需 | 不可为空 | Mermaid 配置 |
htmlLabels | boolean | 必需 | 不可为空 | Mermaid 配置 |
nodeSpacing | integer | 必需 | 不可为空 | Mermaid 配置 |
rankSpacing | integer | 必需 | 不可为空 | Mermaid 配置 |
curve | string | 必需 | 不可为空 | Mermaid 配置 |
padding | number | 可选 | 不可为空 | Mermaid 配置 |
defaultRenderer | string | 必需 | 不可为空 | Mermaid 配置 |
wrappingWidth | number | 必需 | 不可为空 | Mermaid 配置 |
titleTopMargin
图表上方的文本边距
titleTopMargin
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
titleTopMargin 类型
integer
titleTopMargin 约束
最小值:此数字的值必须大于或等于:0
titleTopMargin 默认值
默认值为
25
subGraphTitleMargin
定义子图标题的顶部/底部边距。
subGraphTitleMargin
是必需的
类型:
object
(详细信息)不可为空
定义于: Mermaid 配置
subGraphTitleMargin 类型
object
(详细信息)
subGraphTitleMargin 默认值
默认值为
{
"top": 0,
"bottom": 0
}
arrowMarkerAbsolute
arrowMarkerAbsolute
是可选的
类型:
boolean
不可为空
定义于: Mermaid 配置
arrowMarkerAbsolute 类型
boolean
diagramPadding
图表周围的填充量,用于为嵌入的图表设置边距,以像素为单位。
diagramPadding
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
diagramPadding 类型
integer
diagramPadding 约束
最小值:此数字的值必须大于或等于:0
diagramPadding 默认值
默认值为
20
htmlLabels
用于设置是否应使用 html 标签来渲染边上的标签的标志。
htmlLabels
是必需的
类型:
boolean
不可为空
定义于: Mermaid 配置
htmlLabels 类型
boolean
htmlLabels 默认值
默认值为
true
nodeSpacing
定义同一层级上节点之间的间距。
适用于 TB(从上到下)或 BT(从下到上)图的水平间距,以及 LR 和 RL 图的垂直间距。
nodeSpacing
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
nodeSpacing 类型
integer
nodeSpacing 约束
最小值:此数字的值必须大于或等于:0
nodeSpacing 默认值
默认值为
50
rankSpacing
定义不同层级上节点之间的间距。
适用于 TB(从上到下)或 BT(从下到上)图的水平间距,以及 LR 和 RL 图的垂直间距。
rankSpacing
是必需的
类型:
integer
不可为空
定义于: Mermaid 配置
rankSpacing 类型
integer
rankSpacing 约束
最小值:此数字的值必须大于或等于:0
rankSpacing 默认值
默认值为
50
curve
定义 mermaid 如何渲染流程图的曲线。
curve
是必需的
类型:
string
不可为空
定义于: Mermaid 配置
curve 类型
string
curve 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"basis" | |
"linear" | |
"cardinal" |
curve 默认值
默认值为
"basis"
padding
表示标签和形状之间的填充。
仅在新的实验性渲染中使用。
padding
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
padding 类型
number
padding 默认值
默认值为
15
defaultRenderer
决定用于渲染的渲染引擎。
defaultRenderer
是必需的
类型:
string
不可为空
定义于:Mermaid 配置
defaultRenderer 类型
string
defaultRenderer 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"dagre-d3" | The [dagre-d3-es](https://npmjs.net.cn/package/dagre-d3-es) library. |
"dagre-wrapper" | 在 mermaid 中实现的 dagre 包装器 |
"elk" | 使用 [elkjs](https://github.com/kieler/elkjs) 进行布局 |
defaultRenderer 默认值
默认值为
"dagre-wrapper"
wrappingWidth
文本换行的节点宽度。
使用 markdown 字符串时,文本会自动换行,此值设置文本在换行前允许的最大宽度。
wrappingWidth
是必需的
类型:
number
不可为空
定义于:Mermaid 配置
wrappingWidth 类型
number
wrappingWidth 默认值
默认值为
200
定义组 SankeyLinkColor
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/SankeyLinkColor" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|
定义组 SankeyNodeAlignment
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/SankeyNodeAlignment" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|
定义组 SankeyDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/SankeyDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
width | number | 可选 | 不可为空 | Mermaid 配置 |
height | number | 可选 | 不可为空 | Mermaid 配置 |
linkColor | 合并 | 可选 | 不可为空 | Mermaid 配置 |
nodeAlignment | string | 可选 | 不可为空 | Mermaid 配置 |
useMaxWidth | boolean | 可选 | 不可为空 | Mermaid 配置 |
showValues | boolean | 可选 | 不可为空 | Mermaid 配置 |
prefix | string | 可选 | 不可为空 | Mermaid 配置 |
suffix | string | 可选 | 不可为空 | Mermaid 配置 |
width
width
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
width 类型
number
width 默认值
默认值为
600
height
height
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
height 类型
number
height 默认值
默认值为
400
linkColor
Sankey 图中连接线的颜色。
linkColor
是可选的
类型:合并类型 (详细信息)
不可为空
定义于:Mermaid 配置
linkColor 类型
合并类型 (详细信息)
任何一种
linkColor 默认值
默认值为
"gradient"
nodeAlignment
控制 Sankey 图的对齐方式。
参见 https://github.com/d3/d3-sankey#alignments.
nodeAlignment
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
nodeAlignment 类型
string
nodeAlignment 约束
枚举:此属性的值必须等于以下值之一
值 | 解释 |
---|---|
"left" | 将所有输入对齐到左侧。 |
"right" | 将所有输出对齐到右侧。 |
"center" | 与 `left` 相似,但将没有入站链接的节点尽可能向右移动。 |
"justify" | 与 `left` 相似,但将没有出站链接的节点移到最右侧。 |
nodeAlignment 默认值
默认值为
"justify"
useMaxWidth
useMaxWidth
是可选的
类型:
boolean
不可为空
定义于:Mermaid 配置
useMaxWidth 类型
boolean
showValues
切换以显示或隐藏值以及标题。
showValues
是可选的
类型:
boolean
不可为空
定义于:Mermaid 配置
showValues 类型
boolean
showValues 默认值
默认值为
true
prefix
用于值的的前缀
prefix
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
prefix 类型
string
suffix
用于值的的后缀
suffix
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
suffix 类型
string
定义组 PacketDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/PacketDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
rowHeight | number | 可选 | 不可为空 | Mermaid 配置 |
bitWidth | number | 可选 | 不可为空 | Mermaid 配置 |
bitsPerRow | number | 可选 | 不可为空 | Mermaid 配置 |
showBits | boolean | 可选 | 不可为空 | Mermaid 配置 |
paddingX | number | 可选 | 不可为空 | Mermaid 配置 |
paddingY | number | 可选 | 不可为空 | Mermaid 配置 |
rowHeight
数据包图中每行的高度。
rowHeight
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
rowHeight 类型
number
rowHeight 约束
最小值: 此数字的值必须大于或等于: 1
rowHeight 默认值
默认值为
32
bitWidth
数据包图中每个位的宽度。
bitWidth
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
bitWidth 类型
number
bitWidth 约束
最小值: 此数字的值必须大于或等于: 1
bitWidth 默认值
默认值为
32
bitsPerRow
每行显示的位数。
bitsPerRow
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
bitsPerRow 类型
number
bitsPerRow 约束
最小值: 此数字的值必须大于或等于: 1
bitsPerRow 默认值
默认值为
32
showBits
切换以显示或隐藏位号。
showBits
是可选的
类型:
boolean
不可为空
定义于:Mermaid 配置
showBits 类型
boolean
showBits 默认值
默认值为
true
paddingX
一行中块之间的水平间距。
paddingX
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
paddingX 类型
number
paddingX 约束
最小值:此数字的值必须大于或等于:0
paddingX 默认值
默认值为
5
paddingY
行之间的垂直间距。
paddingY
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
paddingY 类型
number
paddingY 约束
最小值:此数字的值必须大于或等于:0
paddingY 默认值
默认值为
5
定义组 BlockDiagramConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/BlockDiagramConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
padding | number | 可选 | 不可为空 | Mermaid 配置 |
padding
padding
是可选的
类型:
number
不可为空
定义于:Mermaid 配置
padding 类型
number
padding 约束
最小值:此数字的值必须大于或等于:0
padding 默认值
默认值为
8
定义组 FontCalculator
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/FontCalculator" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|
定义组 FontConfig
使用以下方式引用该组
{ "$ref": "https://mermaid.npmjs.net.cn/schemas/config.schema.json#/$defs/FontConfig" }
属性 | 类型 | 必需 | 可空 | 定义于 |
---|---|---|---|---|
fontSize | 多个 | 可选 | 不可为空 | Mermaid 配置 |
fontFamily | string | 可选 | 不可为空 | Mermaid 配置 |
fontWeight | 多个 | 可选 | 不可为空 | Mermaid 配置 |
fontSize
要使用的字体大小
fontSize
是可选的
类型:以下任何一种:
string
或number
(CSS 字体大小)不可为空
定义于:Mermaid 配置
fontSize 类型
以下任何一种:string
或 number
(CSS 字体大小)
fontSize 默认值
默认值为
14
fontFamily
要使用的 CSS font-family
。
fontFamily
是可选的
类型:
string
不可为空
定义于:Mermaid 配置
fontFamily 类型
string
fontFamily 默认值
默认值为
"\"Open Sans\", sans-serif"
fontWeight
要使用的字体粗细。
fontWeight
是可选的
类型:以下任一:
string
或number
(详情)不可为空
定义于:Mermaid 配置
fontWeight 类型
以下任一:string
或 number
(详情)
fontWeight 默认值
默认值为
"normal"