Mermaid Config Schema

https://mermaid.js.org/schemas/config.schema.json

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

Mermaid Config Type

object (Mermaid Config)

Mermaid Config Properties

Property	Type	Required	Nullable	Defined by
theme	string	Optional	cannot be null	Mermaid Config
themeVariables	Not specified	Optional	cannot be null	Mermaid Config
themeCSS	string	Optional	cannot be null	Mermaid Config
look	string	Required	cannot be null	Mermaid Config
handDrawnSeed	number	Optional	cannot be null	Mermaid Config
layout	string	Optional	cannot be null	Mermaid Config
maxTextSize	number	Optional	cannot be null	Mermaid Config
maxEdges	integer	Optional	cannot be null	Mermaid Config
elk	object	Optional	cannot be null	Mermaid Config
darkMode	boolean	Optional	cannot be null	Mermaid Config
htmlLabels	boolean	Optional	cannot be null	Mermaid Config
fontFamily	string	Required	cannot be null	Mermaid Config
altFontFamily	string	Optional	cannot be null	Mermaid Config
logLevel	Multiple	Required	cannot be null	Mermaid Config
securityLevel	string	Required	cannot be null	Mermaid Config
startOnLoad	boolean	Required	cannot be null	Mermaid Config
arrowMarkerAbsolute	boolean	Required	cannot be null	Mermaid Config
secure	array	Optional	cannot be null	Mermaid Config
legacyMathML	boolean	Optional	cannot be null	Mermaid Config
forceLegacyMathML	boolean	Optional	cannot be null	Mermaid Config
deterministicIds	boolean	Optional	cannot be null	Mermaid Config
deterministicIDSeed	string	Optional	cannot be null	Mermaid Config
flowchart	Merged	Required	cannot be null	Mermaid Config
sequence	Merged	Required	cannot be null	Mermaid Config
gantt	Merged	Required	cannot be null	Mermaid Config
journey	Merged	Required	cannot be null	Mermaid Config
timeline	Merged	Optional	cannot be null	Mermaid Config
class	Merged	Required	cannot be null	Mermaid Config
state	Merged	Required	cannot be null	Mermaid Config
er	Merged	Required	cannot be null	Mermaid Config
pie	Merged	Required	cannot be null	Mermaid Config
quadrantChart	Merged	Required	cannot be null	Mermaid Config
xyChart	Merged	Required	cannot be null	Mermaid Config
requirement	Merged	Required	cannot be null	Mermaid Config
architecture	Merged	Required	cannot be null	Mermaid Config
mindmap	Merged	Required	cannot be null	Mermaid Config
kanban	Merged	Required	cannot be null	Mermaid Config
gitGraph	Merged	Required	cannot be null	Mermaid Config
c4	Merged	Required	cannot be null	Mermaid Config
sankey	Merged	Required	cannot be null	Mermaid Config
packet	Merged	Required	cannot be null	Mermaid Config
block	Merged	Required	cannot be null	Mermaid Config
radar	Merged	Required	cannot be null	Mermaid Config
dompurifyConfig	object	Optional	cannot be null	Mermaid Config
wrap	boolean	Optional	cannot be null	Mermaid Config
fontSize	number	Optional	cannot be null	Mermaid Config
markdownAutoWrap	boolean	Optional	cannot be null	Mermaid Config
suppressErrorRendering	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"
"null"	Can be set to disable any pre-defined mermaid theme

theme Default Value

The default value is:

"default"

themeVariables

themeVariables

• is optional

• Type: unknown

• cannot be null

• defined in: Mermaid Config

• tsType: any

themeVariables Type

unknown

themeCSS

themeCSS

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

themeCSS Type

string

look

Defines which main look to use for the diagram.

look

• is required

• 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"

look Default Value

The default value is:

"classic"

handDrawnSeed

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.

handDrawnSeed

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

handDrawnSeed Type

number

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:

"dagre"

maxTextSize

The maximum allowed size of the users text diagram

maxTextSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

maxTextSize Type

number

maxTextSize Default Value

The default value is:

50000

maxEdges

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

maxEdges

• is optional

• Type: integer

• cannot be null

• defined in: Mermaid Config

maxEdges Type

integer

maxEdges Constraints

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

maxEdges Default Value

The default value is:

500

elk

elk

• is optional

• Type: object (Details)

• cannot be null

• defined in: Mermaid Config

elk Type

object (Details)

darkMode

darkMode

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

darkMode Type

boolean

htmlLabels

htmlLabels

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

htmlLabels Type

boolean

fontFamily

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

fontFamily

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

fontFamily Type

string

fontFamily Default Value

The default value is:

"\"trebuchet ms\", verdana, arial, sans-serif;"

altFontFamily

altFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

altFontFamily Type

string

logLevel

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

logLevel

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

logLevel Type

any of the following: string or number (Details)

logLevel Constraints

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

Value	Explanation
"trace"	Equivalent to 0
0
"debug"	Equivalent to 1
1
"info"	Equivalent to 2
2
"warn"	Equivalent to 3
3
"error"	Equivalent to 4
4
"fatal"	Equivalent to 5 (default)
5

logLevel Default Value

The default value is:

5

securityLevel

Level of trust for parsed diagram

securityLevel

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

securityLevel Type

string

securityLevel Constraints

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

Value	Explanation
"strict"	(**default**) HTML tags in the text are encoded and click functionality is disabled.
"loose"	HTML tags in text are allowed and click functionality is enabled.
"antiscript"	HTML tags in text are allowed (only script elements are removed), and click functionality is enabled.
"sandbox"	With this security level, all rendering takes place in a sandboxed iframe. This prevent any JavaScript from running in the context. This may hinder interactive functionality of the diagram, like scripts, popups in the sequence diagram, or links to other tabs or targets, etc.

securityLevel Default Value

The default value is:

"strict"

startOnLoad

Dictates whether mermaid starts on Page load

startOnLoad

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

startOnLoad Type

boolean

startOnLoad Default Value

The default value is:

true

arrowMarkerAbsolute

Controls whether or arrow markers in html code are absolute paths or anchors. This matters if you are using base tag settings.

arrowMarkerAbsolute

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

secure

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.

secure

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

secure Type

string[]

secure Default Value

The default value is:

["secure", "securityLevel", "startOnLoad", "maxTextSize", "suppressErrorRendering", "maxEdges"]

legacyMathML

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.

legacyMathML

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

legacyMathML Type

boolean

forceLegacyMathML

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.

forceLegacyMathML

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

forceLegacyMathML Type

boolean

deterministicIds

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.

deterministicIds

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

deterministicIds Type

boolean

deterministicIDSeed

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.

deterministicIDSeed

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

deterministicIDSeed Type

string

flowchart

The object containing configurations specific for flowcharts

flowchart

• is required

• Type: object (Flowchart Diagram Config)

• cannot be null

• defined in: Mermaid Config

flowchart Type

object (Flowchart Diagram Config)

all of

• Base Diagram Config

sequence

The object containing configurations specific for sequence diagrams

sequence

• is required

• Type: object (Sequence Diagram Config)

• cannot be null

• defined in: Mermaid Config

sequence Type

object (Sequence Diagram Config)

all of

• Base Diagram Config

gantt

The object containing configurations specific for gantt diagrams

gantt

• is required

• Type: object (Gantt Diagram Config)

• cannot be null

• defined in: Mermaid Config

gantt Type

object (Gantt Diagram Config)

all of

• Base Diagram Config

journey

The object containing configurations specific for journey diagrams

journey

• is required

• Type: object (Journey Diagram Config)

• cannot be null

• defined in: Mermaid Config

journey Type

object (Journey Diagram Config)

all of

• Base Diagram Config

timeline

timeline

• is optional

• Type: object (Timeline Diagram Config)

• cannot be null

• defined in: Mermaid Config

timeline Type

object (Timeline Diagram Config)

all of

• Base Diagram Config

class

class

• is required

• Type: object (Class Diagram Config)

• cannot be null

• defined in: Mermaid Config

class Type

object (Class Diagram Config)

all of

• Base Diagram Config

state

The object containing configurations specific for entity relationship diagrams

state

• is required

• Type: object (State Diagram Config)

• cannot be null

• defined in: Mermaid Config

state Type

object (State Diagram Config)

all of

• Base Diagram Config

er

The object containing configurations specific for entity relationship diagrams

er

• is required

• Type: object (Er Diagram Config)

• cannot be null

• defined in: Mermaid Config

er Type

object (Er Diagram Config)

all of

• Base Diagram Config

pie

pie

• is required

• Type: object (Pie Diagram Config)

• cannot be null

• defined in: Mermaid Config

pie Type

object (Pie Diagram Config)

all of

• Base Diagram Config

quadrantChart

quadrantChart

• is required

• Type: object (Quadrant Chart Config)

• cannot be null

• defined in: Mermaid Config

quadrantChart Type

object (Quadrant Chart Config)

all of

• Base Diagram Config

xyChart

This object contains configuration specific to XYCharts

xyChart

• is required

• Type: object (XYChart Config)

• cannot be null

• defined in: Mermaid Config

xyChart Type

object (XYChart Config)

all of

• Base Diagram Config

requirement

The object containing configurations specific for req diagrams

requirement

• is required

• Type: object (Requirement Diagram Config)

• cannot be null

• defined in: Mermaid Config

requirement Type

object (Requirement Diagram Config)

all of

• Base Diagram Config

architecture

The object containing configurations specific for architecture diagrams

architecture

• is required

• Type: object (Architecture Diagram Config)

• cannot be null

• defined in: Mermaid Config

architecture Type

object (Architecture Diagram Config)

all of

• Base Diagram Config

mindmap

The object containing configurations specific for mindmap diagrams

mindmap

• is required

• Type: object (Mindmap Diagram Config)

• cannot be null

• defined in: Mermaid Config

mindmap Type

object (Mindmap Diagram Config)

all of

• Base Diagram Config

kanban

The object containing configurations specific for kanban diagrams

kanban

• is required

• Type: object (Kanban Diagram Config)

• cannot be null

• defined in: Mermaid Config

kanban Type

object (Kanban Diagram Config)

all of

• Base Diagram Config

gitGraph

gitGraph

• is required

• Type: object (Git Graph Diagram Config)

• cannot be null

• defined in: Mermaid Config

gitGraph Type

object (Git Graph Diagram Config)

all of

• Base Diagram Config

c4

The object containing configurations specific for c4 diagrams

c4

• is required

• Type: object (C4 Diagram Config)

• cannot be null

• defined in: Mermaid Config

c4 Type

object (C4 Diagram Config)

all of

• Base Diagram Config

sankey

The object containing configurations specific for sankey diagrams.

sankey

• is required

• Type: object (Sankey Diagram Config)

• cannot be null

• defined in: Mermaid Config

sankey Type

object (Sankey Diagram Config)

all of

• Base Diagram Config

packet

The object containing configurations specific for packet diagrams.

packet

• is required

• Type: object (Packet Diagram Config)

• cannot be null

• defined in: Mermaid Config

packet Type

object (Packet Diagram Config)

all of

• Base Diagram Config

block

The object containing configurations specific for block diagrams.

block

• is required

• Type: object (Block Diagram Config)

• cannot be null

• defined in: Mermaid Config

block Type

object (Block Diagram Config)

all of

• Base Diagram Config

radar

The object containing configurations specific for radar diagrams.

radar

• is required

• Type: object (Radar Diagram Config)

• cannot be null

• defined in: Mermaid Config

radar Type

object (Radar Diagram Config)

all of

• Base Diagram Config

dompurifyConfig

Configuration options to pass to the dompurify library.

dompurifyConfig

• is optional

• Type: object (DOM Purify Configuration)

• cannot be null

• defined in: Mermaid Config

• tsType: import('dompurify').Config

dompurifyConfig Type

object (DOM Purify Configuration)

wrap

wrap

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

wrap Type

boolean

fontSize

fontSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSize Type

number

fontSize Default Value

The default value is:

16

markdownAutoWrap

markdownAutoWrap

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

markdownAutoWrap Type

