Swimlane Diagram Config Schema

https://mermaid.js.org/schemas/config.schema.json#/$defs/SwimlaneDiagramConfig

The object containing configurations specific for the swimlanes diagram type.

Swimlanes reuses the flowchart renderer and flowchart config for shared options (curve, htmlLabels, spacing, …); this block holds the knobs that only affect the swimlanes layout pipeline.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	config.schema.json*

SwimlaneDiagramConfig Type

object (Swimlane Diagram Config)

all of

• Base Diagram Config

SwimlaneDiagramConfig Properties

Property	Type	Required	Nullable	Defined by
theme	string	Optional	cannot be null	Mermaid Config
look	string	Optional	cannot be null	Mermaid Config
layout	string	Optional	cannot be null	Mermaid Config
lineHops	Merged	Optional	cannot be null	Mermaid Config
ignoreCrossLaneEdges	boolean	Optional	cannot be null	Mermaid Config
optimizeRanksByCrossings	boolean	Optional	cannot be null	Mermaid Config
automaticLaneOrdering	boolean	Optional	cannot be null	Mermaid Config

theme

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

theme

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

theme Type

string

theme Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"default"
"base"
"dark"
"forest"
"neutral"
"neo"
"neo-dark"
"redux"
"redux-dark"
"redux-color"
"redux-dark-color"
"null"	Can be set to disable any pre-defined mermaid theme

theme Default Value

The default value is:

"redux-color"

look

Defines which main look to use for the diagram.

look

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

look Type

string

look Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"classic"
"handDrawn"
"neo"

look Default Value

The default value is:

"neo"

layout

Defines which layout algorithm to use for rendering the diagram.

layout

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

layout Type

string

layout Default Value

The default value is:

"swimlane"

lineHops

Renders edge crossings as small arcs ("hops") or visible gaps so that overlapping edges are easier to read. Set to false to disable. Edges rendered as curves are skipped to avoid corrupting the geometry.

lineHops

• is optional

• Type: merged type (Details)

• cannot be null

• defined in: Mermaid Config

lineHops Type

merged type (Details)

one (and only one) of

• Untitled boolean in Mermaid Config

• Untitled string in Mermaid Config

lineHops Default Value

The default value is:

"arc"

ignoreCrossLaneEdges

Ignores edges that cross swimlane boundaries during swimlane layer assignment. This can improve rank quality for diagrams with many cross-lane links.

ignoreCrossLaneEdges

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

ignoreCrossLaneEdges Type

boolean

ignoreCrossLaneEdges Default Value

The default value is:

true

optimizeRanksByCrossings

Enables a crossing-aware rank optimization pass for swimlane layouts.

optimizeRanksByCrossings

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

optimizeRanksByCrossings Type

boolean

optimizeRanksByCrossings Default Value

The default value is:

true

automaticLaneOrdering

Automatically reorders top-level swimlanes with a deterministic weighted-linear-arrangement heuristic. Disabled by default because source swimlane order can carry semantic meaning.

automaticLaneOrdering

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

automaticLaneOrdering Type

boolean

automaticLaneOrdering Default Value

The default value is:

false