接口: MermaidConfig
mermaid.MermaidConfig
属性
altFontFamily
• 可选 altFontFamily: string
定义于
packages/mermaid/src/config.type.ts:122
architecture
• 可选 architecture: ArchitectureDiagramConfig
定义于
packages/mermaid/src/config.type.ts:194
arrowMarkerAbsolute
• 可选 arrowMarkerAbsolute: boolean
控制 HTML 代码中的箭头标记是绝对路径还是锚点。如果您使用 base 标签设置，这很重要。
定义于
packages/mermaid/src/config.type.ts:141
block
• 可选 block: BlockDiagramConfig
定义于
packages/mermaid/src/config.type.ts:201
c4
• 可选 c4: C4DiagramConfig
定义于
packages/mermaid/src/config.type.ts:198
class
• 可选 class: ClassDiagramConfig
定义于
packages/mermaid/src/config.type.ts:187
darkMode
• 可选 darkMode: boolean
定义于
packages/mermaid/src/config.type.ts:113
deterministicIDSeed
• 可选 deterministicIDSeed: string
此选项是确定性 ID 的可选种子。如果设置为 undefined 但 deterministicIds 为 true，则使用简单的数字迭代器。您可以将此属性设置为基于静态字符串的种子。
定义于
packages/mermaid/src/config.type.ts:181
deterministicIds
• 可选 deterministicIds: boolean
此选项控制 SVG 中节点的生成 ID 是随机生成还是基于种子。如果设置为 false，则 ID 是基于当前日期生成的，因此不是确定性的。这是默认行为。
如果您将文件签入到源代码控制（例如 git）中，并且除非内容更改否则不应更改，则这很重要。
定义于
packages/mermaid/src/config.type.ts:174
dompurifyConfig
• 可选 dompurifyConfig: Config
定义于
packages/mermaid/src/config.type.ts:202
elk
• 可选 elk: Object
类型声明
| 名称 | 类型 | 描述 |
|---|---|---|
cycleBreakingStrategy? | "GREEDY" | "DEPTH_FIRST" | "INTERACTIVE" | "MODEL_ORDER" | "GREEDY_MODEL_ORDER" | 此策略决定如何查找图中的循环，并决定哪些边需要调整才能打破循环。 |
mergeEdges? | boolean | Elk 特定选项，允许边在方便时共享路径。它可以创建漂亮的图表，但也可能难以阅读图表。 |
nodePlacementStrategy? | "SIMPLE" | "NETWORK_SIMPLEX" | "LINEAR_SEGMENTS" | "BRANDES_KOEPF" | 影响节点放置的 Elk 特定选项。 |
定义于
packages/mermaid/src/config.type.ts:91
er
• 可选 er: ErDiagramConfig
定义于
packages/mermaid/src/config.type.ts:189
flowchart
• 可选 flowchart: FlowchartDiagramConfig
定义于
packages/mermaid/src/config.type.ts:182
fontFamily
• 可选 fontFamily: string
指定在渲染的图表中使用的字体。可以是任何可能的 CSS font-family。参见 https://mdn.org.cn/en-US/docs/Web/CSS/font-family
定义于
packages/mermaid/src/config.type.ts:121
fontSize
• 可选 fontSize: number
定义于
packages/mermaid/src/config.type.ts:204
forceLegacyMathML
• 可选 forceLegacyMathML: boolean
此选项强制 Mermaid 依赖 KaTeX 的自己的样式表来渲染 MathML。由于操作系统字体和浏览器 MathML 实现之间的差异，如果一致渲染很重要，建议使用此选项。如果设置为 true，则忽略 legacyMathML。
定义于
packages/mermaid/src/config.type.ts:163
gantt
• 可选 gantt: GanttDiagramConfig
定义于
packages/mermaid/src/config.type.ts:184
gitGraph
• 可选 gitGraph: GitGraphDiagramConfig
定义于
packages/mermaid/src/config.type.ts:197
handDrawnSeed
• 可选 handDrawnSeed: number
定义在使用 handDrawn 样式时使用的种子。这对于自动测试很重要，因为如果没有种子，它们将始终找到差异。默认值为 0，它提供随机种子。
定义于
packages/mermaid/src/config.type.ts:76
htmlLabels
• 可选 htmlLabels: boolean
定义于
packages/mermaid/src/config.type.ts:114
journey
• 可选 journey: JourneyDiagramConfig
定义于
packages/mermaid/src/config.type.ts:185
kanban
• 可选 kanban: KanbanDiagramConfig
定义于
packages/mermaid/src/config.type.ts:196
layout
• 可选 layout: string
定义用于渲染图表的布局算法。
在 中定义
packages/mermaid/src/config.type.ts:81
legacyMathML
• 可选 legacyMathML: boolean
此选项指定 Mermaid 是否可以预期依赖项包含 KaTeX 样式表，用于没有自己的 MathML 实现的浏览器。 如果此选项被禁用并且不支持 MathML，则数学方程将被警告消息替换。 如果此选项已启用并且不支持 MathML，则 Mermaid 将回退到 KaTeX 的传统渲染。
在 中定义
packages/mermaid/src/config.type.ts:156
logLevel
• 可选 logLevel: 0 | 2 | 1 | "trace" | "debug" | "info" | "warn" | "error" | "fatal" | 3 | 4 | 5
此选项决定 mermaid 使用的日志记录量。
在 中定义
packages/mermaid/src/config.type.ts:127
look
• 可选 look: "classic" | "handDrawn"
定义用于图表的主要外观。
在 中定义
packages/mermaid/src/config.type.ts:71
markdownAutoWrap
• 可选 markdownAutoWrap: boolean
在 中定义
packages/mermaid/src/config.type.ts:205
maxEdges
• 可选 maxEdges: number
定义可以在图表中绘制的最大边数。
在 中定义
packages/mermaid/src/config.type.ts:90
maxTextSize
• 可选 maxTextSize: number
用户文本图允许的最大尺寸
在 中定义
packages/mermaid/src/config.type.ts:85
mindmap
• 可选 mindmap: MindmapDiagramConfig
在 中定义
packages/mermaid/src/config.type.ts:195
packet
• 可选 packet: PacketDiagramConfig
在 中定义
packages/mermaid/src/config.type.ts:200
pie
• 可选 pie: PieDiagramConfig
在 中定义
packages/mermaid/src/config.type.ts:190
quadrantChart
• 可选 quadrantChart: QuadrantChartConfig
在 中定义
packages/mermaid/src/config.type.ts:191
requirement
• 可选 requirement: RequirementDiagramConfig
在 中定义
packages/mermaid/src/config.type.ts:193
sankey
• 可选 sankey: SankeyDiagramConfig
在 中定义
packages/mermaid/src/config.type.ts:199
secure
• 可选 secure: string[]
此选项控制哪些 currentConfig 密钥被视为安全密钥，并且只能通过调用 mermaid.initialize 来更改。 这可以防止恶意图表指令覆盖站点的默认安全性。
在 中定义
packages/mermaid/src/config.type.ts:148
securityLevel
• 可选 securityLevel: "strict" | "loose" | "antiscript" | "sandbox"
解析图表的信任级别
在 中定义
packages/mermaid/src/config.type.ts:131
sequence
• 可选 sequence: SequenceDiagramConfig
在 中定义
packages/mermaid/src/config.type.ts:183
startOnLoad
• 可选 startOnLoad: boolean
指示 mermaid 是否在页面加载时启动
在 中定义
packages/mermaid/src/config.type.ts:135
state
• 可选 state: StateDiagramConfig
在 中定义
packages/mermaid/src/config.type.ts:188
suppressErrorRendering
• 可选 suppressErrorRendering: boolean
禁止在 DOM 中插入“语法错误”图表。 当您希望控制如何在应用程序中处理语法错误时，此功能很有用。
在 中定义
packages/mermaid/src/config.type.ts:211
theme
• 可选 theme: "default" | "base" | "dark" | "forest" | "neutral" | "null"
主题，CSS 样式表。 您也可以使用 themeCSS 来覆盖此值。
在 中定义
packages/mermaid/src/config.type.ts:64
themeCSS
• 可选 themeCSS: string
在 中定义
packages/mermaid/src/config.type.ts:66
themeVariables
• 可选 themeVariables: any
在 中定义
packages/mermaid/src/config.type.ts:65
timeline
• 可选 timeline: TimelineDiagramConfig
在 中定义
packages/mermaid/src/config.type.ts:186
wrap
• 可选 wrap: boolean
在 中定义
packages/mermaid/src/config.type.ts:203
xyChart
• 可选 xyChart: XYChartConfig