boolean

markdownAutoWrap Default Value

The default value is:

true

suppressErrorRendering

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

suppressErrorRendering

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

suppressErrorRendering Type

boolean

Mermaid Config Definitions

Definitions group BaseDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/BaseDiagramConfig" }

Property	Type	Required	Nullable	Defined by
useWidth	number	Optional	cannot be null	Mermaid Config
useMaxWidth	boolean	Optional	cannot be null	Mermaid Config

useWidth

useWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

useWidth Type

number

useMaxWidth

When this flag is set to true, the height and width is set to 100% and is then scaled with the available space. If set to false, the absolute space required is used.

useMaxWidth

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

useMaxWidth Type

boolean

useMaxWidth Default Value

The default value is:

true

Definitions group C4DiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/C4DiagramConfig" }

Property	Type	Required	Nullable	Defined by
diagramMarginX	integer	Required	cannot be null	Mermaid Config
diagramMarginY	integer	Required	cannot be null	Mermaid Config
c4ShapeMargin	integer	Required	cannot be null	Mermaid Config
c4ShapePadding	integer	Required	cannot be null	Mermaid Config
width	integer	Required	cannot be null	Mermaid Config
height	integer	Required	cannot be null	Mermaid Config
boxMargin	integer	Required	cannot be null	Mermaid Config
c4ShapeInRow	integer	Required	cannot be null	Mermaid Config
nextLinePaddingX	number	Optional	cannot be null	Mermaid Config
c4BoundaryInRow	integer	Required	cannot be null	Mermaid Config
personFontSize	Multiple	Optional	cannot be null	Mermaid Config
personFontFamily	string	Optional	cannot be null	Mermaid Config
personFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_personFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_personFontFamily	string	Optional	cannot be null	Mermaid Config
external_personFontWeight	Multiple	Optional	cannot be null	Mermaid Config
systemFontSize	Multiple	Optional	cannot be null	Mermaid Config
systemFontFamily	string	Optional	cannot be null	Mermaid Config
systemFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_systemFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_systemFontFamily	string	Optional	cannot be null	Mermaid Config
external_systemFontWeight	Multiple	Optional	cannot be null	Mermaid Config
system_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
system_dbFontFamily	string	Optional	cannot be null	Mermaid Config
system_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_system_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_system_dbFontFamily	string	Optional	cannot be null	Mermaid Config
external_system_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
system_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
system_queueFontFamily	string	Optional	cannot be null	Mermaid Config
system_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_system_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_system_queueFontFamily	string	Optional	cannot be null	Mermaid Config
external_system_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
boundaryFontSize	Multiple	Optional	cannot be null	Mermaid Config
boundaryFontFamily	string	Optional	cannot be null	Mermaid Config
boundaryFontWeight	Multiple	Optional	cannot be null	Mermaid Config
messageFontSize	Multiple	Optional	cannot be null	Mermaid Config
messageFontFamily	string	Optional	cannot be null	Mermaid Config
messageFontWeight	Multiple	Optional	cannot be null	Mermaid Config
containerFontSize	Multiple	Optional	cannot be null	Mermaid Config
containerFontFamily	string	Optional	cannot be null	Mermaid Config
containerFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_containerFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_containerFontFamily	string	Optional	cannot be null	Mermaid Config
external_containerFontWeight	Multiple	Optional	cannot be null	Mermaid Config
container_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
container_dbFontFamily	string	Optional	cannot be null	Mermaid Config
container_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_container_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_container_dbFontFamily	string	Optional	cannot be null	Mermaid Config
external_container_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
container_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
container_queueFontFamily	string	Optional	cannot be null	Mermaid Config
container_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_container_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_container_queueFontFamily	string	Optional	cannot be null	Mermaid Config
external_container_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
componentFontSize	Multiple	Optional	cannot be null	Mermaid Config
componentFontFamily	string	Optional	cannot be null	Mermaid Config
componentFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_componentFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_componentFontFamily	string	Optional	cannot be null	Mermaid Config
external_componentFontWeight	Multiple	Optional	cannot be null	Mermaid Config
component_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
component_dbFontFamily	string	Optional	cannot be null	Mermaid Config
component_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_component_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_component_dbFontFamily	string	Optional	cannot be null	Mermaid Config
external_component_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
component_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
component_queueFontFamily	string	Optional	cannot be null	Mermaid Config
component_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_component_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_component_queueFontFamily	string	Optional	cannot be null	Mermaid Config
external_component_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
wrap	boolean	Optional	cannot be null	Mermaid Config
wrapPadding	number	Optional	cannot be null	Mermaid Config
person_bg_color	string	Optional	cannot be null	Mermaid Config
person_border_color	string	Optional	cannot be null	Mermaid Config
external_person_bg_color	string	Optional	cannot be null	Mermaid Config
external_person_border_color	string	Optional	cannot be null	Mermaid Config
system_bg_color	string	Optional	cannot be null	Mermaid Config
system_border_color	string	Optional	cannot be null	Mermaid Config
system_db_bg_color	string	Optional	cannot be null	Mermaid Config
system_db_border_color	string	Optional	cannot be null	Mermaid Config
system_queue_bg_color	string	Optional	cannot be null	Mermaid Config
system_queue_border_color	string	Optional	cannot be null	Mermaid Config
external_system_bg_color	string	Optional	cannot be null	Mermaid Config
external_system_border_color	string	Optional	cannot be null	Mermaid Config
external_system_db_bg_color	string	Optional	cannot be null	Mermaid Config
external_system_db_border_color	string	Optional	cannot be null	Mermaid Config
external_system_queue_bg_color	string	Optional	cannot be null	Mermaid Config
external_system_queue_border_color	string	Optional	cannot be null	Mermaid Config
container_bg_color	string	Optional	cannot be null	Mermaid Config
container_border_color	string	Optional	cannot be null	Mermaid Config
container_db_bg_color	string	Optional	cannot be null	Mermaid Config
container_db_border_color	string	Optional	cannot be null	Mermaid Config
container_queue_bg_color	string	Optional	cannot be null	Mermaid Config
container_queue_border_color	string	Optional	cannot be null	Mermaid Config
external_container_bg_color	string	Optional	cannot be null	Mermaid Config
external_container_border_color	string	Optional	cannot be null	Mermaid Config
external_container_db_bg_color	string	Optional	cannot be null	Mermaid Config
external_container_db_border_color	string	Optional	cannot be null	Mermaid Config
external_container_queue_bg_color	string	Optional	cannot be null	Mermaid Config
external_container_queue_border_color	string	Optional	cannot be null	Mermaid Config
component_bg_color	string	Optional	cannot be null	Mermaid Config
component_border_color	string	Optional	cannot be null	Mermaid Config
component_db_bg_color	string	Optional	cannot be null	Mermaid Config
component_db_border_color	string	Optional	cannot be null	Mermaid Config
component_queue_bg_color	string	Optional	cannot be null	Mermaid Config
component_queue_border_color	string	Optional	cannot be null	Mermaid Config
external_component_bg_color	string	Optional	cannot be null	Mermaid Config
external_component_border_color	string	Optional	cannot be null	Mermaid Config
external_component_db_bg_color	string	Optional	cannot be null	Mermaid Config
external_component_db_border_color	string	Optional	cannot be null	Mermaid Config
external_component_queue_bg_color	string	Optional	cannot be null	Mermaid Config
external_component_queue_border_color	string	Optional	cannot be null	Mermaid Config
personFont	Not specified	Optional	cannot be null	Mermaid Config
external_personFont	Not specified	Optional	cannot be null	Mermaid Config
systemFont	Not specified	Optional	cannot be null	Mermaid Config
external_systemFont	Not specified	Optional	cannot be null	Mermaid Config
system_dbFont	Not specified	Optional	cannot be null	Mermaid Config
external_system_dbFont	Not specified	Optional	cannot be null	Mermaid Config
system_queueFont	Not specified	Optional	cannot be null	Mermaid Config
external_system_queueFont	Not specified	Optional	cannot be null	Mermaid Config
containerFont	Not specified	Optional	cannot be null	Mermaid Config
external_containerFont	Not specified	Optional	cannot be null	Mermaid Config
container_dbFont	Not specified	Optional	cannot be null	Mermaid Config
external_container_dbFont	Not specified	Optional	cannot be null	Mermaid Config
container_queueFont	Not specified	Optional	cannot be null	Mermaid Config
external_container_queueFont	Not specified	Optional	cannot be null	Mermaid Config
componentFont	Not specified	Optional	cannot be null	Mermaid Config
external_componentFont	Not specified	Optional	cannot be null	Mermaid Config
component_dbFont	Not specified	Optional	cannot be null	Mermaid Config
external_component_dbFont	Not specified	Optional	cannot be null	Mermaid Config
component_queueFont	Not specified	Optional	cannot be null	Mermaid Config
external_component_queueFont	Not specified	Optional	cannot be null	Mermaid Config
boundaryFont	Not specified	Optional	cannot be null	Mermaid Config
messageFont	Not specified	Optional	cannot be null	Mermaid Config

diagramMarginX

Margin to the right and left of the c4 diagram, must be a positive value.

diagramMarginX

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

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

diagramMarginX Default Value

The default value is:

50

diagramMarginY

Margin to the over and under the c4 diagram, must be a positive value.

diagramMarginY

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

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

diagramMarginY Default Value

The default value is:

10

c4ShapeMargin

Margin between shapes

c4ShapeMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

c4ShapeMargin Type

integer

c4ShapeMargin Constraints

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

c4ShapeMargin Default Value

The default value is:

50

c4ShapePadding

Padding between shapes

c4ShapePadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

c4ShapePadding Type

integer

c4ShapePadding Constraints

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

c4ShapePadding Default Value

The default value is:

20

width

Width of person boxes

width

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

width Type

integer

width Constraints

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

width Default Value

The default value is:

216

height

Height of person boxes

height

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

height Type

integer

height Constraints

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

height Default Value

The default value is:

60

boxMargin

Margin around boxes

boxMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

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

boxMargin Default Value

The default value is:

10

c4ShapeInRow

How many shapes to place in each row.

c4ShapeInRow

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

c4ShapeInRow Type

integer

c4ShapeInRow Constraints

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

c4ShapeInRow Default Value

The default value is:

4

nextLinePaddingX

nextLinePaddingX

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

nextLinePaddingX Type

number

c4BoundaryInRow

How many boundaries to place in each row.

c4BoundaryInRow

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

c4BoundaryInRow Type

integer

c4BoundaryInRow Constraints

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

c4BoundaryInRow Default Value

The default value is:

2

personFontSize

This sets the font size of Person shape for the diagram

personFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

personFontSize Type

any of the following: string or number (Details)

personFontSize Default Value

The default value is:

14

personFontFamily

This sets the font weight of Person shape for the diagram

personFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

personFontFamily Type

string

personFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

personFontWeight

This sets the font weight of Person shape for the diagram

personFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

personFontWeight Type

any of the following: string or number (Details)

personFontWeight Default Value

The default value is:

"normal"

external_personFontSize

This sets the font size of External Person shape for the diagram

external_personFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_personFontSize Type

any of the following: string or number (Details)

external_personFontSize Default Value

The default value is:

14

external_personFontFamily

This sets the font family of External Person shape for the diagram

external_personFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_personFontFamily Type

string

external_personFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_personFontWeight

This sets the font weight of External Person shape for the diagram

external_personFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_personFontWeight Type

any of the following: string or number (Details)

external_personFontWeight Default Value

The default value is:

"normal"

systemFontSize

This sets the font size of System shape for the diagram

systemFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

systemFontSize Type

any of the following: string or number (Details)

systemFontSize Default Value

The default value is:

14

systemFontFamily

This sets the font family of System shape for the diagram

systemFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

systemFontFamily Type

string

systemFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

systemFontWeight

This sets the font weight of System shape for the diagram

systemFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

systemFontWeight Type

any of the following: string or number (Details)

systemFontWeight Default Value

The default value is:

"normal"

external_systemFontSize

