Interface: MermaidConfig

Defined in: packages/mermaid/src/config.type.ts:55

Properties

altFontFamily?

optional altFontFamily: string

Defined in: packages/mermaid/src/config.type.ts:127

architecture?

optional architecture: ArchitectureDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:183

arrowMarkerAbsolute?

optional arrowMarkerAbsolute: boolean

Defined in: packages/mermaid/src/config.type.ts:145

控制 html 代码中的箭头标记是绝对路径还是锚点。如果你使用基本标签设置，这很重要。

block?

optional block: BlockDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:190

c4?

optional c4: C4DiagramConfig

Defined in: packages/mermaid/src/config.type.ts:187

class?

optional class: ClassDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:176

darkMode?

optional darkMode: boolean

Defined in: packages/mermaid/src/config.type.ts:119

deterministicIds?

optional deterministicIds: boolean

Defined in: packages/mermaid/src/config.type.ts:165

此选项控制 SVG 中节点的生成 ID 是随机生成的还是基于种子生成的。如果设置为 false，则 ID 将基于当前日期生成，因此不是确定性的。这是默认行为。如果你的文件被签入源代码管理，这很重要，例如 git 并且除非内容发生变化，否则不应更改。

deterministicIDSeed?

optional deterministicIDSeed: string

Defined in: packages/mermaid/src/config.type.ts:170

此选项是确定性 ID 的可选种子。如果设置为 undefined 但 deterministicIds 是 true，则使用简单的数字迭代器。你可以设置此属性以基于静态字符串的种子。

dompurifyConfig?

optional dompurifyConfig: Config

Defined in: packages/mermaid/src/config.type.ts:192

elk?

optional elk: object

Defined in: packages/mermaid/src/config.type.ts:87

considerModelOrder?

optional considerModelOrder: "NONE" | "NODES_AND_EDGES" | "PREFER_EDGES" | "PREFER_NODES"

如果这不会导致额外的边交叉，则保留模型文件中节点和边的顺序。根据策略的不同，这并不总是可行的，因为节点和边的顺序可能存在冲突。

cycleBreakingStrategy?

optional cycleBreakingStrategy: "GREEDY" | "DEPTH_FIRST" | "INTERACTIVE" | "MODEL_ORDER" | "GREEDY_MODEL_ORDER"

此策略决定如何在图中查找循环并决定哪些边需要调整以打破循环。

forceNodeModelOrder?

optional forceNodeModelOrder: boolean

模型给定的节点顺序不会为了产生更好的布局而改变。例如，如果模型中的节点 A 位于节点 B 之前，则在交叉最小化过程中不会改变该顺序。这假设在交叉最小化之前已经遵循了节点模型顺序。这可以通过将 considerModelOrder.strategy 设置为 NODES_AND_EDGES 来实现。

mergeEdges?

optional mergeEdges: boolean

Elk 特定选项允许边在方便的地方共享路径。它可以制作漂亮的图表，但也会使图表更难阅读。

nodePlacementStrategy?

optional nodePlacementStrategy: "SIMPLE" | "NETWORK_SIMPLEX" | "LINEAR_SEGMENTS" | "BRANDES_KOEPF"

Elk 特定选项影响节点的放置方式。

er?

optional er: ErDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:178

flowchart?

optional flowchart: FlowchartDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:171

fontFamily?

optional fontFamily: string

Defined in: packages/mermaid/src/config.type.ts:126

指定渲染图表中使用的字体。可以是任何可能的 CSS font-family。 See https://developer.mozilla.org/en-US/docs/Web/CSS/font-family

fontSize?

optional fontSize: number

Defined in: packages/mermaid/src/config.type.ts:194

forceLegacyMathML?

optional forceLegacyMathML: boolean

Defined in: packages/mermaid/src/config.type.ts:160

此选项强制 Mermaid 依赖 KaTeX 自己的样式表来渲染 MathML。由于操作系统字体和浏览器的 MathML 实现之间的差异，如果一致的渲染很重要，建议使用此选项。如果设置为 true，则忽略 legacyMathML。

gantt?

optional gantt: GanttDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:173

gitGraph?

optional gitGraph: GitGraphDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:186

handDrawnSeed?

optional handDrawnSeed: number

Defined in: packages/mermaid/src/config.type.ts:72

