Flowchart Diagram Config Schema

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

The object containing configurations specific for flowcharts

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*

FlowchartDiagramConfig Type

object (Flowchart Diagram Config)

all of

• Base Diagram Config

FlowchartDiagramConfig Properties

Property	Type	Required	Nullable	Defined by
titleTopMargin	integer	Required	cannot be null	Mermaid Config
subGraphTitleMargin	object	Required	cannot be null	Mermaid Config
arrowMarkerAbsolute	boolean	Optional	cannot be null	Mermaid Config
diagramPadding	integer	Required	cannot be null	Mermaid Config
htmlLabels	boolean	Required	cannot be null	Mermaid Config
nodeSpacing	integer	Required	cannot be null	Mermaid Config
rankSpacing	integer	Required	cannot be null	Mermaid Config
curve	string	Required	cannot be null	Mermaid Config
padding	number	Optional	cannot be null	Mermaid Config
defaultRenderer	string	Required	cannot be null	Mermaid Config
wrappingWidth	number	Required	cannot be null	Mermaid Config

titleTopMargin

Margin top for the text over the diagram

titleTopMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

titleTopMargin Type

integer

titleTopMargin Constraints

minimum: the value of this number must greater than or equal to: 0

titleTopMargin Default Value

The default value is:

25

subGraphTitleMargin

Defines a top/bottom margin for subgraph titles

subGraphTitleMargin

• is required

• Type: object (Details)

• cannot be null

• defined in: Mermaid Config

subGraphTitleMargin Type

object (Details)

subGraphTitleMargin Default Value

The default value is:

{
  "top": 0,
  "bottom": 0
}

arrowMarkerAbsolute

arrowMarkerAbsolute

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

diagramPadding

The amount of padding around the diagram as a whole so that embedded diagrams have margins, expressed in pixels.

diagramPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramPadding Type

integer

diagramPadding Constraints

minimum: the value of this number must greater than or equal to: 0

diagramPadding Default Value

The default value is:

20

htmlLabels

Flag for setting whether or not a html tag should be used for rendering labels on the edges.

htmlLabels

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

htmlLabels Type

boolean

htmlLabels Default Value

The default value is:

true

nodeSpacing

Defines the spacing between nodes on the same level

Pertains to horizontal spacing for TB (top to bottom) or BT (bottom to top) graphs, and the vertical spacing for LR as well as RL graphs.

nodeSpacing

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

nodeSpacing Type

integer

nodeSpacing Constraints

minimum: the value of this number must greater than or equal to: 0

nodeSpacing Default Value

The default value is:

50

rankSpacing

Defines the spacing between nodes on different levels

Pertains to horizontal spacing for TB (top to bottom) or BT (bottom to top) graphs, and the vertical spacing for LR as well as RL graphs.

rankSpacing

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

rankSpacing Type

integer

rankSpacing Constraints

minimum: the value of this number must greater than or equal to: 0

rankSpacing Default Value

The default value is:

50

curve

Defines how mermaid renders curves for flowcharts.

curve

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

curve Type

string

curve Constraints

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

Value	Explanation
"basis"
"linear"
"cardinal"

curve Default Value

The default value is:

"basis"

padding

Represents the padding between the labels and the shape

Only used in new experimental rendering.

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

15

defaultRenderer

Decides which rendering engine that is to be used for the rendering.

defaultRenderer

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

defaultRenderer Type

string

defaultRenderer Constraints

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

Value	Explanation
"dagre-d3"	The [dagre-d3-es](https://www.npmjs.com/package/dagre-d3-es) library.
"dagre-wrapper"	wrapper for dagre implemented in mermaid
"elk"	Layout using [elkjs](https://github.com/kieler/elkjs)

defaultRenderer Default Value

The default value is:

"dagre-wrapper"

wrappingWidth

Width of nodes where text is wrapped.

When using markdown strings the text ius wrapped automatically, this value sets the max width of a text before it continues on a new line.

wrappingWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

wrappingWidth Type

number

wrappingWidth Default Value

The default value is:

200