This sets the font size of External System shape for the diagram

external_systemFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_systemFontSize Type

any of the following: string or number (Details)

external_systemFontSize Default Value

The default value is:

14

external_systemFontFamily

This sets the font family of External System shape for the diagram

external_systemFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_systemFontFamily Type

string

external_systemFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_systemFontWeight

This sets the font weight of External System shape for the diagram

external_systemFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_systemFontWeight Type

any of the following: string or number (Details)

external_systemFontWeight Default Value

The default value is:

"normal"

system_dbFontSize

This sets the font size of System DB shape for the diagram

system_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

system_dbFontSize Type

any of the following: string or number (Details)

system_dbFontSize Default Value

The default value is:

14

system_dbFontFamily

This sets the font family of System DB shape for the diagram

system_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_dbFontFamily Type

string

system_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

system_dbFontWeight

This sets the font weight of System DB shape for the diagram

system_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

system_dbFontWeight Type

any of the following: string or number (Details)

system_dbFontWeight Default Value

The default value is:

"normal"

external_system_dbFontSize

This sets the font size of External System DB shape for the diagram

external_system_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_system_dbFontSize Type

any of the following: string or number (Details)

external_system_dbFontSize Default Value

The default value is:

14

external_system_dbFontFamily

This sets the font family of External System DB shape for the diagram

external_system_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_dbFontFamily Type

string

external_system_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_system_dbFontWeight

This sets the font weight of External System DB shape for the diagram

external_system_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_system_dbFontWeight Type

any of the following: string or number (Details)

external_system_dbFontWeight Default Value

The default value is:

"normal"

system_queueFontSize

This sets the font size of System Queue shape for the diagram

system_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

system_queueFontSize Type

any of the following: string or number (Details)

system_queueFontSize Default Value

The default value is:

14

system_queueFontFamily

This sets the font family of System Queue shape for the diagram

system_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_queueFontFamily Type

string

system_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

system_queueFontWeight

This sets the font weight of System Queue shape for the diagram

system_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

system_queueFontWeight Type

any of the following: string or number (Details)

system_queueFontWeight Default Value

The default value is:

"normal"

external_system_queueFontSize

This sets the font size of External System Queue shape for the diagram

external_system_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_system_queueFontSize Type

any of the following: string or number (Details)

external_system_queueFontSize Default Value

The default value is:

14

external_system_queueFontFamily

This sets the font family of External System Queue shape for the diagram

external_system_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_queueFontFamily Type

string

external_system_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_system_queueFontWeight

This sets the font weight of External System Queue shape for the diagram

external_system_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_system_queueFontWeight Type

any of the following: string or number (Details)

external_system_queueFontWeight Default Value

The default value is:

"normal"

boundaryFontSize

This sets the font size of Boundary shape for the diagram

boundaryFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

boundaryFontSize Type

any of the following: string or number (Details)

boundaryFontSize Default Value

The default value is:

14

boundaryFontFamily

This sets the font family of Boundary shape for the diagram

boundaryFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

boundaryFontFamily Type

string

boundaryFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

boundaryFontWeight

This sets the font weight of Boundary shape for the diagram

boundaryFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

boundaryFontWeight Type

any of the following: string or number (Details)

boundaryFontWeight Default Value

The default value is:

"normal"

messageFontSize

This sets the font size of Message shape for the diagram

messageFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

messageFontSize Type

any of the following: string or number (Details)

messageFontSize Default Value

The default value is:

12

messageFontFamily

This sets the font family of Message shape for the diagram

messageFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

messageFontFamily Type

string

messageFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

messageFontWeight

This sets the font weight of Message shape for the diagram

messageFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

messageFontWeight Type

any of the following: string or number (Details)

messageFontWeight Default Value

The default value is:

"normal"

containerFontSize

This sets the font size of Container shape for the diagram

containerFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

containerFontSize Type

any of the following: string or number (Details)

containerFontSize Default Value

The default value is:

14

containerFontFamily

This sets the font family of Container shape for the diagram

containerFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

containerFontFamily Type

string

containerFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

containerFontWeight

This sets the font weight of Container shape for the diagram

containerFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

containerFontWeight Type

any of the following: string or number (Details)

containerFontWeight Default Value

The default value is:

"normal"

external_containerFontSize

This sets the font size of External Container shape for the diagram

external_containerFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_containerFontSize Type

any of the following: string or number (Details)

external_containerFontSize Default Value

The default value is:

14

external_containerFontFamily

This sets the font family of External Container shape for the diagram

external_containerFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_containerFontFamily Type

string

external_containerFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_containerFontWeight

This sets the font weight of External Container shape for the diagram

external_containerFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_containerFontWeight Type

any of the following: string or number (Details)

external_containerFontWeight Default Value

The default value is:

"normal"

container_dbFontSize

This sets the font size of Container DB shape for the diagram

container_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

container_dbFontSize Type

any of the following: string or number (Details)

container_dbFontSize Default Value

The default value is:

14

container_dbFontFamily

This sets the font family of Container DB shape for the diagram

container_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_dbFontFamily Type

string

container_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

container_dbFontWeight

This sets the font weight of Container DB shape for the diagram

container_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

container_dbFontWeight Type

any of the following: string or number (Details)

container_dbFontWeight Default Value

The default value is:

"normal"

external_container_dbFontSize

This sets the font size of External Container DB shape for the diagram

external_container_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_container_dbFontSize Type

any of the following: string or number (Details)

external_container_dbFontSize Default Value

The default value is:

14

external_container_dbFontFamily

This sets the font family of External Container DB shape for the diagram

external_container_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_dbFontFamily Type

string

external_container_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_container_dbFontWeight

This sets the font weight of External Container DB shape for the diagram

external_container_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_container_dbFontWeight Type

any of the following: string or number (Details)

external_container_dbFontWeight Default Value

The default value is:

"normal"

container_queueFontSize

This sets the font size of Container Queue shape for the diagram

container_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

container_queueFontSize Type

any of the following: string or number (Details)

container_queueFontSize Default Value

The default value is:

14

container_queueFontFamily

This sets the font family of Container Queue shape for the diagram

container_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_queueFontFamily Type

string

container_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

container_queueFontWeight

This sets the font weight of Container Queue shape for the diagram

container_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

container_queueFontWeight Type

any of the following: string or number (Details)

container_queueFontWeight Default Value

The default value is:

"normal"

external_container_queueFontSize

This sets the font size of External Container Queue shape for the diagram

external_container_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_container_queueFontSize Type

any of the following: string or number (Details)

external_container_queueFontSize Default Value

The default value is:

14

external_container_queueFontFamily

This sets the font family of External Container Queue shape for the diagram

external_container_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_queueFontFamily Type

string

external_container_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_container_queueFontWeight

This sets the font weight of External Container Queue shape for the diagram

external_container_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_container_queueFontWeight Type

any of the following: string or number (Details)

external_container_queueFontWeight Default Value

The default value is:

"normal"

componentFontSize

This sets the font size of Component shape for the diagram

componentFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

componentFontSize Type

any of the following: string or number (Details)

componentFontSize Default Value

The default value is:

14

componentFontFamily

This sets the font family of Component shape for the diagram

componentFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

componentFontFamily Type

string

componentFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

componentFontWeight

This sets the font weight of Component shape for the diagram

componentFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

componentFontWeight Type

any of the following: string or number (Details)

componentFontWeight Default Value

The default value is:

"normal"

external_componentFontSize

This sets the font size of External Component shape for the diagram

external_componentFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_componentFontSize Type

any of the following: string or number (Details)

external_componentFontSize Default Value

The default value is:

14

external_componentFontFamily

This sets the font family of External Component shape for the diagram

external_componentFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_componentFontFamily Type

string

external_componentFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_componentFontWeight

This sets the font weight of External Component shape for the diagram

external_componentFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_componentFontWeight Type

any of the following: string or number (Details)

external_componentFontWeight Default Value

The default value is:

"normal"

component_dbFontSize

This sets the font size of Component DB shape for the diagram

component_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

component_dbFontSize Type

any of the following: string or number (Details)

component_dbFontSize Default Value

The default value is:

14

component_dbFontFamily

This sets the font family of Component DB shape for the diagram

component_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_dbFontFamily Type

string

component_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

component_dbFontWeight

This sets the font weight of Component DB shape for the diagram

component_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

component_dbFontWeight Type

any of the following: string or number (Details)

component_dbFontWeight Default Value

The default value is:

"normal"

external_component_dbFontSize

This sets the font size of External Component DB shape for the diagram

external_component_dbFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_component_dbFontSize Type

any of the following: string or number (Details)

external_component_dbFontSize Default Value

The default value is:

14

external_component_dbFontFamily

This sets the font family of External Component DB shape for the diagram

external_component_dbFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_dbFontFamily Type

string

external_component_dbFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_component_dbFontWeight

This sets the font weight of External Component DB shape for the diagram

external_component_dbFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_component_dbFontWeight Type

any of the following: string or number (Details)

external_component_dbFontWeight Default Value

The default value is:

"normal"

component_queueFontSize

This sets the font size of Component Queue shape for the diagram

component_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

component_queueFontSize Type

any of the following: string or number (Details)

component_queueFontSize Default Value

The default value is:

14

component_queueFontFamily

This sets the font family of Component Queue shape for the diagram

component_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_queueFontFamily Type

string

component_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

component_queueFontWeight

This sets the font weight of Component Queue shape for the diagram

component_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

component_queueFontWeight Type

any of the following: string or number (Details)

component_queueFontWeight Default Value

The default value is:

"normal"

external_component_queueFontSize

This sets the font size of External Component Queue shape for the diagram

external_component_queueFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_component_queueFontSize Type

any of the following: string or number (Details)

external_component_queueFontSize Default Value

The default value is:

14

external_component_queueFontFamily

This sets the font family of External Component Queue shape for the diagram

external_component_queueFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_queueFontFamily Type

string

external_component_queueFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

external_component_queueFontWeight

This sets the font weight of External Component Queue shape for the diagram

external_component_queueFontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

external_component_queueFontWeight Type

any of the following: string or number (Details)

external_component_queueFontWeight Default Value

The default value is:

"normal"

wrap

This sets the auto-wrap state for the diagram

wrap

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

wrap Type

boolean

wrap Default Value

The default value is:

true

wrapPadding

This sets the auto-wrap padding for the diagram (sides only)

wrapPadding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

wrapPadding Type

number

wrapPadding Default Value

The default value is:

10

person_bg_color

person_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

person_bg_color Type

string

person_bg_color Default Value

The default value is:

"#08427B"

person_border_color

person_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

person_border_color Type

string

person_border_color Default Value

The default value is:

"#073B6F"

external_person_bg_color

external_person_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_person_bg_color Type

string

external_person_bg_color Default Value

The default value is:

"#686868"

external_person_border_color

external_person_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_person_border_color Type

string

external_person_border_color Default Value

The default value is:

"#8A8A8A"

system_bg_color

system_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_bg_color Type

string

system_bg_color Default Value

The default value is:

"#1168BD"

system_border_color

system_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_border_color Type

string

system_border_color Default Value

The default value is:

"#3C7FC0"

system_db_bg_color

system_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_db_bg_color Type

string

system_db_bg_color Default Value

The default value is:

"#1168BD"

system_db_border_color

system_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_db_border_color Type

string

system_db_border_color Default Value

The default value is:

"#3C7FC0"

system_queue_bg_color

system_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_queue_bg_color Type

string

system_queue_bg_color Default Value

The default value is:

"#1168BD"

system_queue_border_color

system_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

system_queue_border_color Type

string

system_queue_border_color Default Value

The default value is:

"#3C7FC0"

external_system_bg_color

external_system_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_bg_color Type

string

external_system_bg_color Default Value

The default value is:

"#999999"

external_system_border_color

external_system_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_border_color Type

string

external_system_border_color Default Value

The default value is:

"#8A8A8A"

external_system_db_bg_color

external_system_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_db_bg_color Type

string

external_system_db_bg_color Default Value

The default value is:

"#999999"

external_system_db_border_color

