14 KiB
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.
Interface: MermaidConfig
mermaid.MermaidConfig
Properties
altFontFamily
• Optional altFontFamily: string
Defined in
packages/mermaid/src/config.type.ts:112
architecture
• Optional architecture: ArchitectureDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:190
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:131
block
• Optional block: BlockDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:196
c4
• Optional c4: C4DiagramConfig
Defined in
packages/mermaid/src/config.type.ts:193
class
• Optional class: ClassDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:183
darkMode
• Optional darkMode: boolean
Defined in
packages/mermaid/src/config.type.ts:103
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:177
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:170
dompurifyConfig
• Optional dompurifyConfig: Config
Defined in
packages/mermaid/src/config.type.ts:197
elk
• Optional elk: Object
Type declaration
| Name | Type | Description |
|---|---|---|
mergeEdges? |
boolean |
Elk specific option that allows edges to share path where it convenient. It can make for pretty diagrams but can also make it harder to read the diagram. |
nodePlacementStrategy? |
"SIMPLE" | "NETWORK_SIMPLEX" | "LINEAR_SEGMENTS" | "BRANDES_KOEPF" |
Elk specific option affecting how nodes are placed. |
Defined in
packages/mermaid/src/config.type.ts:91
er
• Optional er: ErDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:185
flowchart
• Optional flowchart: FlowchartDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:178
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:111
fontSize
• Optional fontSize: number
Defined in
packages/mermaid/src/config.type.ts:199
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:159
gantt
• Optional gantt: GanttDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:180
gitGraph
• Optional gitGraph: GitGraphDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:192
handDrawnSeed
• Optional handDrawnSeed: number
Defines the seed to be used when using handDrawn look. This is important for the automated tests as they will always find differences without the seed. The default value is 0 which gives a random seed.
Defined in
packages/mermaid/src/config.type.ts:76
htmlLabels
• Optional htmlLabels: boolean
Defined in
packages/mermaid/src/config.type.ts:104
iconLibraries
• Optional iconLibraries: (IconLibrary | "aws:full")[]
This option specifies an object contianing a mappig of SVG icon names to a resolver that returns the svg code. For supported diagrams (i.e., Architecture), their syntax allows refering to key names in this object to display the corresponding SVG icon in the rendered diagram.
Defined in
packages/mermaid/src/config.type.ts:152
journey
• Optional journey: JourneyDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:181
layout
• Optional layout: string
Defines which layout algorithm to use for rendering the diagram.
Defined in
packages/mermaid/src/config.type.ts:81
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:146
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:117
look
• Optional look: "classic" | "handDrawn"
Defines which main look to use for the diagram.
Defined in
packages/mermaid/src/config.type.ts:71
markdownAutoWrap
• Optional markdownAutoWrap: boolean
Defined in
packages/mermaid/src/config.type.ts:200
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:90
maxTextSize
• Optional maxTextSize: number
The maximum allowed size of the users text diagram
Defined in
packages/mermaid/src/config.type.ts:85
mindmap
• Optional mindmap: MindmapDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:191
packet
• Optional packet: PacketDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:195
pie
• Optional pie: PieDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:186
quadrantChart
• Optional quadrantChart: QuadrantChartConfig
Defined in
packages/mermaid/src/config.type.ts:187
requirement
• Optional requirement: RequirementDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:189
sankey
• Optional sankey: SankeyDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:194
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:138
securityLevel
• Optional securityLevel: "strict" | "loose" | "antiscript" | "sandbox"
Level of trust for parsed diagram
Defined in
packages/mermaid/src/config.type.ts:121
sequence
• Optional sequence: SequenceDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:179
startOnLoad
• Optional startOnLoad: boolean
Dictates whether mermaid starts on Page load
Defined in
packages/mermaid/src/config.type.ts:125
state
• Optional state: StateDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:184
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:206
theme
• Optional theme: "default" | "base" | "dark" | "forest" | "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
themeCSS
• Optional themeCSS: string
Defined in
packages/mermaid/src/config.type.ts:66
themeVariables
• Optional themeVariables: any
Defined in
packages/mermaid/src/config.type.ts:65
timeline
• Optional timeline: TimelineDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:182
wrap
• Optional wrap: boolean
Defined in
packages/mermaid/src/config.type.ts:198
xyChart
• Optional xyChart: XYChartConfig