You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/config/setup/mermaid/interfaces/MermaidConfig.md
+33-33Lines changed: 33 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,23 +18,23 @@ Defined in: [packages/mermaid/src/config.type.ts:66](https://github.com/mermaid-
18
18
19
19
> `optional`**altFontFamily**: `string`
20
20
21
-
Defined in: [packages/mermaid/src/config.type.ts:139](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L139)
21
+
Defined in: [packages/mermaid/src/config.type.ts:147](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L147)
Defined in: [packages/mermaid/src/config.type.ts:211](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L211)
29
+
Defined in: [packages/mermaid/src/config.type.ts:219](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L219)
30
30
31
31
---
32
32
33
33
### arrowMarkerAbsolute?
34
34
35
35
> `optional`**arrowMarkerAbsolute**: `boolean`
36
36
37
-
Defined in: [packages/mermaid/src/config.type.ts:158](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L158)
37
+
Defined in: [packages/mermaid/src/config.type.ts:166](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L166)
38
38
39
39
Controls whether or arrow markers in html code are absolute paths or anchors.
40
40
This matters if you are using base tag settings.
@@ -45,23 +45,23 @@ This matters if you are using base tag settings.
45
45
46
46
> `optional`**block**: `BlockDiagramConfig`
47
47
48
-
Defined in: [packages/mermaid/src/config.type.ts:219](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L219)
48
+
Defined in: [packages/mermaid/src/config.type.ts:227](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L227)
49
49
50
50
---
51
51
52
52
### c4?
53
53
54
54
> `optional`**c4**: `C4DiagramConfig`
55
55
56
-
Defined in: [packages/mermaid/src/config.type.ts:216](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L216)
56
+
Defined in: [packages/mermaid/src/config.type.ts:224](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L224)
57
57
58
58
---
59
59
60
60
### class?
61
61
62
62
> `optional`**class**: `ClassDiagramConfig`
63
63
64
-
Defined in: [packages/mermaid/src/config.type.ts:204](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L204)
64
+
Defined in: [packages/mermaid/src/config.type.ts:212](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L212)
65
65
66
66
---
67
67
@@ -77,7 +77,7 @@ Defined in: [packages/mermaid/src/config.type.ts:131](https://github.com/mermaid
77
77
78
78
> `optional`**deterministicIds**: `boolean`
79
79
80
-
Defined in: [packages/mermaid/src/config.type.ts:191](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L191)
80
+
Defined in: [packages/mermaid/src/config.type.ts:199](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L199)
81
81
82
82
This option controls if the generated ids of nodes in the SVG are
83
83
generated randomly or based on a seed.
@@ -93,7 +93,7 @@ should not change unless content is changed.
93
93
94
94
> `optional`**deterministicIDSeed**: `string`
95
95
96
-
Defined in: [packages/mermaid/src/config.type.ts:198](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L198)
96
+
Defined in: [packages/mermaid/src/config.type.ts:206](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L206)
97
97
98
98
This option is the optional seed for deterministic ids.
99
99
If set to `undefined` but deterministicIds is `true`, a simple number iterator is used.
@@ -151,23 +151,23 @@ Elk specific option affecting how nodes are placed.
151
151
152
152
> `optional`**er**: `ErDiagramConfig`
153
153
154
-
Defined in: [packages/mermaid/src/config.type.ts:206](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L206)
154
+
Defined in: [packages/mermaid/src/config.type.ts:214](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L214)
Defined in: [packages/mermaid/src/config.type.ts:199](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L199)
162
+
Defined in: [packages/mermaid/src/config.type.ts:207](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L207)
163
163
164
164
---
165
165
166
166
### fontFamily?
167
167
168
168
> `optional`**fontFamily**: `string`
169
169
170
-
Defined in: [packages/mermaid/src/config.type.ts:138](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L138)
170
+
Defined in: [packages/mermaid/src/config.type.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L146)
171
171
172
172
Specifies the font to be used in the rendered diagrams.
173
173
Can be any possible CSS `font-family`.
@@ -187,7 +187,7 @@ Defined in: [packages/mermaid/src/config.type.ts:226](https://github.com/mermaid
187
187
188
188
> `optional`**forceLegacyMathML**: `boolean`
189
189
190
-
Defined in: [packages/mermaid/src/config.type.ts:180](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L180)
190
+
Defined in: [packages/mermaid/src/config.type.ts:188](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L188)
191
191
192
192
This option forces Mermaid to rely on KaTeX's own stylesheet for rendering MathML. Due to differences between OS
193
193
fonts and browser's MathML implementation, this option is recommended if consistent rendering is important.
@@ -199,15 +199,15 @@ If set to true, ignores legacyMathML.
199
199
200
200
> `optional`**gantt**: `GanttDiagramConfig`
201
201
202
-
Defined in: [packages/mermaid/src/config.type.ts:201](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L201)
202
+
Defined in: [packages/mermaid/src/config.type.ts:209](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L209)
203
203
204
204
---
205
205
206
206
### gitGraph?
207
207
208
208
> `optional`**gitGraph**: `GitGraphDiagramConfig`
209
209
210
-
Defined in: [packages/mermaid/src/config.type.ts:215](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L215)
210
+
Defined in: [packages/mermaid/src/config.type.ts:223](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L223)
211
211
212
212
---
213
213
@@ -225,7 +225,7 @@ Defines the seed to be used when using handDrawn look. This is important for the
225
225
226
226
> `optional`**htmlLabels**: `boolean`
227
227
228
-
Defined in: [packages/mermaid/src/config.type.ts:131](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L131)
228
+
Defined in: [packages/mermaid/src/config.type.ts:139](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L139)
229
229
230
230
Flag for setting whether or not a html tag should be used for rendering labels on nodes and edges.
231
231
**Note:** Diagram-specific `htmlLabels` settings (e.g., `flowchart.htmlLabels`) are deprecated.
@@ -238,23 +238,23 @@ over any diagram-specific settings.
238
238
239
239
> `optional`**ishikawa**: `IshikawaDiagramConfig`
240
240
241
-
Defined in: [packages/mermaid/src/config.type.ts:213](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L213)
241
+
Defined in: [packages/mermaid/src/config.type.ts:221](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L221)
242
242
243
243
---
244
244
245
245
### journey?
246
246
247
247
> `optional`**journey**: `JourneyDiagramConfig`
248
248
249
-
Defined in: [packages/mermaid/src/config.type.ts:202](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L202)
249
+
Defined in: [packages/mermaid/src/config.type.ts:210](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L210)
250
250
251
251
---
252
252
253
253
### kanban?
254
254
255
255
> `optional`**kanban**: `KanbanDiagramConfig`
256
256
257
-
Defined in: [packages/mermaid/src/config.type.ts:214](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L214)
257
+
Defined in: [packages/mermaid/src/config.type.ts:222](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L222)
258
258
259
259
---
260
260
@@ -272,7 +272,7 @@ Defines which layout algorithm to use for rendering the diagram.
272
272
273
273
> `optional`**legacyMathML**: `boolean`
274
274
275
-
Defined in: [packages/mermaid/src/config.type.ts:173](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L173)
275
+
Defined in: [packages/mermaid/src/config.type.ts:181](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L181)
276
276
277
277
This option specifies if Mermaid can expect the dependent to include KaTeX stylesheets for browsers
278
278
without their own MathML implementation. If this option is disabled and MathML is not supported, the math
@@ -285,7 +285,7 @@ fall back to legacy rendering for KaTeX.
Defined in: [packages/mermaid/src/config.type.ts:144](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L144)
288
+
Defined in: [packages/mermaid/src/config.type.ts:152](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L152)
289
289
290
290
This option decides the amount of logging to be used by mermaid.
291
291
@@ -333,31 +333,31 @@ The maximum allowed size of the users text diagram
333
333
334
334
> `optional`**mindmap**: `MindmapDiagramConfig`
335
335
336
-
Defined in: [packages/mermaid/src/config.type.ts:212](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L212)
336
+
Defined in: [packages/mermaid/src/config.type.ts:220](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L220)
337
337
338
338
---
339
339
340
340
### packet?
341
341
342
342
> `optional`**packet**: `PacketDiagramConfig`
343
343
344
-
Defined in: [packages/mermaid/src/config.type.ts:218](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L218)
344
+
Defined in: [packages/mermaid/src/config.type.ts:226](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L226)
345
345
346
346
---
347
347
348
348
### pie?
349
349
350
350
> `optional`**pie**: `PieDiagramConfig`
351
351
352
-
Defined in: [packages/mermaid/src/config.type.ts:207](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L207)
352
+
Defined in: [packages/mermaid/src/config.type.ts:215](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L215)
Defined in: [packages/mermaid/src/config.type.ts:208](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L208)
360
+
Defined in: [packages/mermaid/src/config.type.ts:216](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L216)
361
361
362
362
---
363
363
@@ -373,23 +373,23 @@ Defined in: [packages/mermaid/src/config.type.ts:221](https://github.com/mermaid
Defined in: [packages/mermaid/src/config.type.ts:210](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L210)
376
+
Defined in: [packages/mermaid/src/config.type.ts:218](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L218)
377
377
378
378
---
379
379
380
380
### sankey?
381
381
382
382
> `optional`**sankey**: `SankeyDiagramConfig`
383
383
384
-
Defined in: [packages/mermaid/src/config.type.ts:217](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L217)
384
+
Defined in: [packages/mermaid/src/config.type.ts:225](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L225)
385
385
386
386
---
387
387
388
388
### secure?
389
389
390
390
> `optional`**secure**: `string`\[]
391
391
392
-
Defined in: [packages/mermaid/src/config.type.ts:165](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L165)
392
+
Defined in: [packages/mermaid/src/config.type.ts:173](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L173)
393
393
394
394
This option controls which `currentConfig` keys are considered secure and
395
395
can only be changed via call to `mermaid.initialize`.
@@ -401,7 +401,7 @@ This prevents malicious graph directives from overriding a site's default securi
Defined in: [packages/mermaid/src/config.type.ts:148](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L148)
404
+
Defined in: [packages/mermaid/src/config.type.ts:156](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L156)
405
405
406
406
Level of trust for parsed diagram
407
407
@@ -411,15 +411,15 @@ Level of trust for parsed diagram
411
411
412
412
> `optional`**sequence**: `SequenceDiagramConfig`
413
413
414
-
Defined in: [packages/mermaid/src/config.type.ts:200](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L200)
414
+
Defined in: [packages/mermaid/src/config.type.ts:208](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L208)
415
415
416
416
---
417
417
418
418
### startOnLoad?
419
419
420
420
> `optional`**startOnLoad**: `boolean`
421
421
422
-
Defined in: [packages/mermaid/src/config.type.ts:152](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L152)
422
+
Defined in: [packages/mermaid/src/config.type.ts:160](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L160)
Defined in: [packages/mermaid/src/config.type.ts:205](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L205)
432
+
Defined in: [packages/mermaid/src/config.type.ts:213](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L213)
433
433
434
434
---
435
435
@@ -475,7 +475,7 @@ Defined in: [packages/mermaid/src/config.type.ts:73](https://github.com/mermaid-
475
475
476
476
> `optional`**timeline**: `TimelineDiagramConfig`
477
477
478
-
Defined in: [packages/mermaid/src/config.type.ts:203](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L203)
478
+
Defined in: [packages/mermaid/src/config.type.ts:211](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L211)
479
479
480
480
---
481
481
@@ -515,4 +515,4 @@ Defined in: [packages/mermaid/src/config.type.ts:225](https://github.com/mermaid
515
515
516
516
> `optional`**xyChart**: `XYChartConfig`
517
517
518
-
Defined in: [packages/mermaid/src/config.type.ts:209](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L209)
518
+
Defined in: [packages/mermaid/src/config.type.ts:217](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L217)
0 commit comments