external_system_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_db_border_color Type

string

external_system_db_border_color Default Value

The default value is:

"#8A8A8A"

external_system_queue_bg_color

external_system_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_queue_bg_color Type

string

external_system_queue_bg_color Default Value

The default value is:

"#999999"

external_system_queue_border_color

external_system_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_system_queue_border_color Type

string

external_system_queue_border_color Default Value

The default value is:

"#8A8A8A"

container_bg_color

container_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_bg_color Type

string

container_bg_color Default Value

The default value is:

"#438DD5"

container_border_color

container_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_border_color Type

string

container_border_color Default Value

The default value is:

"#3C7FC0"

container_db_bg_color

container_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_db_bg_color Type

string

container_db_bg_color Default Value

The default value is:

"#438DD5"

container_db_border_color

container_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_db_border_color Type

string

container_db_border_color Default Value

The default value is:

"#3C7FC0"

container_queue_bg_color

container_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_queue_bg_color Type

string

container_queue_bg_color Default Value

The default value is:

"#438DD5"

container_queue_border_color

container_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

container_queue_border_color Type

string

container_queue_border_color Default Value

The default value is:

"#3C7FC0"

external_container_bg_color

external_container_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_bg_color Type

string

external_container_bg_color Default Value

The default value is:

"#B3B3B3"

external_container_border_color

external_container_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_border_color Type

string

external_container_border_color Default Value

The default value is:

"#A6A6A6"

external_container_db_bg_color

external_container_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_db_bg_color Type

string

external_container_db_bg_color Default Value

The default value is:

"#B3B3B3"

external_container_db_border_color

external_container_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_db_border_color Type

string

external_container_db_border_color Default Value

The default value is:

"#A6A6A6"

external_container_queue_bg_color

external_container_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_queue_bg_color Type

string

external_container_queue_bg_color Default Value

The default value is:

"#B3B3B3"

external_container_queue_border_color

external_container_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_container_queue_border_color Type

string

external_container_queue_border_color Default Value

The default value is:

"#A6A6A6"

component_bg_color

component_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_bg_color Type

string

component_bg_color Default Value

The default value is:

"#85BBF0"

component_border_color

component_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_border_color Type

string

component_border_color Default Value

The default value is:

"#78A8D8"

component_db_bg_color

component_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_db_bg_color Type

string

component_db_bg_color Default Value

The default value is:

"#85BBF0"

component_db_border_color

component_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_db_border_color Type

string

component_db_border_color Default Value

The default value is:

"#78A8D8"

component_queue_bg_color

component_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_queue_bg_color Type

string

component_queue_bg_color Default Value

The default value is:

"#85BBF0"

component_queue_border_color

component_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

component_queue_border_color Type

string

component_queue_border_color Default Value

The default value is:

"#78A8D8"

external_component_bg_color

external_component_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_bg_color Type

string

external_component_bg_color Default Value

The default value is:

"#CCCCCC"

external_component_border_color

external_component_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_border_color Type

string

external_component_border_color Default Value

The default value is:

"#BFBFBF"

external_component_db_bg_color

external_component_db_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_db_bg_color Type

string

external_component_db_bg_color Default Value

The default value is:

"#CCCCCC"

external_component_db_border_color

external_component_db_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_db_border_color Type

string

external_component_db_border_color Default Value

The default value is:

"#BFBFBF"

external_component_queue_bg_color

external_component_queue_bg_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_queue_bg_color Type

string

external_component_queue_bg_color Default Value

The default value is:

"#CCCCCC"

external_component_queue_border_color

external_component_queue_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

external_component_queue_border_color Type

string

external_component_queue_border_color Default Value

The default value is:

"#BFBFBF"

personFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

personFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

personFont Type

unknown (Font Calculator)

external_personFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_personFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_personFont Type

unknown (Font Calculator)

systemFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

systemFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

systemFont Type

unknown (Font Calculator)

external_systemFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_systemFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_systemFont Type

unknown (Font Calculator)

system_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

system_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

system_dbFont Type

unknown (Font Calculator)

external_system_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_system_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_system_dbFont Type

unknown (Font Calculator)

system_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

system_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

system_queueFont Type

unknown (Font Calculator)

external_system_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_system_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_system_queueFont Type

unknown (Font Calculator)

containerFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

containerFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

containerFont Type

unknown (Font Calculator)

external_containerFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_containerFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_containerFont Type

unknown (Font Calculator)

container_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

container_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

container_dbFont Type

unknown (Font Calculator)

external_container_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_container_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_container_dbFont Type

unknown (Font Calculator)

container_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

container_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

container_queueFont Type

unknown (Font Calculator)

external_container_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_container_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_container_queueFont Type

unknown (Font Calculator)

componentFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

componentFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

componentFont Type

unknown (Font Calculator)

external_componentFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_componentFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_componentFont Type

unknown (Font Calculator)

component_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

component_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

component_dbFont Type

unknown (Font Calculator)

external_component_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_component_dbFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_component_dbFont Type

unknown (Font Calculator)

component_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

component_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

component_queueFont Type

unknown (Font Calculator)

external_component_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_component_queueFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

external_component_queueFont Type

unknown (Font Calculator)

boundaryFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

boundaryFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

boundaryFont Type

unknown (Font Calculator)

messageFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

messageFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

messageFont Type

unknown (Font Calculator)

Definitions group GitGraphDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/GitGraphDiagramConfig" }

Property	Type	Required	Nullable	Defined by
titleTopMargin	integer	Required	cannot be null	Mermaid Config
diagramPadding	number	Optional	cannot be null	Mermaid Config
nodeLabel	Merged	Optional	cannot be null	Mermaid Config
mainBranchName	string	Optional	cannot be null	Mermaid Config
mainBranchOrder	number	Optional	cannot be null	Mermaid Config
showCommitLabel	boolean	Optional	cannot be null	Mermaid Config
showBranches	boolean	Optional	cannot be null	Mermaid Config
rotateCommitLabel	boolean	Optional	cannot be null	Mermaid Config
parallelCommits	boolean	Optional	cannot be null	Mermaid Config
arrowMarkerAbsolute	boolean	Optional	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

diagramPadding

diagramPadding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

diagramPadding Type

number

diagramPadding Default Value

The default value is:

8

nodeLabel

nodeLabel

• is optional

• Type: object (Details)

• cannot be null

• defined in: Mermaid Config

nodeLabel Type

object (Details)

all of

• Node Label

nodeLabel Default Value

The default value is:

{
  "width": 75,
  "height": 100,
  "x": -25,
  "y": 0
}

mainBranchName

mainBranchName

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

mainBranchName Type

string

mainBranchName Default Value

The default value is:

"main"

mainBranchOrder

mainBranchOrder

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

mainBranchOrder Type

number

showCommitLabel

showCommitLabel

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showCommitLabel Type

boolean

showCommitLabel Default Value

The default value is:

true

showBranches

showBranches

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showBranches Type

boolean

showBranches Default Value

The default value is:

true

rotateCommitLabel

rotateCommitLabel

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

rotateCommitLabel Type

boolean

rotateCommitLabel Default Value

The default value is:

true

parallelCommits

parallelCommits

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

parallelCommits Type

boolean

arrowMarkerAbsolute

Controls whether or arrow markers in html code are absolute paths or anchors. This matters if you are using base tag settings.

arrowMarkerAbsolute

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

Definitions group NodeLabel

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/NodeLabel" }

Property	Type	Required	Nullable	Defined by
width	number	Optional	cannot be null	Mermaid Config
height	number	Optional	cannot be null	Mermaid Config
x	number	Optional	cannot be null	Mermaid Config
y	number	Optional	cannot be null	Mermaid Config

width

width

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

width Type

number

height

height

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

height Type

number

x

x

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

x Type

number

y

y

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

y Type

number

Definitions group RequirementDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/RequirementDiagramConfig" }

Property	Type	Required	Nullable	Defined by
rect_fill	string	Optional	cannot be null	Mermaid Config
text_color	string	Optional	cannot be null	Mermaid Config
rect_border_size	string	Optional	cannot be null	Mermaid Config
rect_border_color	string	Optional	cannot be null	Mermaid Config
rect_min_width	number	Optional	cannot be null	Mermaid Config
rect_min_height	number	Optional	cannot be null	Mermaid Config
fontSize	number	Optional	cannot be null	Mermaid Config
rect_padding	number	Optional	cannot be null	Mermaid Config
line_height	number	Optional	cannot be null	Mermaid Config

rect_fill

rect_fill

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

rect_fill Type

string

rect_fill Default Value

The default value is:

"#f9f9f9"

text_color

text_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

text_color Type

string

text_color Default Value

The default value is:

"#333"

rect_border_size

rect_border_size

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

rect_border_size Type

string

rect_border_size Default Value

The default value is:

"0.5px"

rect_border_color

rect_border_color

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

rect_border_color Type

string

rect_border_color Default Value

The default value is:

"#bbb"

rect_min_width

rect_min_width

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

rect_min_width Type

number

rect_min_width Default Value

The default value is:

200

rect_min_height

rect_min_height

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

rect_min_height Type

number

rect_min_height Default Value

The default value is:

200

fontSize

fontSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSize Type

number

fontSize Default Value

The default value is:

14

rect_padding

rect_padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

rect_padding Type

number

rect_padding Default Value

The default value is:

10

line_height

line_height

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

line_height Type

number

line_height Default Value

The default value is:

20

Definitions group ArchitectureDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/ArchitectureDiagramConfig" }

Property	Type	Required	Nullable	Defined by
padding	number	Required	cannot be null	Mermaid Config
iconSize	number	Required	cannot be null	Mermaid Config
fontSize	number	Required	cannot be null	Mermaid Config

padding

padding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

40

iconSize

iconSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

iconSize Type

number

iconSize Default Value

The default value is:

80

fontSize

fontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSize Type

number

fontSize Default Value

The default value is:

16

Definitions group MindmapDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/MindmapDiagramConfig" }

Property	Type	Required	Nullable	Defined by
padding	number	Required	cannot be null	Mermaid Config
maxNodeWidth	number	Required	cannot be null	Mermaid Config

padding

padding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

10

maxNodeWidth

maxNodeWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

maxNodeWidth Type

number

maxNodeWidth Default Value

The default value is:

200

Definitions group KanbanDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/KanbanDiagramConfig" }

Property	Type	Required	Nullable	Defined by
padding	number	Optional	cannot be null	Mermaid Config
sectionWidth	number	Optional	cannot be null	Mermaid Config
ticketBaseUrl	string	Optional	cannot be null	Mermaid Config

padding

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

8

sectionWidth

sectionWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

sectionWidth Type

number

sectionWidth Default Value

The default value is:

200

ticketBaseUrl

ticketBaseUrl

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

ticketBaseUrl Type

string

Definitions group PieDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/PieDiagramConfig" }

Property	Type	Required	Nullable	Defined by
textPosition	number	Optional	cannot be null	Mermaid Config

textPosition

Axial position of slice's label from zero at the center to 1 at the outside edges.

textPosition

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

textPosition Type

number

textPosition Constraints

maximum: the value of this number must smaller than or equal to: 1

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

textPosition Default Value

The default value is:

0.75

Definitions group QuadrantChartConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/QuadrantChartConfig" }

Property	Type	Required	Nullable	Defined by
chartWidth	number	Required	cannot be null	Mermaid Config
chartHeight	number	Required	cannot be null	Mermaid Config
titleFontSize	number	Required	cannot be null	Mermaid Config
titlePadding	number	Required	cannot be null	Mermaid Config
quadrantPadding	number	Required	cannot be null	Mermaid Config
xAxisLabelPadding	number	Required	cannot be null	Mermaid Config
yAxisLabelPadding	number	Required	cannot be null	Mermaid Config
xAxisLabelFontSize	number	Required	cannot be null	Mermaid Config
yAxisLabelFontSize	number	Required	cannot be null	Mermaid Config
quadrantLabelFontSize	number	Required	cannot be null	Mermaid Config
quadrantTextTopPadding	number	Required	cannot be null	Mermaid Config
pointTextPadding	number	Required	cannot be null	Mermaid Config
pointLabelFontSize	number	Required	cannot be null	Mermaid Config
pointRadius	number	Required	cannot be null	Mermaid Config
xAxisPosition	string	Required	cannot be null	Mermaid Config
yAxisPosition	string	Required	cannot be null	Mermaid Config
quadrantInternalBorderStrokeWidth	number	Required	cannot be null	Mermaid Config
quadrantExternalBorderStrokeWidth	number	Required	cannot be null	Mermaid Config