定义使用手绘外观时要使用的种子。这对于自动化测试很重要，因为它们总是会在没有种子的情况下发现差异。默认值为 0，它给出一个随机种子。

htmlLabels?

optional htmlLabels: boolean

Defined in: packages/mermaid/src/config.type.ts:120

journey?

optional journey: JourneyDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:174

kanban?

optional kanban: KanbanDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:185

layout?

optional layout: string

Defined in: packages/mermaid/src/config.type.ts:77

定义用于渲染图表的布局算法。

legacyMathML?

optional legacyMathML: boolean

Defined in: packages/mermaid/src/config.type.ts:155

此选项指定 Mermaid 是否可以期望依赖包含没有自己的 MathML 实现的浏览器的 KaTeX 样式表。如果禁用此选项且不支持 MathML，则数学公式将被替换为警告。如果启用此选项且不支持 MathML，则 Mermaid 将恢复为 KaTeX 的传统渲染。

logLevel?

optional logLevel: 0 | 2 | 1 | "trace" | "debug" | "info" | "warn" | "error" | "fatal" | 3 | 4 | 5

Defined in: packages/mermaid/src/config.type.ts:132

此选项决定 mermaid 要使用的日志量。

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:195

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:184

packet?

optional packet: PacketDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:189

pie?

optional pie: PieDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:179

quadrantChart?

optional quadrantChart: QuadrantChartConfig

Defined in: packages/mermaid/src/config.type.ts:180

radar?

optional radar: RadarDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:191

requirement?

optional requirement: RequirementDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:182

sankey?

optional sankey: SankeyDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:188

secure?

optional secure: string[]

Defined in: packages/mermaid/src/config.type.ts:150

此选项控制哪些 currentConfig 密钥被视为安全，并且只能通过调用 mermaid.initialize 进行更改。这可以防止恶意图形指令覆盖站点的默认安全性。

securityLevel?

optional securityLevel: "strict" | "loose" | "antiscript" | "sandbox"

Defined in: packages/mermaid/src/config.type.ts:136

解析图表的信任级别

sequence?

optional sequence: SequenceDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:172

startOnLoad?

optional startOnLoad: boolean

Defined in: packages/mermaid/src/config.type.ts:140

指示 mermaid 是否在页面加载时启动

state?

optional state: StateDiagramConfig

Defined in: packages/mermaid/src/config.type.ts:177

suppressErrorRendering?

optional suppressErrorRendering: boolean

Defined in: packages/mermaid/src/config.type.ts:200

禁止在 DOM 中插入 'Syntax error' 图。当你想要控制如何处理应用中的语法错误时，这很有用。

theme?

optional theme: "default" | "base" | "dark" | "forest" | "neutral" | "null"

Defined in: packages/mermaid/src/config.type.ts:60

主题，CSS 样式表。你也可以使用 themeCSS 覆盖此值。

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:175

wrap?

optional wrap: boolean

Defined in: packages/mermaid/src/config.type.ts:193

xyChart?

optional xyChart: XYChartConfig

Defined in: packages/mermaid/src/config.type.ts:181

Interface: MermaidConfig ​

Properties ​

altFontFamily? ​

architecture? ​

arrowMarkerAbsolute? ​

block? ​

c4? ​

class? ​

darkMode? ​

deterministicIds? ​

deterministicIDSeed? ​

dompurifyConfig? ​

elk? ​

considerModelOrder? ​

cycleBreakingStrategy? ​

forceNodeModelOrder? ​

mergeEdges? ​

nodePlacementStrategy? ​

er? ​

flowchart? ​

fontFamily? ​

fontSize? ​

forceLegacyMathML? ​

gantt? ​

gitGraph? ​

handDrawnSeed? ​

htmlLabels? ​

journey? ​

kanban? ​

layout? ​

legacyMathML? ​

logLevel? ​

look? ​

markdownAutoWrap? ​

maxEdges? ​

maxTextSize? ​

mindmap? ​

packet? ​

pie? ​

quadrantChart? ​

radar? ​

requirement? ​

sankey? ​

secure? ​

securityLevel? ​

sequence? ​

startOnLoad? ​

state? ​

suppressErrorRendering? ​

theme? ​

themeCSS? ​

themeVariables? ​

timeline? ​

wrap? ​

xyChart? ​