Interface: MermaidConfig

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.

deterministicIDSeed?

optional deterministicIDSeed: string

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

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.

dompurifyConfig?

optional dompurifyConfig: Config

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

elk?

optional elk: object

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

considerModelOrder?

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

Preserves the order of nodes and edges in the model file if this does not lead to additional edge crossings. Depending on the strategy this is not always possible since the node and edge order might be conflicting.

cycleBreakingStrategy?

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

This strategy decides how to find cycles in the graph and deciding which edges need adjustment to break loops.

forceNodeModelOrder?

optional forceNodeModelOrder: boolean

The node order given by the model does not change to produce a better layout. E.g. if node A is before node B in the model this is not changed during crossing minimization. This assumes that the node model order is already respected before crossing minimization. This can be achieved by setting considerModelOrder.strategy to NODES_AND_EDGES.

keepEntryNodeOnTop?

optional keepEntryNodeOnTop: boolean

Elk specific option that keeps the entry node of a recursive flow at the top of the layout.

When a flow loops back on itself (a back-edge to an earlier node), ELK's degree-based cycle-breaking has no notion of an "entry point" and may rank the first-declared node in the middle, scrambling the reading order. When enabled, the entry node of each cyclic component is pinned to the first layer so the diagram still reads from its entry. Acyclic flows always have a natural source, so this has no effect on them.

Only applies when the cyclic flow has no node without incoming edges: if the loop is fed from outside (e.g. a start node pointing into it), that component already has a natural source and nothing is pinned. Detection is also scoped per container, so cycles that cross a subgraph boundary are not detected.

layeringLayerBound?

optional layeringLayerBound: number

Elk specific option capping how many nodes COFFMAN_GRAHAM will put in one layer. Ignored by every other layering strategy. Lower values give a taller, narrower drawing.

layeringStrategy?

optional layeringStrategy: "NETWORK_SIMPLEX" | "LONGEST_PATH" | "LONGEST_PATH_SOURCE" | "COFFMAN_GRAHAM" | "MIN_WIDTH" | "STRETCH_WIDTH" | "INTERACTIVE"

Elk specific option deciding which layer each node is assigned to — the column in a left-to-right diagram, the row in a top-down one. This is the coarsest of the three placement decisions, so changing it moves nodes further than anything else short of altering spacing.

NETWORK_SIMPLEX aims for the fewest long edges. LONGEST_PATH pushes every node as late as it can go. COFFMAN_GRAHAM bounds how many nodes share a layer, giving a more even, block-like shape on wide graphs. MIN_WIDTH and STRETCH_WIDTH trade edge length for a narrower or wider drawing. INTERACTIVE honours positions already on the nodes.

lineHops?

optional lineHops: boolean | "arc" | "gap"

Renders edge crossings as small arcs ("hops") or visible gaps, so that it is clear which line passes over which where two edges meet.

The edge that gives way loses its corner rounding for the segment carrying the hop, which is the trade for a readable crossing. Curved edges are skipped rather than rewritten, to avoid corrupting their geometry. Set to false to draw plain crossings.

mergeEdges?

optional 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.

nodePlacementAlignment?

optional nodePlacementAlignment: "NONE" | "LEFTUP" | "LEFTDOWN" | "RIGHTUP" | "RIGHTDOWN" | "BALANCED"

Elk specific option affecting Brandes-Koepf node placement alignment. BALANCED combines the four directional alignments; NONE picks the smallest result. Defaults to BALANCED for the default preset and NONE for named non-default presets.

nodePlacementStrategy?

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

Elk specific option affecting how nodes are placed.

preset?

optional preset: "legacy" | "default" | "modelOrder" | "depthFirst"

Named combination of layering, node placement, placement alignment and cycle breaking options. Explicit options override the preset for that option; the remaining preset values still apply.

default — network simplex layering, balanced Brandes-Koepf placement at the top level and inside subgraphs, and depth-first cycle breaking. Balanced placement favors centered branches and composite-state entries, sometimes at the cost of a wider or taller drawing. It does not guarantee that every edge attaches to the center of its target.

legacy — Brandes-Koepf placement with NONE alignment and ELK's own greedy cycle breaking. Reproduces the rendering before presets existed.

modelOrder — network simplex layering and top-level placement, Brandes-Koepf placement inside subgraphs, NONE alignment, and greedy model-order cycle breaking, which favors declaration order.

depthFirst — the previous default: network simplex layering and top-level placement, Brandes-Koepf placement inside subgraphs, NONE alignment, and depth-first cycle breaking.

Setting layeringStrategy, nodePlacementStrategy, nodePlacementAlignment or cycleBreakingStrategy explicitly overrides the preset for that option, including an explicit NONE alignment.

straightenEdges?

optional straightenEdges: boolean

Straightens an edge that leaves or enters a node with a tiny step.

ELK spreads an edge's port evenly along a node's side but routes the edge down a channel whose row rarely lines up with that port exactly, leaving a staircase of a few pixels right at the border. With rounded corners the two micro-bends land on top of each other and read as a kink. Enabling this moves the channel onto the port's row and drops the step, so the edge draws as one straight line and both ports stay exactly where the layout put them.

Only the step next to a node is touched, and only when the edge continues the same way afterwards, so a real turn is never collapsed. An edge is left alone entirely when moving its run would drag the far port, or would introduce a crossing.