chartWidth

Width of the chart

chartWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

chartWidth Type

number

chartWidth Constraints

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

chartWidth Default Value

The default value is:

500

chartHeight

Height of the chart

chartHeight

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

chartHeight Type

number

chartHeight Constraints

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

chartHeight Default Value

The default value is:

500

titleFontSize

Chart title top and bottom padding

titleFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titleFontSize Type

number

titleFontSize Constraints

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

titleFontSize Default Value

The default value is:

20

titlePadding

Padding around the quadrant square

titlePadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titlePadding Type

number

titlePadding Constraints

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

titlePadding Default Value

The default value is:

10

quadrantPadding

quadrant title padding from top if the quadrant is rendered on top

quadrantPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantPadding Type

number

quadrantPadding Constraints

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

quadrantPadding Default Value

The default value is:

5

xAxisLabelPadding

Padding around x-axis labels

xAxisLabelPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

xAxisLabelPadding Type

number

xAxisLabelPadding Constraints

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

xAxisLabelPadding Default Value

The default value is:

5

yAxisLabelPadding

Padding around y-axis labels

yAxisLabelPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

yAxisLabelPadding Type

number

yAxisLabelPadding Constraints

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

yAxisLabelPadding Default Value

The default value is:

5

xAxisLabelFontSize

x-axis label font size

xAxisLabelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

xAxisLabelFontSize Type

number

xAxisLabelFontSize Constraints

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

xAxisLabelFontSize Default Value

The default value is:

16

yAxisLabelFontSize

y-axis label font size

yAxisLabelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

yAxisLabelFontSize Type

number

yAxisLabelFontSize Constraints

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

yAxisLabelFontSize Default Value

The default value is:

16

quadrantLabelFontSize

quadrant title font size

quadrantLabelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantLabelFontSize Type

number

quadrantLabelFontSize Constraints

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

quadrantLabelFontSize Default Value

The default value is:

16

quadrantTextTopPadding

quadrant title padding from top if the quadrant is rendered on top

quadrantTextTopPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantTextTopPadding Type

number

quadrantTextTopPadding Constraints

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

quadrantTextTopPadding Default Value

The default value is:

5

pointTextPadding

padding between point and point label

pointTextPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

pointTextPadding Type

number

pointTextPadding Constraints

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

pointTextPadding Default Value

The default value is:

5

pointLabelFontSize

point title font size

pointLabelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

pointLabelFontSize Type

number

pointLabelFontSize Constraints

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

pointLabelFontSize Default Value

The default value is:

12

pointRadius

radius of the point to be drawn

pointRadius

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

pointRadius Type

number

pointRadius Constraints

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

pointRadius Default Value

The default value is:

5

xAxisPosition

position of x-axis labels

xAxisPosition

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

xAxisPosition Type

string

xAxisPosition Constraints

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

Value	Explanation
"top"
"bottom"

xAxisPosition Default Value

The default value is:

"top"

yAxisPosition

position of y-axis labels

yAxisPosition

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

yAxisPosition Type

string

yAxisPosition Constraints

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

Value	Explanation
"left"
"right"

yAxisPosition Default Value

The default value is:

"left"

quadrantInternalBorderStrokeWidth

stroke width of edges of the box that are inside the quadrant

quadrantInternalBorderStrokeWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantInternalBorderStrokeWidth Type

number

quadrantInternalBorderStrokeWidth Constraints

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

quadrantInternalBorderStrokeWidth Default Value

The default value is:

1

quadrantExternalBorderStrokeWidth

stroke width of edges of the box that are outside the quadrant

quadrantExternalBorderStrokeWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

quadrantExternalBorderStrokeWidth Type

number

quadrantExternalBorderStrokeWidth Constraints

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

quadrantExternalBorderStrokeWidth Default Value

The default value is:

2

Definitions group XYChartAxisConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/XYChartAxisConfig" }

Property	Type	Required	Nullable	Defined by
showLabel	boolean	Required	cannot be null	Mermaid Config
labelFontSize	number	Required	cannot be null	Mermaid Config
labelPadding	number	Required	cannot be null	Mermaid Config
showTitle	boolean	Required	cannot be null	Mermaid Config
titleFontSize	number	Required	cannot be null	Mermaid Config
titlePadding	number	Required	cannot be null	Mermaid Config
showTick	boolean	Required	cannot be null	Mermaid Config
tickLength	number	Required	cannot be null	Mermaid Config
tickWidth	number	Required	cannot be null	Mermaid Config
showAxisLine	boolean	Required	cannot be null	Mermaid Config
axisLineWidth	number	Required	cannot be null	Mermaid Config

showLabel

Should show the axis labels (tick text)

showLabel

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showLabel Type

boolean

showLabel Default Value

The default value is:

true

labelFontSize

font size of the axis labels (tick text)

labelFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

labelFontSize Type

number

labelFontSize Constraints

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

labelFontSize Default Value

The default value is:

14

labelPadding

top and bottom space from axis label (tick text)

labelPadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

labelPadding Type

number

labelPadding Constraints

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

labelPadding Default Value

The default value is:

5

showTitle

Should show the axis title

showTitle

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showTitle Type

boolean

showTitle Default Value

The default value is:

true

titleFontSize

font size of the axis title

titleFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titleFontSize Type

number

titleFontSize Constraints

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

titleFontSize Default Value

The default value is:

16

titlePadding

top and bottom space from axis title

titlePadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titlePadding Type

number

titlePadding Constraints

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

titlePadding Default Value

The default value is:

5

showTick

Should show the axis tick lines

showTick

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showTick Type

boolean

showTick Default Value

The default value is:

true

tickLength

length of the axis tick lines

tickLength

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

tickLength Type

number

tickLength Constraints

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

tickLength Default Value

The default value is:

5

tickWidth

width of the axis tick lines

tickWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

tickWidth Type

number

tickWidth Constraints

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

tickWidth Default Value

The default value is:

2

showAxisLine

Show line across the axis

showAxisLine

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showAxisLine Type

boolean

showAxisLine Default Value

The default value is:

true

axisLineWidth

Width of the axis line

axisLineWidth

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

axisLineWidth Type

number

axisLineWidth Constraints

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

axisLineWidth Default Value

The default value is:

2

Definitions group XYChartConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/XYChartConfig" }

Property	Type	Required	Nullable	Defined by
width	number	Required	cannot be null	Mermaid Config
height	number	Required	cannot be null	Mermaid Config
titleFontSize	number	Required	cannot be null	Mermaid Config
titlePadding	number	Required	cannot be null	Mermaid Config
showTitle	boolean	Required	cannot be null	Mermaid Config
xAxis	object	Required	cannot be null	Mermaid Config
yAxis	object	Required	cannot be null	Mermaid Config
chartOrientation	Not specified	Required	cannot be null	Mermaid Config
plotReservedSpacePercent	number	Required	cannot be null	Mermaid Config

width

width of the chart

width

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

width Type

number

width Constraints

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

width Default Value

The default value is:

700

height

height of the chart

height

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

height Type

number

height Constraints

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

height Default Value

The default value is:

500

titleFontSize

Font size of the chart title

titleFontSize

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titleFontSize Type

number

titleFontSize Constraints

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

titleFontSize Default Value

The default value is:

20

titlePadding

Top and bottom space from the chart title

titlePadding

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

titlePadding Type

number

titlePadding Constraints

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

titlePadding Default Value

The default value is:

10

showTitle

Should show the chart title

showTitle

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showTitle Type

boolean

showTitle Default Value

The default value is:

true

xAxis

This object contains configuration for XYChart axis config

xAxis

• is required

• Type: object (XYChart axis config)

• cannot be null

• defined in: Mermaid Config

xAxis Type

object (XYChart axis config)

xAxis Default Value

The default value is:

{
  "$ref": "#/$defs/XYChartAxisConfig",
  "title": "XYChart axis config",
  "description": "This object contains configuration for XYChart axis config",
  "type": "object",
  "unevaluatedProperties": true,
  "required": [
    "showLabel",
    "labelFontSize",
    "labelPadding",
    "showTitle",
    "titleFontSize",
    "titlePadding",
    "showTick",
    "tickLength",
    "tickWidth",
    "showAxisLine",
    "axisLineWidth"
  ],
  "properties": {
    "showLabel": {
      "description": "Should show the axis labels (tick text)",
      "type": "boolean",
      "default": true
    },
    "labelFontSize": {
      "description": "font size of the axis labels (tick text)",
      "type": "number",
      "default": 14,
      "minimum": 1
    },
    "labelPadding": {
      "description": "top and bottom space from axis label (tick text)",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTitle": {
      "description": "Should show the axis title",
      "type": "boolean",
      "default": true
    },
    "titleFontSize": {
      "description": "font size of the axis title",
      "type": "number",
      "default": 16,
      "minimum": 1
    },
    "titlePadding": {
      "description": "top and bottom space from axis title",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTick": {
      "description": "Should show the axis tick lines",
      "type": "boolean",
      "default": true
    },
    "tickLength": {
      "description": "length of the axis tick lines",
      "type": "number",
      "default": 5,
      "minimum": 1
    },
    "tickWidth": {
      "description": "width of the axis tick lines",
      "type": "number",
      "default": 2,
      "minimum": 1
    },
    "showAxisLine": {
      "description": "Show line across the axis",
      "type": "boolean",
      "default": true
    },
    "axisLineWidth": {
      "description": "Width of the axis line",
      "type": "number",
      "default": 2,
      "minimum": 1
    }
  }
}

yAxis

This object contains configuration for XYChart axis config

yAxis

• is required

• Type: object (XYChart axis config)

• cannot be null

• defined in: Mermaid Config

yAxis Type

object (XYChart axis config)

yAxis Default Value

The default value is:

{
  "$ref": "#/$defs/XYChartAxisConfig",
  "title": "XYChart axis config",
  "description": "This object contains configuration for XYChart axis config",
  "type": "object",
  "unevaluatedProperties": true,
  "required": [
    "showLabel",
    "labelFontSize",
    "labelPadding",
    "showTitle",
    "titleFontSize",
    "titlePadding",
    "showTick",
    "tickLength",
    "tickWidth",
    "showAxisLine",
    "axisLineWidth"
  ],
  "properties": {
    "showLabel": {
      "description": "Should show the axis labels (tick text)",
      "type": "boolean",
      "default": true
    },
    "labelFontSize": {
      "description": "font size of the axis labels (tick text)",
      "type": "number",
      "default": 14,
      "minimum": 1
    },
    "labelPadding": {
      "description": "top and bottom space from axis label (tick text)",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTitle": {
      "description": "Should show the axis title",
      "type": "boolean",
      "default": true
    },
    "titleFontSize": {
      "description": "font size of the axis title",
      "type": "number",
      "default": 16,
      "minimum": 1
    },
    "titlePadding": {
      "description": "top and bottom space from axis title",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTick": {
      "description": "Should show the axis tick lines",
      "type": "boolean",
      "default": true
    },
    "tickLength": {
      "description": "length of the axis tick lines",
      "type": "number",
      "default": 5,
      "minimum": 1
    },
    "tickWidth": {
      "description": "width of the axis tick lines",
      "type": "number",
      "default": 2,
      "minimum": 1
    },
    "showAxisLine": {
      "description": "Show line across the axis",
      "type": "boolean",
      "default": true
    },
    "axisLineWidth": {
      "description": "Width of the axis line",
      "type": "number",
      "default": 2,
      "minimum": 1
    }
  }
}

