主题
Interface: MermaidConfig
mermaid.MermaidConfig
Properties
altFontFamily
• Optional altFontFamily: string
Defined in
packages/mermaid/src/config.type.ts:117
architecture
• Optional architecture: ArchitectureDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:173
arrowMarkerAbsolute
• Optional arrowMarkerAbsolute: boolean
控制 html 代码中的箭头标记是绝对路径还是锚点。如果你使用基本标签设置，这很重要。
Defined in
packages/mermaid/src/config.type.ts:135
block
• Optional block: BlockDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:180
c4
• Optional c4: C4DiagramConfig
Defined in
packages/mermaid/src/config.type.ts:177
class
• Optional class: ClassDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:166
darkMode
• Optional darkMode: boolean
Defined in
packages/mermaid/src/config.type.ts:109
deterministicIDSeed
• Optional deterministicIDSeed: string
此选项是确定性 ID 的可选种子。如果设置为 undefined 但 deterministicIds 是 true，则使用简单的数字迭代器。你可以设置此属性以基于静态字符串的种子。
Defined in
packages/mermaid/src/config.type.ts:160
deterministicIds
• Optional deterministicIds: boolean
此选项控制 SVG 中节点的生成 ID 是随机生成的还是基于种子生成的。如果设置为 false，则 ID 将基于当前日期生成，因此不是确定性的。这是默认行为。如果你的文件被签入源代码管理，这很重要，例如 git 并且除非内容发生变化，否则不应更改。
Defined in
packages/mermaid/src/config.type.ts:155
dompurifyConfig
• Optional dompurifyConfig: Config
Defined in
packages/mermaid/src/config.type.ts:181
elk
• Optional elk: Object
Type declaration
| Name | Type | Description |
|---|---|---|
cycleBreakingStrategy? | "GREEDY" | "DEPTH_FIRST" | "INTERACTIVE" | "MODEL_ORDER" | "GREEDY_MODEL_ORDER" | 此策略决定如何在图中查找循环并决定哪些边需要调整以打破循环。 |
mergeEdges? | boolean | Elk 特定选项允许边在方便的地方共享路径。它可以制作漂亮的图表，但也会使图表更难阅读。 |
nodePlacementStrategy? | "SIMPLE" | "NETWORK_SIMPLEX" | "LINEAR_SEGMENTS" | "BRANDES_KOEPF" | Elk 特定选项影响节点的放置方式。 |
Defined in
packages/mermaid/src/config.type.ts:87
er
• Optional er: ErDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:168
flowchart
• Optional flowchart: FlowchartDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:161
fontFamily
• Optional fontFamily: string
指定渲染图表中使用的字体。可以是任何可能的 CSS font-family。 See https://developer.mozilla.org/en-US/docs/Web/CSS/font-family
Defined in
packages/mermaid/src/config.type.ts:116
fontSize
• Optional fontSize: number
Defined in
packages/mermaid/src/config.type.ts:183
forceLegacyMathML
• Optional forceLegacyMathML: boolean
此选项强制 Mermaid 依赖 KaTeX 自己的样式表来渲染 MathML。由于操作系统字体和浏览器的 MathML 实现之间的差异，如果一致的渲染很重要，建议使用此选项。如果设置为 true，则忽略 legacyMathML。
Defined in
packages/mermaid/src/config.type.ts:150
gantt
• Optional gantt: GanttDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:163
gitGraph
• Optional gitGraph: GitGraphDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:176
handDrawnSeed
• Optional handDrawnSeed: number
定义使用手绘外观时要使用的种子。这对于自动化测试很重要，因为它们总是会在没有种子的情况下发现差异。默认值为 0，它给出一个随机种子。
Defined in
packages/mermaid/src/config.type.ts:72
htmlLabels
• Optional htmlLabels: boolean
Defined in
packages/mermaid/src/config.type.ts:110
journey
• Optional journey: JourneyDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:164
kanban
• Optional kanban: KanbanDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:175
layout
• Optional layout: string
定义用于渲染图表的布局算法。
Defined in
packages/mermaid/src/config.type.ts:77
legacyMathML
• Optional legacyMathML: boolean
此选项指定 Mermaid 是否可以期望依赖包含没有自己的 MathML 实现的浏览器的 KaTeX 样式表。如果禁用此选项且不支持 MathML，则数学公式将被替换为警告。如果启用此选项且不支持 MathML，则 Mermaid 将恢复为 KaTeX 的传统渲染。
Defined in
packages/mermaid/src/config.type.ts:145
logLevel
• Optional logLevel: 0 | 2 | 1 | "trace" | "debug" | "info" | "warn" | "error" | "fatal" | 3 | 4 | 5
此选项决定 mermaid 要使用的日志量。
Defined in
packages/mermaid/src/config.type.ts:122
look
• Optional look: "classic" | "handDrawn"
定义图表要使用的主要外观。
Defined in
packages/mermaid/src/config.type.ts:67
markdownAutoWrap
• Optional markdownAutoWrap: boolean
Defined in
packages/mermaid/src/config.type.ts:184
maxEdges
• Optional maxEdges: number
定义图形中可以绘制的最大边数。
Defined in
packages/mermaid/src/config.type.ts:86
maxTextSize
• Optional maxTextSize: number
用户文本图的最大允许大小
Defined in
packages/mermaid/src/config.type.ts:81
mindmap
• Optional mindmap: MindmapDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:174
packet
• Optional packet: PacketDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:179
pie
• Optional pie: PieDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:169
quadrantChart
• Optional quadrantChart: QuadrantChartConfig
Defined in
packages/mermaid/src/config.type.ts:170
requirement
• Optional requirement: RequirementDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:172
sankey
• Optional sankey: SankeyDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:178
secure
• Optional secure: string[]
此选项控制哪些 currentConfig 密钥被视为安全，并且只能通过调用 mermaid.initialize 进行更改。这可以防止恶意图形指令覆盖站点的默认安全性。
Defined in
packages/mermaid/src/config.type.ts:140
securityLevel
• Optional securityLevel: "strict" | "loose" | "antiscript" | "sandbox"
解析图表的信任级别
Defined in
packages/mermaid/src/config.type.ts:126
sequence
• Optional sequence: SequenceDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:162
startOnLoad
• Optional startOnLoad: boolean
指示 mermaid 是否在页面加载时启动
Defined in
packages/mermaid/src/config.type.ts:130
state
• Optional state: StateDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:167
suppressErrorRendering
• Optional suppressErrorRendering: boolean
禁止在 DOM 中插入 'Syntax error' 图。当你想要控制如何处理应用中的语法错误时，这很有用。
Defined in
packages/mermaid/src/config.type.ts:189
theme
• Optional theme: "default" | "base" | "dark" | "forest" | "neutral" | "null"
主题，CSS 样式表。你也可以使用 themeCSS 覆盖此值。
Defined in
packages/mermaid/src/config.type.ts:60
themeCSS
• Optional themeCSS: string
Defined in
packages/mermaid/src/config.type.ts:62
themeVariables
• Optional themeVariables: any
Defined in
packages/mermaid/src/config.type.ts:61
timeline
• Optional timeline: TimelineDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:165
wrap
• Optional wrap: boolean
Defined in
packages/mermaid/src/config.type.ts:182
xyChart
• Optional xyChart: XYChartConfig