er?

optional er: ErDiagramConfig

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

eventmodeling?

optional eventmodeling: EventModelingDiagramConfig

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

flowchart?

optional flowchart: FlowchartDiagramConfig

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

fontFamily?

optional fontFamily: string

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

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

fontSize?

optional fontSize: number

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

forceLegacyMathML?

optional forceLegacyMathML: boolean

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

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.

gantt?

optional gantt: GanttDiagramConfig

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

gitGraph?

optional gitGraph: GitGraphDiagramConfig

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

handDrawnSeed?

optional handDrawnSeed: number

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

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.

htmlLabels?

optional htmlLabels: boolean

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

Flag for setting whether or not a html tag should be used for rendering labels on nodes and edges. Note: Diagram-specific htmlLabels settings (e.g., flowchart.htmlLabels) are deprecated. Use this root-level htmlLabels setting instead. The root-level htmlLabels takes precedence over any diagram-specific settings.

ishikawa?

optional ishikawa: IshikawaDiagramConfig

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

journey?

optional journey: JourneyDiagramConfig

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

kanban?

optional kanban: KanbanDiagramConfig

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

layout?

optional layout: string

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

Defines which layout algorithm to use for rendering the diagram.

Defaults to elk, which is bundled with mermaid. The tiny build omits ELK to stay small and falls back to dagre.

legacyMathML?

optional legacyMathML: boolean

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

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.

logLevel?

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

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

This option decides the amount of logging to be used by mermaid.

look?

optional look: "neo" | "classic" | "handDrawn"

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

Defines which main look to use for the diagram.

markdownAutoWrap?

optional markdownAutoWrap: boolean

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

maxEdges?

optional maxEdges: number

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

Defines the maximum number of edges that can be drawn in a graph.

maxTextSize?

optional maxTextSize: number

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

The maximum allowed size of the users text diagram

mindmap?

optional mindmap: MindmapDiagramConfig

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

packet?

optional packet: PacketDiagramConfig

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

pie?

optional pie: PieDiagramConfig

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

quadrantChart?

optional quadrantChart: QuadrantChartConfig

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

radar?

optional radar: RadarDiagramConfig

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

railroad?

optional railroad: RailroadDiagramConfig

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

requirement?

optional requirement: RequirementDiagramConfig

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

sankey?

optional sankey: SankeyDiagramConfig

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

secure?

optional secure: string[]

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

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.

securityLevel?

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

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

Level of trust for parsed diagram

sequence?

optional sequence: SequenceDiagramConfig

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

startOnLoad?

optional startOnLoad: boolean

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

Dictates whether mermaid starts on Page load

state?

optional state: StateDiagramConfig

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

suppressErrorRendering?

optional suppressErrorRendering: boolean

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

Suppresses inserting 'Syntax error' diagram in the DOM. This is useful when you want to control how to handle syntax errors in your application.

swimlane?

optional swimlane: SwimlaneDiagramConfig

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

theme?

optional theme: "default" | "base" | "dark" | "forest" | "neutral" | "neo" | "neo-dark" | "redux" | "redux-dark" | "redux-color" | "redux-dark-color" | "null"

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

Theme, the CSS style sheet. You may also use themeCSS to override this value.

themeCSS?

optional themeCSS: string

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

themeVariables?

optional themeVariables: any

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

timeline?

optional timeline: TimelineDiagramConfig

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

treeView?

optional treeView: TreeViewDiagramConfig

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

usecase?

optional usecase: UsecaseDiagramConfig

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

venn?

optional venn: VennDiagramConfig

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

wardley-beta?

optional wardley-beta: WardleyDiagramConfig

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

wrap?

optional wrap: boolean

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

xyChart?

optional xyChart: XYChartConfig

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

Interface: MermaidConfig ​

Properties ​

agentflow? ​

altFontFamily? ​

architecture? ​

arrowMarkerAbsolute? ​

block? ​

c4? ​

class? ​

cynefin? ​

darkMode? ​

deterministicIds? ​

deterministicIDSeed? ​

dompurifyConfig? ​

elk? ​

considerModelOrder? ​

cycleBreakingStrategy? ​

forceNodeModelOrder? ​

keepEntryNodeOnTop? ​

layeringLayerBound? ​

layeringStrategy? ​

lineHops? ​

mergeEdges? ​

nodePlacementAlignment? ​

nodePlacementStrategy? ​

preset? ​

straightenEdges? ​

er? ​

eventmodeling? ​

flowchart? ​

fontFamily? ​

fontSize? ​

forceLegacyMathML? ​

gantt? ​

gitGraph? ​

handDrawnSeed? ​

htmlLabels? ​

ishikawa? ​

journey? ​

kanban? ​

layout? ​

legacyMathML? ​

logLevel? ​

look? ​

markdownAutoWrap? ​

maxEdges? ​

maxTextSize? ​

mindmap? ​

packet? ​

pie? ​

quadrantChart? ​

radar? ​

railroad? ​

requirement? ​

sankey? ​

secure? ​

securityLevel? ​

sequence? ​

startOnLoad? ​

state? ​

suppressErrorRendering? ​

swimlane? ​

theme? ​

themeCSS? ​

themeVariables? ​

timeline? ​

treeView? ​

usecase? ​

venn? ​

wardley-beta? ​

wrap? ​

xyChart? ​