chartOrientation

How to plot will be drawn horizontal or vertical

chartOrientation

• is required

• Type: unknown

• cannot be null

• defined in: Mermaid Config

• tsType: "vertical" | "horizontal"

chartOrientation Type

unknown

chartOrientation Default Value

The default value is:

"vertical"

plotReservedSpacePercent

Minimum percent of space plots of the chart will take

plotReservedSpacePercent

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

plotReservedSpacePercent Type

number

plotReservedSpacePercent Constraints

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

plotReservedSpacePercent Default Value

The default value is:

50

Definitions group ErDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/ErDiagramConfig" }

Property	Type	Required	Nullable	Defined by
titleTopMargin	integer	Required	cannot be null	Mermaid Config
diagramPadding	integer	Required	cannot be null	Mermaid Config
layoutDirection	string	Required	cannot be null	Mermaid Config
minEntityWidth	integer	Required	cannot be null	Mermaid Config
minEntityHeight	integer	Required	cannot be null	Mermaid Config
entityPadding	integer	Required	cannot be null	Mermaid Config
nodeSpacing	integer	Optional	cannot be null	Mermaid Config
rankSpacing	integer	Optional	cannot be null	Mermaid Config
stroke	string	Required	cannot be null	Mermaid Config
fill	string	Required	cannot be null	Mermaid Config
fontSize	integer	Optional	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

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

layoutDirection

Directional bias for layout of entities

layoutDirection

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

layoutDirection Type

string

layoutDirection Constraints

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

Value	Explanation
"TB"	Top-Bottom
"BT"	Bottom-Top
"LR"	Left-Right
"RL"	Right to Left

layoutDirection Default Value

The default value is:

"TB"

minEntityWidth

The minimum width of an entity box. Expressed in pixels.

minEntityWidth

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

minEntityWidth Type

integer

minEntityWidth Constraints

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

minEntityWidth Default Value

The default value is:

100

minEntityHeight

The minimum height of an entity box. Expressed in pixels.

minEntityHeight

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

minEntityHeight Type

integer

minEntityHeight Constraints

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

minEntityHeight Default Value

The default value is:

75

entityPadding

The minimum internal padding between text in an entity box and the enclosing box borders. Expressed in pixels.

entityPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

entityPadding Type

integer

entityPadding Constraints

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

entityPadding Default Value

The default value is:

15

nodeSpacing

nodeSpacing

• is optional

• 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:

140

rankSpacing

rankSpacing

• is optional

• 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:

80

stroke

Stroke color of box edges and lines.

stroke

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

stroke Type

string

stroke Default Value

The default value is:

"gray"

fill

Fill color of entity boxes

fill

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

fill Type

string

fill Default Value

The default value is:

"honeydew"

fontSize

Font size (expressed as an integer representing a number of pixels)

fontSize

• is optional

• Type: integer

• cannot be null

• defined in: Mermaid Config

fontSize Type

integer

fontSize Constraints

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

fontSize Default Value

The default value is:

12

Definitions group StateDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/StateDiagramConfig" }

Property	Type	Required	Nullable	Defined by
titleTopMargin	integer	Required	cannot be null	Mermaid Config
arrowMarkerAbsolute	boolean	Optional	cannot be null	Mermaid Config
dividerMargin	number	Optional	cannot be null	Mermaid Config
sizeUnit	number	Optional	cannot be null	Mermaid Config
padding	number	Optional	cannot be null	Mermaid Config
textHeight	number	Optional	cannot be null	Mermaid Config
titleShift	number	Optional	cannot be null	Mermaid Config
noteMargin	number	Optional	cannot be null	Mermaid Config
nodeSpacing	integer	Optional	cannot be null	Mermaid Config
rankSpacing	integer	Optional	cannot be null	Mermaid Config
forkWidth	number	Optional	cannot be null	Mermaid Config
forkHeight	number	Optional	cannot be null	Mermaid Config
miniPadding	number	Optional	cannot be null	Mermaid Config
fontSizeFactor	number	Optional	cannot be null	Mermaid Config
fontSize	number	Optional	cannot be null	Mermaid Config
labelHeight	number	Optional	cannot be null	Mermaid Config
edgeLengthFactor	string	Optional	cannot be null	Mermaid Config
compositTitleSize	number	Optional	cannot be null	Mermaid Config
radius	number	Optional	cannot be null	Mermaid Config
defaultRenderer	string	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

arrowMarkerAbsolute

arrowMarkerAbsolute

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

dividerMargin

dividerMargin

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

dividerMargin Type

number

dividerMargin Default Value

The default value is:

10

sizeUnit

sizeUnit

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

sizeUnit Type

number

sizeUnit Default Value

The default value is:

5

padding

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

8

textHeight

textHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

textHeight Type

number

textHeight Default Value

The default value is:

10

titleShift

titleShift

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

titleShift Type

number

titleShift Default Value

The default value is:

-15

noteMargin

noteMargin

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

noteMargin Type

number

noteMargin Default Value

The default value is:

10

nodeSpacing

nodeSpacing

• is optional

• 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

rankSpacing

rankSpacing

• is optional

• 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

forkWidth

forkWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

forkWidth Type

number

forkWidth Default Value

The default value is:

70

forkHeight

forkHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

forkHeight Type

number

forkHeight Default Value

The default value is:

7

miniPadding

miniPadding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

miniPadding Type

number

miniPadding Default Value

The default value is:

2

fontSizeFactor

Font size factor, this is used to guess the width of the edges labels before rendering by dagre layout. This might need updating if/when switching font

fontSizeFactor

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSizeFactor Type

number

fontSizeFactor Default Value

The default value is:

5.02

fontSize

fontSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

fontSize Type

number

fontSize Default Value

The default value is:

24

labelHeight

labelHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

labelHeight Type

number

labelHeight Default Value

The default value is:

16

edgeLengthFactor

edgeLengthFactor

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

edgeLengthFactor Type

string

edgeLengthFactor Default Value

The default value is:

"20"

compositTitleSize

compositTitleSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

compositTitleSize Type

number

compositTitleSize Default Value

The default value is:

35

radius

radius

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

radius Type

number

radius Default Value

The default value is:

5

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"

Definitions group ClassDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/ClassDiagramConfig" }

Property	Type	Required	Nullable	Defined by
titleTopMargin	integer	Required	cannot be null	Mermaid Config
arrowMarkerAbsolute	boolean	Optional	cannot be null	Mermaid Config
dividerMargin	number	Optional	cannot be null	Mermaid Config
padding	number	Optional	cannot be null	Mermaid Config
textHeight	number	Optional	cannot be null	Mermaid Config
defaultRenderer	string	Required	cannot be null	Mermaid Config
nodeSpacing	integer	Optional	cannot be null	Mermaid Config
rankSpacing	integer	Optional	cannot be null	Mermaid Config
diagramPadding	integer	Optional	cannot be null	Mermaid Config
htmlLabels	boolean	Optional	cannot be null	Mermaid Config
hideEmptyMembersBox	boolean	Optional	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

arrowMarkerAbsolute

Controls whether or arrow markers in html code are absolute paths or anchors. This matters if you are using base tag settings.

arrowMarkerAbsolute

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

dividerMargin

dividerMargin

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

dividerMargin Type

number

dividerMargin Default Value

The default value is:

10

padding

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Default Value

The default value is:

5

textHeight

textHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

textHeight Type

number

textHeight Default Value

The default value is:

10

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"

nodeSpacing

nodeSpacing

• is optional

• 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

rankSpacing

rankSpacing

• is optional

• 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

diagramPadding

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

diagramPadding

• is optional

• 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

htmlLabels

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

htmlLabels Type

boolean

hideEmptyMembersBox

hideEmptyMembersBox

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

hideEmptyMembersBox Type

boolean

Definitions group JourneyDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/JourneyDiagramConfig" }

Property	Type	Required	Nullable	Defined by
diagramMarginX	integer	Required	cannot be null	Mermaid Config
diagramMarginY	integer	Required	cannot be null	Mermaid Config
leftMargin	integer	Required	cannot be null	Mermaid Config
width	integer	Required	cannot be null	Mermaid Config
height	integer	Required	cannot be null	Mermaid Config
boxMargin	integer	Required	cannot be null	Mermaid Config
boxTextMargin	integer	Required	cannot be null	Mermaid Config
noteMargin	integer	Required	cannot be null	Mermaid Config
messageMargin	integer	Required	cannot be null	Mermaid Config
messageAlign	string	Required	cannot be null	Mermaid Config
bottomMarginAdj	integer	Required	cannot be null	Mermaid Config
rightAngles	boolean	Required	cannot be null	Mermaid Config
taskFontSize	Multiple	Optional	cannot be null	Mermaid Config
taskFontFamily	string	Optional	cannot be null	Mermaid Config
taskMargin	number	Optional	cannot be null	Mermaid Config
activationWidth	number	Optional	cannot be null	Mermaid Config
textPlacement	string	Optional	cannot be null	Mermaid Config
actorColours	array	Optional	cannot be null	Mermaid Config
sectionFills	array	Optional	cannot be null	Mermaid Config
sectionColours	array	Optional	cannot be null	Mermaid Config

diagramMarginX

Margin to the right and left of the c4 diagram, must be a positive value.

diagramMarginX

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

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

diagramMarginX Default Value

The default value is:

50

diagramMarginY

Margin to the over and under the c4 diagram, must be a positive value.

diagramMarginY

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

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

diagramMarginY Default Value

The default value is:

10

leftMargin

Margin between actors

leftMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

leftMargin Type

integer

leftMargin Constraints

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

leftMargin Default Value

The default value is:

150

width

Width of actor boxes

width

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

width Type

integer

width Constraints

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

width Default Value

The default value is:

150

height

Height of actor boxes

height

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

height Type

integer

height Constraints

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

height Default Value

The default value is:

50

boxMargin

Margin around loop boxes

boxMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

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

boxMargin Default Value

The default value is:

10

boxTextMargin

Margin around the text in loop/alt/opt boxes

boxTextMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxTextMargin Type

integer

boxTextMargin Constraints

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

boxTextMargin Default Value

The default value is:

5

noteMargin

Margin around notes

noteMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

noteMargin Type

integer

noteMargin Constraints

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

noteMargin Default Value

The default value is:

10

messageMargin

Space between messages.

messageMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

messageMargin Type

integer

messageMargin Constraints

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

messageMargin Default Value

The default value is:

35

messageAlign

Multiline message alignment

messageAlign

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

messageAlign Type

string

messageAlign Constraints

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

Value	Explanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

"center"

bottomMarginAdj

Prolongs the edge of the diagram downwards.

Depending on css styling this might need adjustment.

bottomMarginAdj

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

bottomMarginAdj Type

integer

bottomMarginAdj Constraints

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

bottomMarginAdj Default Value

The default value is:

1

rightAngles

Curved Arrows become Right Angles

This will display arrows that start and begin at the same node as right angles, rather than as curves.

rightAngles

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

rightAngles Type

boolean

taskFontSize

taskFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

taskFontSize Type

any of the following: string or number (Details)

taskFontSize Default Value

The default value is:

14

taskFontFamily

taskFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

taskFontFamily Type

string

taskFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

taskMargin

taskMargin

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

taskMargin Type

number

taskMargin Default Value

The default value is:

50

activationWidth

Width of activation box

activationWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

activationWidth Type

number

activationWidth Default Value

The default value is:

10

textPlacement

text placement as: tspan | fo | old only text as before

textPlacement

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

textPlacement Type

string

textPlacement Default Value

The default value is:

"fo"

actorColours

actorColours

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

actorColours Type

string[]

actorColours Default Value

The default value is:

["#8FBC8F", "#7CFC00", "#00FFFF", "#20B2AA", "#B0E0E6", "#FFFFE0"]

sectionFills

sectionFills

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

sectionFills Type

string[]

sectionFills Default Value

The default value is:

["#191970", "#8B008B", "#4B0082", "#2F4F4F", "#800000", "#8B4513", "#00008B"]

sectionColours

sectionColours

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

