13 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:110
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:129
block
• Optional block: BlockDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:187
c4
• Optional c4: C4DiagramConfig
Defined in
packages/mermaid/src/config.type.ts:184
class
• Optional class: ClassDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:175
darkMode
• Optional darkMode: boolean
Defined in
packages/mermaid/src/config.type.ts:101
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:169
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:162
dompurifyConfig
• Optional dompurifyConfig: Config
Defined in
packages/mermaid/src/config.type.ts:188
elk.mergeEdges
• Optional elk.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.
Defined in
packages/mermaid/src/config.type.ts:95
elk.nodePlacement.strategy
• Optional elk.nodePlacement.strategy: "SIMPLE" | "NETWORK_SIMPLEX" | "LINEAR_SEGMENTS" | "BRANDES_KOEPF"
Elk specific option affecting how nodes are placed.
Defined in
packages/mermaid/src/config.type.ts:100
er
• Optional er: ErDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:177
flowchart
• Optional flowchart: FlowchartDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:170
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:109
fontSize
• Optional fontSize: number
Defined in
packages/mermaid/src/config.type.ts:190
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:151
gantt
• Optional gantt: GanttDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:172
gitGraph
• Optional gitGraph: GitGraphDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:183
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:102
journey
• Optional journey: JourneyDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:173
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:144
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:115
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:191
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:182
packet
• Optional packet: PacketDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:186
pie
• Optional pie: PieDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:178
quadrantChart
• Optional quadrantChart: QuadrantChartConfig
Defined in
packages/mermaid/src/config.type.ts:179
requirement
• Optional requirement: RequirementDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:181
sankey
• Optional sankey: SankeyDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:185
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:136
securityLevel
• Optional securityLevel: "strict" | "loose" | "antiscript" | "sandbox"
Level of trust for parsed diagram
Defined in
packages/mermaid/src/config.type.ts:119
sequence
• Optional sequence: SequenceDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:171
startOnLoad
• Optional startOnLoad: boolean
Dictates whether mermaid starts on Page load
Defined in
packages/mermaid/src/config.type.ts:123
state
• Optional state: StateDiagramConfig
Defined in
packages/mermaid/src/config.type.ts:176
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:197
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
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:174
wrap
• Optional wrap: boolean
Defined in
packages/mermaid/src/config.type.ts:189
xyChart
• Optional xyChart: XYChartConfig