mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-15 21:39:40 +02:00
468 lines
11 KiB
Markdown
468 lines
11 KiB
Markdown
> **Warning**
|
|
>
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
>
|
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.MermaidConfig.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.MermaidConfig.md).
|
|
|
|
# Interface: MermaidConfig
|
|
|
|
[mermaid](../modules/mermaid.md).MermaidConfig
|
|
|
|
## Properties
|
|
|
|
### altFontFamily
|
|
|
|
• `Optional` **altFontFamily**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:85](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L85)
|
|
|
|
---
|
|
|
|
### arrowMarkerAbsolute
|
|
|
|
• `Optional` **arrowMarkerAbsolute**: `boolean`
|
|
|
|
Controls whether or arrow markers in html code are absolute paths or anchors.
|
|
This matters if you are using base tag settings.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:104](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L104)
|
|
|
|
---
|
|
|
|
### block
|
|
|
|
• `Optional` **block**: `BlockDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:162](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L162)
|
|
|
|
---
|
|
|
|
### c4
|
|
|
|
• `Optional` **c4**: `C4DiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:159](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L159)
|
|
|
|
---
|
|
|
|
### class
|
|
|
|
• `Optional` **class**: `ClassDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:150](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L150)
|
|
|
|
---
|
|
|
|
### darkMode
|
|
|
|
• `Optional` **darkMode**: `boolean`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:76](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L76)
|
|
|
|
---
|
|
|
|
### deterministicIDSeed
|
|
|
|
• `Optional` **deterministicIDSeed**: `string`
|
|
|
|
This option is the optional seed for deterministic ids.
|
|
If set to `undefined` but deterministicIds is `true`, a simple number iterator is used.
|
|
You can set this attribute to base the seed on a static string.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:144](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L144)
|
|
|
|
---
|
|
|
|
### deterministicIds
|
|
|
|
• `Optional` **deterministicIds**: `boolean`
|
|
|
|
This option controls if the generated ids of nodes in the SVG are
|
|
generated randomly or based on a seed.
|
|
If set to `false`, the IDs are generated based on the current date and
|
|
thus are not deterministic. This is the default behavior.
|
|
|
|
This matters if your files are checked into source control e.g. git and
|
|
should not change unless content is changed.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:137](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L137)
|
|
|
|
---
|
|
|
|
### dompurifyConfig
|
|
|
|
• `Optional` **dompurifyConfig**: `Config`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:163](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L163)
|
|
|
|
---
|
|
|
|
### er
|
|
|
|
• `Optional` **er**: `ErDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:152](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L152)
|
|
|
|
---
|
|
|
|
### flowchart
|
|
|
|
• `Optional` **flowchart**: `FlowchartDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:145](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L145)
|
|
|
|
---
|
|
|
|
### fontFamily
|
|
|
|
• `Optional` **fontFamily**: `string`
|
|
|
|
Specifies the font to be used in the rendered diagrams.
|
|
Can be any possible CSS `font-family`.
|
|
See <https://developer.mozilla.org/en-US/docs/Web/CSS/font-family>
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:84](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L84)
|
|
|
|
---
|
|
|
|
### fontSize
|
|
|
|
• `Optional` **fontSize**: `number`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:165](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L165)
|
|
|
|
---
|
|
|
|
### forceLegacyMathML
|
|
|
|
• `Optional` **forceLegacyMathML**: `boolean`
|
|
|
|
This option forces Mermaid to rely on KaTeX's own stylesheet for rendering MathML. Due to differences between OS
|
|
fonts and browser's MathML implementation, this option is recommended if consistent rendering is important.
|
|
If set to true, ignores legacyMathML.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:126](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L126)
|
|
|
|
---
|
|
|
|
### gantt
|
|
|
|
• `Optional` **gantt**: `GanttDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:147](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L147)
|
|
|
|
---
|
|
|
|
### gitGraph
|
|
|
|
• `Optional` **gitGraph**: `GitGraphDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:158](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L158)
|
|
|
|
---
|
|
|
|
### htmlLabels
|
|
|
|
• `Optional` **htmlLabels**: `boolean`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:77](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L77)
|
|
|
|
---
|
|
|
|
### journey
|
|
|
|
• `Optional` **journey**: `JourneyDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:148](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L148)
|
|
|
|
---
|
|
|
|
### legacyMathML
|
|
|
|
• `Optional` **legacyMathML**: `boolean`
|
|
|
|
This option specifies if Mermaid can expect the dependent to include KaTeX stylesheets for browsers
|
|
without their own MathML implementation. If this option is disabled and MathML is not supported, the math
|
|
equations are replaced with a warning. If this option is enabled and MathML is not supported, Mermaid will
|
|
fall back to legacy rendering for KaTeX.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:119](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L119)
|
|
|
|
---
|
|
|
|
### logLevel
|
|
|
|
• `Optional` **logLevel**: `0` | `2` | `1` | `"trace"` | `"debug"` | `"info"` | `"warn"` | `"error"` | `"fatal"` | `3` | `4` | `5`
|
|
|
|
This option decides the amount of logging to be used by mermaid.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:90](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L90)
|
|
|
|
---
|
|
|
|
### markdownAutoWrap
|
|
|
|
• `Optional` **markdownAutoWrap**: `boolean`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:166](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L166)
|
|
|
|
---
|
|
|
|
### maxEdges
|
|
|
|
• `Optional` **maxEdges**: `number`
|
|
|
|
Defines the maximum number of edges that can be drawn in a graph.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L75)
|
|
|
|
---
|
|
|
|
### maxTextSize
|
|
|
|
• `Optional` **maxTextSize**: `number`
|
|
|
|
The maximum allowed size of the users text diagram
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:70](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L70)
|
|
|
|
---
|
|
|
|
### mindmap
|
|
|
|
• `Optional` **mindmap**: `MindmapDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:157](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L157)
|
|
|
|
---
|
|
|
|
### packet
|
|
|
|
• `Optional` **packet**: `PacketDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:161](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L161)
|
|
|
|
---
|
|
|
|
### pie
|
|
|
|
• `Optional` **pie**: `PieDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:153](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L153)
|
|
|
|
---
|
|
|
|
### quadrantChart
|
|
|
|
• `Optional` **quadrantChart**: `QuadrantChartConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:154](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L154)
|
|
|
|
---
|
|
|
|
### requirement
|
|
|
|
• `Optional` **requirement**: `RequirementDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:156](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L156)
|
|
|
|
---
|
|
|
|
### sankey
|
|
|
|
• `Optional` **sankey**: `SankeyDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:160](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L160)
|
|
|
|
---
|
|
|
|
### secure
|
|
|
|
• `Optional` **secure**: `string`\[]
|
|
|
|
This option controls which `currentConfig` keys are considered secure and
|
|
can only be changed via call to `mermaid.initialize`.
|
|
This prevents malicious graph directives from overriding a site's default security.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:111](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L111)
|
|
|
|
---
|
|
|
|
### securityLevel
|
|
|
|
• `Optional` **securityLevel**: `"strict"` | `"loose"` | `"antiscript"` | `"sandbox"`
|
|
|
|
Level of trust for parsed diagram
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:94](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L94)
|
|
|
|
---
|
|
|
|
### sequence
|
|
|
|
• `Optional` **sequence**: `SequenceDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L146)
|
|
|
|
---
|
|
|
|
### startOnLoad
|
|
|
|
• `Optional` **startOnLoad**: `boolean`
|
|
|
|
Dictates whether mermaid starts on Page load
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:98](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L98)
|
|
|
|
---
|
|
|
|
### state
|
|
|
|
• `Optional` **state**: `StateDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:151](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L151)
|
|
|
|
---
|
|
|
|
### suppressErrorRendering
|
|
|
|
• `Optional` **suppressErrorRendering**: `boolean`
|
|
|
|
Suppresses inserting 'Syntax error' diagram in the DOM.
|
|
This is useful when you want to control how to handle syntax errors in your application.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:172](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L172)
|
|
|
|
---
|
|
|
|
### theme
|
|
|
|
• `Optional` **theme**: `"default"` | `"forest"` | `"dark"` | `"neutral"` | `"null"`
|
|
|
|
Theme, the CSS style sheet.
|
|
You may also use `themeCSS` to override this value.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:64](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L64)
|
|
|
|
---
|
|
|
|
### themeCSS
|
|
|
|
• `Optional` **themeCSS**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:66](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L66)
|
|
|
|
---
|
|
|
|
### themeVariables
|
|
|
|
• `Optional` **themeVariables**: `any`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:65](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L65)
|
|
|
|
---
|
|
|
|
### timeline
|
|
|
|
• `Optional` **timeline**: `TimelineDiagramConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:149](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L149)
|
|
|
|
---
|
|
|
|
### wrap
|
|
|
|
• `Optional` **wrap**: `boolean`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:164](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L164)
|
|
|
|
---
|
|
|
|
### xyChart
|
|
|
|
• `Optional` **xyChart**: `XYChartConfig`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/config.type.ts:155](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L155)
|