sectionColours Type

string[]

sectionColours Default Value

The default value is:

["#fff"]

Definitions group TimelineDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/TimelineDiagramConfig" }

Property	Type	Required	Nullable	Defined by
diagramMarginX	integer	Required	cannot be null	Mermaid Config
diagramMarginY	integer	Required	cannot be null	Mermaid Config
leftMargin	integer	Required	cannot be null	Mermaid Config
width	integer	Required	cannot be null	Mermaid Config
height	integer	Required	cannot be null	Mermaid Config
padding	number	Optional	cannot be null	Mermaid Config
boxMargin	integer	Required	cannot be null	Mermaid Config
boxTextMargin	integer	Required	cannot be null	Mermaid Config
noteMargin	integer	Required	cannot be null	Mermaid Config
messageMargin	integer	Required	cannot be null	Mermaid Config
messageAlign	string	Required	cannot be null	Mermaid Config
bottomMarginAdj	integer	Required	cannot be null	Mermaid Config
rightAngles	boolean	Optional	cannot be null	Mermaid Config
taskFontSize	Multiple	Optional	cannot be null	Mermaid Config
taskFontFamily	string	Optional	cannot be null	Mermaid Config
taskMargin	number	Optional	cannot be null	Mermaid Config
activationWidth	number	Optional	cannot be null	Mermaid Config
textPlacement	string	Optional	cannot be null	Mermaid Config
actorColours	array	Optional	cannot be null	Mermaid Config
sectionFills	array	Optional	cannot be null	Mermaid Config
sectionColours	array	Optional	cannot be null	Mermaid Config
disableMulticolor	boolean	Optional	cannot be null	Mermaid Config

diagramMarginX

Margin to the right and left of the c4 diagram, must be a positive value.

diagramMarginX

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

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

diagramMarginX Default Value

The default value is:

50

diagramMarginY

Margin to the over and under the c4 diagram, must be a positive value.

diagramMarginY

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

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

diagramMarginY Default Value

The default value is:

10

leftMargin

Margin between actors

leftMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

leftMargin Type

integer

leftMargin Constraints

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

leftMargin Default Value

The default value is:

150

width

Width of actor boxes

width

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

width Type

integer

width Constraints

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

width Default Value

The default value is:

150

height

Height of actor boxes

height

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

height Type

integer

height Constraints

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

height Default Value

The default value is:

50

padding

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

boxMargin

Margin around loop boxes

boxMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

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

boxMargin Default Value

The default value is:

10

boxTextMargin

Margin around the text in loop/alt/opt boxes

boxTextMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxTextMargin Type

integer

boxTextMargin Constraints

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

boxTextMargin Default Value

The default value is:

5

noteMargin

Margin around notes

noteMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

noteMargin Type

integer

noteMargin Constraints

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

noteMargin Default Value

The default value is:

10

messageMargin

Space between messages.

messageMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

messageMargin Type

integer

messageMargin Constraints

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

messageMargin Default Value

The default value is:

35

messageAlign

Multiline message alignment

messageAlign

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

messageAlign Type

string

messageAlign Constraints

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

Value	Explanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

"center"

bottomMarginAdj

Prolongs the edge of the diagram downwards.

Depending on css styling this might need adjustment.

bottomMarginAdj

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

bottomMarginAdj Type

integer

bottomMarginAdj Constraints

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

bottomMarginAdj Default Value

The default value is:

1

rightAngles

Curved Arrows become Right Angles

This will display arrows that start and begin at the same node as right angles, rather than as curves.

rightAngles

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

rightAngles Type

boolean

taskFontSize

taskFontSize

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

taskFontSize Type

any of the following: string or number (Details)

taskFontSize Default Value

The default value is:

14

taskFontFamily

taskFontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

taskFontFamily Type

string

taskFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

taskMargin

taskMargin

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

taskMargin Type

number

taskMargin Default Value

The default value is:

50

activationWidth

Width of activation box

activationWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

activationWidth Type

number

activationWidth Default Value

The default value is:

10

textPlacement

text placement as: tspan | fo | old only text as before

textPlacement

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

textPlacement Type

string

textPlacement Default Value

The default value is:

"fo"

actorColours

actorColours

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

actorColours Type

string[]

actorColours Default Value

The default value is:

["#8FBC8F", "#7CFC00", "#00FFFF", "#20B2AA", "#B0E0E6", "#FFFFE0"]

sectionFills

sectionFills

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

sectionFills Type

string[]

sectionFills Default Value

The default value is:

["#191970", "#8B008B", "#4B0082", "#2F4F4F", "#800000", "#8B4513", "#00008B"]

sectionColours

sectionColours

• is optional

• Type: string[]

• cannot be null

• defined in: Mermaid Config

sectionColours Type

string[]

sectionColours Default Value

The default value is:

["#fff"]

disableMulticolor

disableMulticolor

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

disableMulticolor Type

boolean

Definitions group GanttDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/GanttDiagramConfig" }

Property	Type	Required	Nullable	Defined by
titleTopMargin	integer	Required	cannot be null	Mermaid Config
barHeight	integer	Required	cannot be null	Mermaid Config
barGap	integer	Optional	cannot be null	Mermaid Config
topPadding	integer	Required	cannot be null	Mermaid Config
rightPadding	integer	Required	cannot be null	Mermaid Config
leftPadding	integer	Required	cannot be null	Mermaid Config
gridLineStartPadding	integer	Required	cannot be null	Mermaid Config
fontSize	integer	Required	cannot be null	Mermaid Config
sectionFontSize	integer	Required	cannot be null	Mermaid Config
numberSectionStyles	integer	Required	cannot be null	Mermaid Config
axisFormat	string	Required	cannot be null	Mermaid Config
tickInterval	string	Optional	cannot be null	Mermaid Config
topAxis	boolean	Required	cannot be null	Mermaid Config
displayMode	string	Optional	cannot be null	Mermaid Config
weekday	string	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

barHeight

The height of the bars in the graph

barHeight

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

barHeight Type

integer

barHeight Constraints

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

barHeight Default Value

The default value is:

20

barGap

The margin between the different activities in the gantt diagram

barGap

• is optional

• Type: integer

• cannot be null

• defined in: Mermaid Config

barGap Type

integer

barGap Constraints

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

barGap Default Value

The default value is:

4

topPadding

Margin between title and gantt diagram and between axis and gantt diagram.

topPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

topPadding Type

integer

topPadding Constraints

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

topPadding Default Value

The default value is:

50

rightPadding

The space allocated for the section name to the right of the activities

rightPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

rightPadding Type

integer

rightPadding Constraints

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

rightPadding Default Value

The default value is:

75

leftPadding

The space allocated for the section name to the left of the activities

leftPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

leftPadding Type

integer

leftPadding Constraints

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

leftPadding Default Value

The default value is:

75

gridLineStartPadding

Vertical starting position of the grid lines

gridLineStartPadding

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

gridLineStartPadding Type

integer

gridLineStartPadding Constraints

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

gridLineStartPadding Default Value

The default value is:

35

fontSize

Font size

fontSize

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

fontSize Type

integer

fontSize Constraints

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

fontSize Default Value

The default value is:

11

sectionFontSize

Font size for sections

sectionFontSize

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

• tsType: string | number

sectionFontSize Type

integer

sectionFontSize Constraints

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

sectionFontSize Default Value

The default value is:

11

numberSectionStyles

The number of alternating section styles

numberSectionStyles

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

numberSectionStyles Type

integer

numberSectionStyles Constraints

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

numberSectionStyles Default Value

The default value is:

4

axisFormat

Date/time format of the axis

This might need adjustment to match your locale and preferences.

axisFormat

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

axisFormat Type

string

axisFormat Default Value

The default value is:

"%Y-%m-%d"

tickInterval

axis ticks

Pattern is:

/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/;

tickInterval

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

tickInterval Type

string

tickInterval Constraints

pattern: the string must match the following regular expression:

/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/

try pattern

topAxis

When this flag is set, date labels will be added to the top of the chart

topAxis

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

topAxis Type

boolean

displayMode

Controls the display mode.

displayMode

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

displayMode Type

string

displayMode Constraints

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

Value	Explanation
""
"compact"	Enables displaying multiple tasks on the same row.

weekday

On which day a week-based interval should start

weekday

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

weekday Type

string

weekday Constraints

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

Value	Explanation
"monday"
"tuesday"
"wednesday"
"thursday"
"friday"
"saturday"
"sunday"

weekday Default Value

The default value is:

"sunday"

Definitions group SequenceDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/SequenceDiagramConfig" }

Property	Type	Required	Nullable	Defined by
arrowMarkerAbsolute	boolean	Optional	cannot be null	Mermaid Config
hideUnusedParticipants	boolean	Optional	cannot be null	Mermaid Config
activationWidth	integer	Required	cannot be null	Mermaid Config
diagramMarginX	integer	Required	cannot be null	Mermaid Config
diagramMarginY	integer	Required	cannot be null	Mermaid Config
actorMargin	integer	Required	cannot be null	Mermaid Config
width	integer	Required	cannot be null	Mermaid Config
height	integer	Required	cannot be null	Mermaid Config
boxMargin	integer	Required	cannot be null	Mermaid Config
boxTextMargin	integer	Required	cannot be null	Mermaid Config
noteMargin	integer	Required	cannot be null	Mermaid Config
messageMargin	integer	Required	cannot be null	Mermaid Config
messageAlign	string	Required	cannot be null	Mermaid Config
mirrorActors	boolean	Required	cannot be null	Mermaid Config
forceMenus	boolean	Required	cannot be null	Mermaid Config
bottomMarginAdj	integer	Required	cannot be null	Mermaid Config
rightAngles	boolean	Required	cannot be null	Mermaid Config
showSequenceNumbers	boolean	Required	cannot be null	Mermaid Config
actorFontSize	Multiple	Required	cannot be null	Mermaid Config
actorFontFamily	string	Required	cannot be null	Mermaid Config
actorFontWeight	Multiple	Required	cannot be null	Mermaid Config
noteFontSize	Multiple	Required	cannot be null	Mermaid Config
noteFontFamily	string	Required	cannot be null	Mermaid Config
noteFontWeight	Multiple	Required	cannot be null	Mermaid Config
noteAlign	string	Required	cannot be null	Mermaid Config
messageFontSize	Multiple	Required	cannot be null	Mermaid Config
messageFontFamily	string	Required	cannot be null	Mermaid Config
messageFontWeight	Multiple	Required	cannot be null	Mermaid Config
wrap	boolean	Optional	cannot be null	Mermaid Config
wrapPadding	number	Optional	cannot be null	Mermaid Config
labelBoxWidth	number	Optional	cannot be null	Mermaid Config
labelBoxHeight	number	Optional	cannot be null	Mermaid Config
messageFont	Not specified	Optional	cannot be null	Mermaid Config
noteFont	Not specified	Optional	cannot be null	Mermaid Config
actorFont	Not specified	Optional	cannot be null	Mermaid Config

arrowMarkerAbsolute

arrowMarkerAbsolute

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

hideUnusedParticipants

hideUnusedParticipants

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

hideUnusedParticipants Type

boolean

activationWidth

Width of the activation rect

activationWidth

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

activationWidth Type

integer

activationWidth Constraints

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

activationWidth Default Value

The default value is:

10

diagramMarginX

Margin to the right and left of the sequence diagram

diagramMarginX

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

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

diagramMarginX Default Value

The default value is:

50

diagramMarginY

Margin to the over and under the sequence diagram

diagramMarginY

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

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

diagramMarginY Default Value

The default value is:

10

actorMargin

Margin between actors

actorMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

actorMargin Type

integer

actorMargin Constraints

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

actorMargin Default Value

The default value is:

50

width

Width of actor boxes

width

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

width Type

integer

width Constraints

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

width Default Value

The default value is:

150

height

Height of actor boxes

height

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

height Type

integer

height Constraints

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

height Default Value

The default value is:

50

boxMargin

Margin around loop boxes

boxMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

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

boxMargin Default Value

The default value is:

10

boxTextMargin

Margin around the text in loop/alt/opt boxes

boxTextMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

boxTextMargin Type

integer

boxTextMargin Constraints

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

boxTextMargin Default Value

The default value is:

5

noteMargin

Margin around notes

noteMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

noteMargin Type

integer

noteMargin Constraints

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

noteMargin Default Value

The default value is:

10

messageMargin

Space between messages.

messageMargin

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

messageMargin Type

integer

messageMargin Constraints

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

messageMargin Default Value

The default value is:

35

messageAlign

Multiline message alignment

messageAlign

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

messageAlign Type

string

messageAlign Constraints

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

Value	Explanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

"center"

mirrorActors

Mirror actors under diagram

mirrorActors

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

mirrorActors Type

boolean

mirrorActors Default Value

The default value is:

true

forceMenus

forces actor popup menus to always be visible (to support E2E testing).

forceMenus

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

forceMenus Type

boolean

bottomMarginAdj

Prolongs the edge of the diagram downwards.

Depending on css styling this might need adjustment.

bottomMarginAdj

• is required

• Type: integer

• cannot be null

• defined in: Mermaid Config

bottomMarginAdj Type

integer

bottomMarginAdj Constraints

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

bottomMarginAdj Default Value

The default value is:

1

rightAngles

Curved Arrows become Right Angles

This will display arrows that start and begin at the same node as right angles, rather than as curves.

rightAngles

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

rightAngles Type

boolean

showSequenceNumbers

This will show the node numbers

showSequenceNumbers

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showSequenceNumbers Type

boolean

actorFontSize

This sets the font size of the actor's description

actorFontSize

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

actorFontSize Type

any of the following: string or number (Details)

actorFontSize Default Value

The default value is:

14

actorFontFamily

This sets the font family of the actor's description

actorFontFamily

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

actorFontFamily Type

string

actorFontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

actorFontWeight

This sets the font weight of the actor's description

actorFontWeight

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

actorFontWeight Type

any of the following: string or number (Details)

actorFontWeight Default Value

The default value is:

400

noteFontSize

This sets the font size of actor-attached notes

noteFontSize

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

noteFontSize Type

any of the following: string or number (Details)

noteFontSize Default Value

The default value is:

14

noteFontFamily

This sets the font family of actor-attached notes

noteFontFamily

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

noteFontFamily Type

string

noteFontFamily Default Value

The default value is:

"\"trebuchet ms\", verdana, arial, sans-serif"

noteFontWeight

This sets the font weight of actor-attached notes

noteFontWeight

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

noteFontWeight Type

any of the following: string or number (Details)

noteFontWeight Default Value

The default value is:

400

noteAlign

This sets the text alignment of actor-attached notes

noteAlign

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

noteAlign Type

string

noteAlign Constraints

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

Value	Explanation
"left"
"center"
"right"

noteAlign Default Value

The default value is:

"center"

messageFontSize

This sets the font size of actor messages

messageFontSize

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

messageFontSize Type

any of the following: string or number (Details)

messageFontSize Default Value

The default value is:

16

messageFontFamily

This sets the font family of actor messages

messageFontFamily

• is required

• Type: string

• cannot be null

• defined in: Mermaid Config

messageFontFamily Type

string

messageFontFamily Default Value

The default value is:

"\"trebuchet ms\", verdana, arial, sans-serif"

messageFontWeight

This sets the font weight of actor messages

messageFontWeight

• is required

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

messageFontWeight Type

any of the following: string or number (Details)

messageFontWeight Default Value

The default value is:

400

wrap

This sets the auto-wrap state for the diagram

wrap

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

wrap Type

boolean

wrapPadding

This sets the auto-wrap padding for the diagram (sides only)

wrapPadding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

wrapPadding Type

number

wrapPadding Default Value

The default value is:

10

labelBoxWidth

This sets the width of the loop-box (loop, alt, opt, par)

labelBoxWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

labelBoxWidth Type

number

labelBoxWidth Default Value

The default value is:

50

labelBoxHeight

This sets the height of the loop-box (loop, alt, opt, par)

labelBoxHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

labelBoxHeight Type

number

labelBoxHeight Default Value

The default value is:

20

messageFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

messageFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

messageFont Type

unknown (Font Calculator)

noteFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

noteFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

noteFont Type

unknown (Font Calculator)

actorFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

actorFont

• is optional

• Type: unknown (Font Calculator)

• cannot be null

• defined in: Mermaid Config

• tsType: () => Partial<FontConfig>

actorFont Type

unknown (Font Calculator)

Definitions group FlowchartDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/FlowchartDiagramConfig" }

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"
"bumpX"
"bumpY"
"cardinal"
"catmullRom"
"linear"
"monotoneX"
"monotoneY"
"natural"
"step"
"stepAfter"
"stepBefore"

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

Definitions group SankeyLinkColor

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/SankeyLinkColor" }

Property	Type	Required	Nullable	Defined by

Definitions group SankeyNodeAlignment

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/SankeyNodeAlignment" }

Property	Type	Required	Nullable	Defined by

Definitions group SankeyDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/SankeyDiagramConfig" }

Property	Type	Required	Nullable	Defined by
width	number	Optional	cannot be null	Mermaid Config
height	number	Optional	cannot be null	Mermaid Config
linkColor	Merged	Optional	cannot be null	Mermaid Config
nodeAlignment	string	Optional	cannot be null	Mermaid Config
useMaxWidth	boolean	Optional	cannot be null	Mermaid Config
showValues	boolean	Optional	cannot be null	Mermaid Config
prefix	string	Optional	cannot be null	Mermaid Config
suffix	string	Optional	cannot be null	Mermaid Config

width

width

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

width Type

number

width Default Value

The default value is:

600

height

height

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

height Type

number

height Default Value

The default value is:

400

linkColor

The color of the links in the sankey diagram.

linkColor

• is optional

• Type: merged type (Details)

• cannot be null

• defined in: Mermaid Config

linkColor Type

merged type (Details)

any of

• Untitled string in Mermaid Config

• Untitled string in Mermaid Config

linkColor Default Value

The default value is:

"gradient"

nodeAlignment

Controls the alignment of the Sankey diagrams.

See https://github.com/d3/d3-sankey#alignments.

nodeAlignment

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

nodeAlignment Type

string

nodeAlignment Constraints

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

Value	Explanation
"left"	Align all inputs to the left.
"right"	Align all outputs to the right.
"center"	Like `left`, except that nodes without any incoming links are moved as right as possible.
"justify"	Like `left`, except that nodes without any outgoing links are moved to the far right.

nodeAlignment Default Value

The default value is:

"justify"

useMaxWidth

useMaxWidth

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

useMaxWidth Type

boolean

showValues

Toggle to display or hide values along with title.

showValues

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showValues Type

boolean

showValues Default Value

The default value is:

true

prefix

The prefix to use for values

prefix

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

prefix Type

string

suffix

The suffix to use for values

suffix

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

suffix Type

string

Definitions group PacketDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/PacketDiagramConfig" }

Property	Type	Required	Nullable	Defined by
rowHeight	number	Optional	cannot be null	Mermaid Config
bitWidth	number	Optional	cannot be null	Mermaid Config
bitsPerRow	number	Optional	cannot be null	Mermaid Config
showBits	boolean	Optional	cannot be null	Mermaid Config
paddingX	number	Optional	cannot be null	Mermaid Config
paddingY	number	Optional	cannot be null	Mermaid Config

rowHeight

The height of each row in the packet diagram.

rowHeight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

rowHeight Type

number

rowHeight Constraints

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

rowHeight Default Value

The default value is:

32

bitWidth

The width of each bit in the packet diagram.

bitWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

bitWidth Type

number

bitWidth Constraints

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

bitWidth Default Value

The default value is:

32

bitsPerRow

The number of bits to display per row.

bitsPerRow

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

bitsPerRow Type

number

bitsPerRow Constraints

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

bitsPerRow Default Value

The default value is:

32

showBits

Toggle to display or hide bit numbers.

showBits

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showBits Type

boolean

showBits Default Value

The default value is:

true

paddingX

The horizontal padding between the blocks in a row.

paddingX

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

paddingX Type

number

paddingX Constraints

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

paddingX Default Value

The default value is:

5

paddingY

The vertical padding between the rows.

paddingY

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

paddingY Type

number

paddingY Constraints

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

paddingY Default Value

The default value is:

5

Definitions group BlockDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/BlockDiagramConfig" }

Property	Type	Required	Nullable	Defined by
padding	number	Optional	cannot be null	Mermaid Config

padding

padding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

padding Type

number

padding Constraints

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

padding Default Value

The default value is:

8

Definitions group RadarDiagramConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/RadarDiagramConfig" }

Property	Type	Required	Nullable	Defined by
width	number	Optional	cannot be null	Mermaid Config
height	number	Optional	cannot be null	Mermaid Config
marginTop	number	Optional	cannot be null	Mermaid Config
marginRight	number	Optional	cannot be null	Mermaid Config
marginBottom	number	Optional	cannot be null	Mermaid Config
marginLeft	number	Optional	cannot be null	Mermaid Config
axisScaleFactor	number	Optional	cannot be null	Mermaid Config
axisLabelFactor	number	Optional	cannot be null	Mermaid Config
curveTension	number	Optional	cannot be null	Mermaid Config

width

The size of the radar diagram.

width

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

width Type

number

width Constraints

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

width Default Value

The default value is:

600

height

The size of the radar diagram.

height

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

height Type

number

height Constraints

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

height Default Value

The default value is:

600

marginTop

The margin from the top of the radar diagram.

marginTop

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

marginTop Type

number

marginTop Constraints

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

marginTop Default Value

The default value is:

50

marginRight

The margin from the right of the radar diagram.

marginRight

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

marginRight Type

number

marginRight Constraints

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

marginRight Default Value

The default value is:

50

marginBottom

The margin from the bottom of the radar diagram.

marginBottom

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

marginBottom Type

number

marginBottom Constraints

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

marginBottom Default Value

The default value is:

50

marginLeft

The margin from the left of the radar diagram.

marginLeft

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

marginLeft Type

number

marginLeft Constraints

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

marginLeft Default Value

The default value is:

50

axisScaleFactor

The scale factor of the axis.

axisScaleFactor

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

axisScaleFactor Type

number

axisScaleFactor Constraints

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

axisScaleFactor Default Value

The default value is:

1

axisLabelFactor

The scale factor of the axis label.

axisLabelFactor

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

axisLabelFactor Type

number

axisLabelFactor Constraints

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

axisLabelFactor Default Value

The default value is:

1.05

curveTension

The tension factor for the Catmull-Rom spline conversion to cubic Bézier curves.

curveTension

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

curveTension Type

number

curveTension Constraints

maximum: the value of this number must smaller than or equal to: 1

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

curveTension Default Value

The default value is:

0.17

Definitions group FontCalculator

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/FontCalculator" }

Property	Type	Required	Nullable	Defined by

Definitions group FontConfig

Reference this group by using

{ "$ref": "https://mermaid.js.org/schemas/config.schema.json#/$defs/FontConfig" }

Property	Type	Required	Nullable	Defined by
fontSize	Multiple	Optional	cannot be null	Mermaid Config
fontFamily	string	Optional	cannot be null	Mermaid Config
fontWeight	Multiple	Optional	cannot be null	Mermaid Config

fontSize

The font size to use

fontSize

• is optional

• Type: any of the following: string or number (CSS Font Size)

• cannot be null

• defined in: Mermaid Config

fontSize Type

any of the following: string or number (CSS Font Size)

fontSize Default Value

The default value is:

14

fontFamily

The CSS font-family to use.

fontFamily

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

fontFamily Type

string

fontFamily Default Value

The default value is:

"\"Open Sans\", sans-serif"

fontWeight

The font weight to use.

fontWeight

• is optional

• Type: any of the following: string or number (Details)

• cannot be null

• defined in: Mermaid Config

fontWeight Type

any of the following: string or number (Details)

fontWeight Default Value

The default value is:

"normal"