Skip to content

Mermaid Config Schema

txt
https://mermaid-js.github.io/schemas/config.schema.json
AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedNoUnknown statusNoForbiddenForbiddennoneconfig.schema.json

Mermaid Config Type

object (Mermaid Config)

Mermaid Config Properties

PropertyTypeRequiredNullableDefined by
themestringOptionalcannot be nullMermaid Config
themeVariablesNot specifiedOptionalcannot be nullMermaid Config
themeCSSstringOptionalcannot be nullMermaid Config
maxTextSizenumberOptionalcannot be nullMermaid Config
maxEdgesintegerOptionalcannot be nullMermaid Config
darkModebooleanOptionalcannot be nullMermaid Config
htmlLabelsbooleanOptionalcannot be nullMermaid Config
fontFamilystringRequiredcannot be nullMermaid Config
altFontFamilystringOptionalcannot be nullMermaid Config
logLevelMultipleRequiredcannot be nullMermaid Config
securityLevelstringRequiredcannot be nullMermaid Config
startOnLoadbooleanRequiredcannot be nullMermaid Config
arrowMarkerAbsolutebooleanRequiredcannot be nullMermaid Config
securearrayOptionalcannot be nullMermaid Config
deterministicIdsbooleanOptionalcannot be nullMermaid Config
deterministicIDSeedstringOptionalcannot be nullMermaid Config
flowchartMergedRequiredcannot be nullMermaid Config
sequenceMergedRequiredcannot be nullMermaid Config
ganttMergedRequiredcannot be nullMermaid Config
journeyMergedRequiredcannot be nullMermaid Config
timelineMergedOptionalcannot be nullMermaid Config
classMergedRequiredcannot be nullMermaid Config
stateMergedRequiredcannot be nullMermaid Config
erMergedRequiredcannot be nullMermaid Config
pieMergedRequiredcannot be nullMermaid Config
quadrantChartMergedRequiredcannot be nullMermaid Config
xyChartMergedRequiredcannot be nullMermaid Config
requirementMergedRequiredcannot be nullMermaid Config
mindmapMergedRequiredcannot be nullMermaid Config
gitGraphMergedRequiredcannot be nullMermaid Config
c4MergedRequiredcannot be nullMermaid Config
sankeyMergedRequiredcannot be nullMermaid Config
blockMergedRequiredcannot be nullMermaid Config
dompurifyConfigobjectOptionalcannot be nullMermaid Config
wrapbooleanOptionalcannot be nullMermaid Config
fontSizenumberOptionalcannot be nullMermaid 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

  • tsType: string | "default" | "forest" | "dark" | "neutral" | "null"

theme Type

string

theme Constraints

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

ValueExplanation
"default"
"forest"
"dark"
"neutral"
"null"Can be set to disable any pre-defined mermaid theme

theme Default Value

The default value is:

json
"default"

themeVariables

themeVariables

  • is optional

  • Type: unknown

  • cannot be null

  • defined in: Mermaid Config

  • tsType: any

themeVariables Type

unknown

themeCSS

themeCSS

themeCSS Type

string

maxTextSize

The maximum allowed size of the users text diagram

maxTextSize

maxTextSize Type

number

maxTextSize Default Value

The default value is:

json
50000

maxEdges

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

maxEdges

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:

json
500

darkMode

darkMode

darkMode Type

boolean

htmlLabels

htmlLabels

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

fontFamily Type

string

fontFamily Default Value

The default value is:

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

altFontFamily

altFontFamily

altFontFamily Type

string

logLevel

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

logLevel

  • is required

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

  • cannot be null

  • defined in: Mermaid Config

  • tsType: number | string | 0 | 2 | 1 | "trace" | "debug" | "info" | "warn" | "error" | "fatal" | 3 | 4 | 5 | undefined

logLevel Type

any of the folllowing: string or number (Details)

logLevel Constraints

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

ValueExplanation
"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:

json
5

securityLevel

Level of trust for parsed diagram

securityLevel

  • is required

  • Type: string

  • cannot be null

  • defined in: Mermaid Config

  • tsType: string | "strict" | "loose" | "antiscript" | "sandbox" | undefined

securityLevel Type

string

securityLevel Constraints

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

ValueExplanation
"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:

json
"strict"

startOnLoad

Dictates whether mermaid starts on Page load

startOnLoad

startOnLoad Type

boolean

startOnLoad Default Value

The default value is:

json
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

arrowMarkerAbsolute Type

boolean

secure

This option controls which currentConfig keys are considered secure and can only be changed via call to mermaidAPI.initialize. Calls to mermaidAPI.reinitialize cannot make changes to the secure keys in the current currentConfig.

This prevents malicious graph directives from overriding a site's default security.

secure

secure Type

string[]

secure Default Value

The default value is:

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

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

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

deterministicIDSeed Type

string

flowchart

The object containing configurations specific for flowcharts

flowchart

flowchart Type

object (Flowchart Diagram Config)

all of

sequence

The object containing configurations specific for sequence diagrams

sequence

sequence Type

object (Sequence Diagram Config)

all of

gantt

The object containing configurations specific for gantt diagrams

gantt

gantt Type

object (Gantt Diagram Config)

all of

journey

The object containing configurations specific for journey diagrams

journey

journey Type

object (Journey Diagram Config)

all of

timeline

timeline

timeline Type

object (Timeline Diagram Config)

all of

class

class

class Type

object (Class Diagram Config)

all of

state

The object containing configurations specific for entity relationship diagrams

state

state Type

object (State Diagram Config)

all of

er

The object containing configurations specific for entity relationship diagrams

er

er Type

object (Er Diagram Config)

all of

pie

pie

pie Type

object (Pie Diagram Config)

all of

quadrantChart

quadrantChart

quadrantChart Type

object (Quadrant Chart Config)

all of

xyChart

This object contains configuration specific to XYCharts

xyChart

xyChart Type

object (XYChart Config)

all of

requirement

The object containing configurations specific for req diagrams

requirement

requirement Type

object (Requirement Diagram Config)

all of

mindmap

The object containing configurations specific for mindmap diagrams

mindmap

mindmap Type

object (Mindmap Diagram Config)

all of

gitGraph

gitGraph

gitGraph Type

object (Git Graph Diagram Config)

all of

c4

The object containing configurations specific for c4 diagrams

c4

c4 Type

object (C4 Diagram Config)

all of

sankey

The object containing configurations specific for sankey diagrams.

sankey

sankey Type

object (Sankey Diagram Config)

all of

block

The object containing configurations specific for block diagrams.

block

block Type

object (Block Diagram Config)

all of

dompurifyConfig

Configuration options to pass to the dompurify library.

dompurifyConfig

dompurifyConfig Type

object (DOM Purify Configuration)

wrap

wrap

wrap Type

boolean

fontSize

fontSize

fontSize Type

number

fontSize Default Value

The default value is:

json
16

Mermaid Config Definitions

Definitions group BaseDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/BaseDiagramConfig" }
PropertyTypeRequiredNullableDefined by
useWidthnumberOptionalcannot be nullMermaid Config
useMaxWidthbooleanOptionalcannot be nullMermaid Config

useWidth

useWidth

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

useMaxWidth Type

boolean

useMaxWidth Default Value

The default value is:

json
true

Definitions group C4DiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/C4DiagramConfig" }
PropertyTypeRequiredNullableDefined by
diagramMarginXintegerRequiredcannot be nullMermaid Config
diagramMarginYintegerRequiredcannot be nullMermaid Config
c4ShapeMarginintegerRequiredcannot be nullMermaid Config
c4ShapePaddingintegerRequiredcannot be nullMermaid Config
widthintegerRequiredcannot be nullMermaid Config
heightintegerRequiredcannot be nullMermaid Config
boxMarginintegerRequiredcannot be nullMermaid Config
c4ShapeInRowintegerRequiredcannot be nullMermaid Config
nextLinePaddingXnumberOptionalcannot be nullMermaid Config
c4BoundaryInRowintegerRequiredcannot be nullMermaid Config
personFontSizeMultipleOptionalcannot be nullMermaid Config
personFontFamilystringOptionalcannot be nullMermaid Config
personFontWeightMultipleOptionalcannot be nullMermaid Config
external_personFontSizeMultipleOptionalcannot be nullMermaid Config
external_personFontFamilystringOptionalcannot be nullMermaid Config
external_personFontWeightMultipleOptionalcannot be nullMermaid Config
systemFontSizeMultipleOptionalcannot be nullMermaid Config
systemFontFamilystringOptionalcannot be nullMermaid Config
systemFontWeightMultipleOptionalcannot be nullMermaid Config
external_systemFontSizeMultipleOptionalcannot be nullMermaid Config
external_systemFontFamilystringOptionalcannot be nullMermaid Config
external_systemFontWeightMultipleOptionalcannot be nullMermaid Config
system_dbFontSizeMultipleOptionalcannot be nullMermaid Config
system_dbFontFamilystringOptionalcannot be nullMermaid Config
system_dbFontWeightMultipleOptionalcannot be nullMermaid Config
external_system_dbFontSizeMultipleOptionalcannot be nullMermaid Config
external_system_dbFontFamilystringOptionalcannot be nullMermaid Config
external_system_dbFontWeightMultipleOptionalcannot be nullMermaid Config
system_queueFontSizeMultipleOptionalcannot be nullMermaid Config
system_queueFontFamilystringOptionalcannot be nullMermaid Config
system_queueFontWeightMultipleOptionalcannot be nullMermaid Config
external_system_queueFontSizeMultipleOptionalcannot be nullMermaid Config
external_system_queueFontFamilystringOptionalcannot be nullMermaid Config
external_system_queueFontWeightMultipleOptionalcannot be nullMermaid Config
boundaryFontSizeMultipleOptionalcannot be nullMermaid Config
boundaryFontFamilystringOptionalcannot be nullMermaid Config
boundaryFontWeightMultipleOptionalcannot be nullMermaid Config
messageFontSizeMultipleOptionalcannot be nullMermaid Config
messageFontFamilystringOptionalcannot be nullMermaid Config
messageFontWeightMultipleOptionalcannot be nullMermaid Config
containerFontSizeMultipleOptionalcannot be nullMermaid Config
containerFontFamilystringOptionalcannot be nullMermaid Config
containerFontWeightMultipleOptionalcannot be nullMermaid Config
external_containerFontSizeMultipleOptionalcannot be nullMermaid Config
external_containerFontFamilystringOptionalcannot be nullMermaid Config
external_containerFontWeightMultipleOptionalcannot be nullMermaid Config
container_dbFontSizeMultipleOptionalcannot be nullMermaid Config
container_dbFontFamilystringOptionalcannot be nullMermaid Config
container_dbFontWeightMultipleOptionalcannot be nullMermaid Config
external_container_dbFontSizeMultipleOptionalcannot be nullMermaid Config
external_container_dbFontFamilystringOptionalcannot be nullMermaid Config
external_container_dbFontWeightMultipleOptionalcannot be nullMermaid Config
container_queueFontSizeMultipleOptionalcannot be nullMermaid Config
container_queueFontFamilystringOptionalcannot be nullMermaid Config
container_queueFontWeightMultipleOptionalcannot be nullMermaid Config
external_container_queueFontSizeMultipleOptionalcannot be nullMermaid Config
external_container_queueFontFamilystringOptionalcannot be nullMermaid Config
external_container_queueFontWeightMultipleOptionalcannot be nullMermaid Config
componentFontSizeMultipleOptionalcannot be nullMermaid Config
componentFontFamilystringOptionalcannot be nullMermaid Config
componentFontWeightMultipleOptionalcannot be nullMermaid Config
external_componentFontSizeMultipleOptionalcannot be nullMermaid Config
external_componentFontFamilystringOptionalcannot be nullMermaid Config
external_componentFontWeightMultipleOptionalcannot be nullMermaid Config
component_dbFontSizeMultipleOptionalcannot be nullMermaid Config
component_dbFontFamilystringOptionalcannot be nullMermaid Config
component_dbFontWeightMultipleOptionalcannot be nullMermaid Config
external_component_dbFontSizeMultipleOptionalcannot be nullMermaid Config
external_component_dbFontFamilystringOptionalcannot be nullMermaid Config
external_component_dbFontWeightMultipleOptionalcannot be nullMermaid Config
component_queueFontSizeMultipleOptionalcannot be nullMermaid Config
component_queueFontFamilystringOptionalcannot be nullMermaid Config
component_queueFontWeightMultipleOptionalcannot be nullMermaid Config
external_component_queueFontSizeMultipleOptionalcannot be nullMermaid Config
external_component_queueFontFamilystringOptionalcannot be nullMermaid Config
external_component_queueFontWeightMultipleOptionalcannot be nullMermaid Config
wrapbooleanOptionalcannot be nullMermaid Config
wrapPaddingnumberOptionalcannot be nullMermaid Config
person_bg_colorstringOptionalcannot be nullMermaid Config
person_border_colorstringOptionalcannot be nullMermaid Config
external_person_bg_colorstringOptionalcannot be nullMermaid Config
external_person_border_colorstringOptionalcannot be nullMermaid Config
system_bg_colorstringOptionalcannot be nullMermaid Config
system_border_colorstringOptionalcannot be nullMermaid Config
system_db_bg_colorstringOptionalcannot be nullMermaid Config
system_db_border_colorstringOptionalcannot be nullMermaid Config
system_queue_bg_colorstringOptionalcannot be nullMermaid Config
system_queue_border_colorstringOptionalcannot be nullMermaid Config
external_system_bg_colorstringOptionalcannot be nullMermaid Config
external_system_border_colorstringOptionalcannot be nullMermaid Config
external_system_db_bg_colorstringOptionalcannot be nullMermaid Config
external_system_db_border_colorstringOptionalcannot be nullMermaid Config
external_system_queue_bg_colorstringOptionalcannot be nullMermaid Config
external_system_queue_border_colorstringOptionalcannot be nullMermaid Config
container_bg_colorstringOptionalcannot be nullMermaid Config
container_border_colorstringOptionalcannot be nullMermaid Config
container_db_bg_colorstringOptionalcannot be nullMermaid Config
container_db_border_colorstringOptionalcannot be nullMermaid Config
container_queue_bg_colorstringOptionalcannot be nullMermaid Config
container_queue_border_colorstringOptionalcannot be nullMermaid Config
external_container_bg_colorstringOptionalcannot be nullMermaid Config
external_container_border_colorstringOptionalcannot be nullMermaid Config
external_container_db_bg_colorstringOptionalcannot be nullMermaid Config
external_container_db_border_colorstringOptionalcannot be nullMermaid Config
external_container_queue_bg_colorstringOptionalcannot be nullMermaid Config
external_container_queue_border_colorstringOptionalcannot be nullMermaid Config
component_bg_colorstringOptionalcannot be nullMermaid Config
component_border_colorstringOptionalcannot be nullMermaid Config
component_db_bg_colorstringOptionalcannot be nullMermaid Config
component_db_border_colorstringOptionalcannot be nullMermaid Config
component_queue_bg_colorstringOptionalcannot be nullMermaid Config
component_queue_border_colorstringOptionalcannot be nullMermaid Config
external_component_bg_colorstringOptionalcannot be nullMermaid Config
external_component_border_colorstringOptionalcannot be nullMermaid Config
external_component_db_bg_colorstringOptionalcannot be nullMermaid Config
external_component_db_border_colorstringOptionalcannot be nullMermaid Config
external_component_queue_bg_colorstringOptionalcannot be nullMermaid Config
external_component_queue_border_colorstringOptionalcannot be nullMermaid Config
personFontNot specifiedOptionalcannot be nullMermaid Config
external_personFontNot specifiedOptionalcannot be nullMermaid Config
systemFontNot specifiedOptionalcannot be nullMermaid Config
external_systemFontNot specifiedOptionalcannot be nullMermaid Config
system_dbFontNot specifiedOptionalcannot be nullMermaid Config
external_system_dbFontNot specifiedOptionalcannot be nullMermaid Config
system_queueFontNot specifiedOptionalcannot be nullMermaid Config
external_system_queueFontNot specifiedOptionalcannot be nullMermaid Config
containerFontNot specifiedOptionalcannot be nullMermaid Config
external_containerFontNot specifiedOptionalcannot be nullMermaid Config
container_dbFontNot specifiedOptionalcannot be nullMermaid Config
external_container_dbFontNot specifiedOptionalcannot be nullMermaid Config
container_queueFontNot specifiedOptionalcannot be nullMermaid Config
external_container_queueFontNot specifiedOptionalcannot be nullMermaid Config
componentFontNot specifiedOptionalcannot be nullMermaid Config
external_componentFontNot specifiedOptionalcannot be nullMermaid Config
component_dbFontNot specifiedOptionalcannot be nullMermaid Config
external_component_dbFontNot specifiedOptionalcannot be nullMermaid Config
component_queueFontNot specifiedOptionalcannot be nullMermaid Config
external_component_queueFontNot specifiedOptionalcannot be nullMermaid Config
boundaryFontNot specifiedOptionalcannot be nullMermaid Config
messageFontNot specifiedOptionalcannot be nullMermaid Config

diagramMarginX

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

diagramMarginX

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:

json
50

diagramMarginY

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

diagramMarginY

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:

json
10

c4ShapeMargin

Margin between shapes

c4ShapeMargin

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:

json
50

c4ShapePadding

Padding between shapes

c4ShapePadding

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:

json
20

width

Width of person boxes

width

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:

json
216

height

Height of person boxes

height

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:

json
60

boxMargin

Margin around boxes

boxMargin

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:

json
10

c4ShapeInRow

How many shapes to place in each row.

c4ShapeInRow

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:

json
4

nextLinePaddingX

nextLinePaddingX

nextLinePaddingX Type

number

c4BoundaryInRow

How many boundaries to place in each row.

c4BoundaryInRow

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:

json
2

personFontSize

This sets the font size of Person shape for the diagram

personFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

personFontSize Type

any of the folllowing: string or number (Details)

personFontSize Default Value

The default value is:

json
14

personFontFamily

This sets the font weight of Person shape for the diagram

personFontFamily

personFontFamily Type

string

personFontFamily Default Value

The default value is:

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

personFontWeight

This sets the font weight of Person shape for the diagram

personFontWeight

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

personFontWeight Type

any of the folllowing: string or number (Details)

personFontWeight Default Value

The default value is:

json
"normal"

external_personFontSize

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

external_personFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

external_personFontSize Type

any of the folllowing: string or number (Details)

external_personFontSize Default Value

The default value is:

json
14

external_personFontFamily

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

external_personFontFamily

external_personFontFamily Type

string

external_personFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_personFontWeight Type

any of the folllowing: string or number (Details)

external_personFontWeight Default Value

The default value is:

json
"normal"

systemFontSize

This sets the font size of System shape for the diagram

systemFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

systemFontSize Type

any of the folllowing: string or number (Details)

systemFontSize Default Value

The default value is:

json
14

systemFontFamily

This sets the font family of System shape for the diagram

systemFontFamily

systemFontFamily Type

string

systemFontFamily Default Value

The default value is:

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

systemFontWeight

This sets the font weight of System shape for the diagram

systemFontWeight

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

systemFontWeight Type

any of the folllowing: string or number (Details)

systemFontWeight Default Value

The default value is:

json
"normal"

external_systemFontSize

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

external_systemFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

external_systemFontSize Type

any of the folllowing: string or number (Details)

external_systemFontSize Default Value

The default value is:

json
14

external_systemFontFamily

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

external_systemFontFamily

external_systemFontFamily Type

string

external_systemFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_systemFontWeight Type

any of the folllowing: string or number (Details)

external_systemFontWeight Default Value

The default value is:

json
"normal"

system_dbFontSize

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

system_dbFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

system_dbFontSize Type

any of the folllowing: string or number (Details)

system_dbFontSize Default Value

The default value is:

json
14

system_dbFontFamily

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

system_dbFontFamily

system_dbFontFamily Type

string

system_dbFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

system_dbFontWeight Type

any of the folllowing: string or number (Details)

system_dbFontWeight Default Value

The default value is:

json
"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_system_dbFontSize Type

any of the folllowing: string or number (Details)

external_system_dbFontSize Default Value

The default value is:

json
14

external_system_dbFontFamily

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

external_system_dbFontFamily

external_system_dbFontFamily Type

string

external_system_dbFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_system_dbFontWeight Type

any of the folllowing: string or number (Details)

external_system_dbFontWeight Default Value

The default value is:

json
"normal"

system_queueFontSize

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

system_queueFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

system_queueFontSize Type

any of the folllowing: string or number (Details)

system_queueFontSize Default Value

The default value is:

json
14

system_queueFontFamily

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

system_queueFontFamily

system_queueFontFamily Type

string

system_queueFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

system_queueFontWeight Type

any of the folllowing: string or number (Details)

system_queueFontWeight Default Value

The default value is:

json
"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_system_queueFontSize Type

any of the folllowing: string or number (Details)

external_system_queueFontSize Default Value

The default value is:

json
14

external_system_queueFontFamily

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

external_system_queueFontFamily

external_system_queueFontFamily Type

string

external_system_queueFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_system_queueFontWeight Type

any of the folllowing: string or number (Details)

external_system_queueFontWeight Default Value

The default value is:

json
"normal"

boundaryFontSize

This sets the font size of Boundary shape for the diagram

boundaryFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

boundaryFontSize Type

any of the folllowing: string or number (Details)

boundaryFontSize Default Value

The default value is:

json
14

boundaryFontFamily

This sets the font family of Boundary shape for the diagram

boundaryFontFamily

boundaryFontFamily Type

string

boundaryFontFamily Default Value

The default value is:

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

boundaryFontWeight

This sets the font weight of Boundary shape for the diagram

boundaryFontWeight

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

boundaryFontWeight Type

any of the folllowing: string or number (Details)

boundaryFontWeight Default Value

The default value is:

json
"normal"

messageFontSize

This sets the font size of Message shape for the diagram

messageFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

messageFontSize Type

any of the folllowing: string or number (Details)

messageFontSize Default Value

The default value is:

json
12

messageFontFamily

This sets the font family of Message shape for the diagram

messageFontFamily

messageFontFamily Type

string

messageFontFamily Default Value

The default value is:

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

messageFontWeight

This sets the font weight of Message shape for the diagram

messageFontWeight

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

messageFontWeight Type

any of the folllowing: string or number (Details)

messageFontWeight Default Value

The default value is:

json
"normal"

containerFontSize

This sets the font size of Container shape for the diagram

containerFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

containerFontSize Type

any of the folllowing: string or number (Details)

containerFontSize Default Value

The default value is:

json
14

containerFontFamily

This sets the font family of Container shape for the diagram

containerFontFamily

containerFontFamily Type

string

containerFontFamily Default Value

The default value is:

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

containerFontWeight

This sets the font weight of Container shape for the diagram

containerFontWeight

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

containerFontWeight Type

any of the folllowing: string or number (Details)

containerFontWeight Default Value

The default value is:

json
"normal"

external_containerFontSize

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

external_containerFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

external_containerFontSize Type

any of the folllowing: string or number (Details)

external_containerFontSize Default Value

The default value is:

json
14

external_containerFontFamily

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

external_containerFontFamily

external_containerFontFamily Type

string

external_containerFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_containerFontWeight Type

any of the folllowing: string or number (Details)

external_containerFontWeight Default Value

The default value is:

json
"normal"

container_dbFontSize

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

container_dbFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

container_dbFontSize Type

any of the folllowing: string or number (Details)

container_dbFontSize Default Value

The default value is:

json
14

container_dbFontFamily

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

container_dbFontFamily

container_dbFontFamily Type

string

container_dbFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

container_dbFontWeight Type

any of the folllowing: string or number (Details)

container_dbFontWeight Default Value

The default value is:

json
"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_container_dbFontSize Type

any of the folllowing: string or number (Details)

external_container_dbFontSize Default Value

The default value is:

json
14

external_container_dbFontFamily

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

external_container_dbFontFamily

external_container_dbFontFamily Type

string

external_container_dbFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_container_dbFontWeight Type

any of the folllowing: string or number (Details)

external_container_dbFontWeight Default Value

The default value is:

json
"normal"

container_queueFontSize

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

container_queueFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

container_queueFontSize Type

any of the folllowing: string or number (Details)

container_queueFontSize Default Value

The default value is:

json
14

container_queueFontFamily

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

container_queueFontFamily

container_queueFontFamily Type

string

container_queueFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

container_queueFontWeight Type

any of the folllowing: string or number (Details)

container_queueFontWeight Default Value

The default value is:

json
"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_container_queueFontSize Type

any of the folllowing: string or number (Details)

external_container_queueFontSize Default Value

The default value is:

json
14

external_container_queueFontFamily

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

external_container_queueFontFamily

external_container_queueFontFamily Type

string

external_container_queueFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_container_queueFontWeight Type

any of the folllowing: string or number (Details)

external_container_queueFontWeight Default Value

The default value is:

json
"normal"

componentFontSize

This sets the font size of Component shape for the diagram

componentFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

componentFontSize Type

any of the folllowing: string or number (Details)

componentFontSize Default Value

The default value is:

json
14

componentFontFamily

This sets the font family of Component shape for the diagram

componentFontFamily

componentFontFamily Type

string

componentFontFamily Default Value

The default value is:

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

componentFontWeight

This sets the font weight of Component shape for the diagram

componentFontWeight

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

componentFontWeight Type

any of the folllowing: string or number (Details)

componentFontWeight Default Value

The default value is:

json
"normal"

external_componentFontSize

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

external_componentFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

external_componentFontSize Type

any of the folllowing: string or number (Details)

external_componentFontSize Default Value

The default value is:

json
14

external_componentFontFamily

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

external_componentFontFamily

external_componentFontFamily Type

string

external_componentFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_componentFontWeight Type

any of the folllowing: string or number (Details)

external_componentFontWeight Default Value

The default value is:

json
"normal"

component_dbFontSize

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

component_dbFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

component_dbFontSize Type

any of the folllowing: string or number (Details)

component_dbFontSize Default Value

The default value is:

json
14

component_dbFontFamily

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

component_dbFontFamily

component_dbFontFamily Type

string

component_dbFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

component_dbFontWeight Type

any of the folllowing: string or number (Details)

component_dbFontWeight Default Value

The default value is:

json
"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_component_dbFontSize Type

any of the folllowing: string or number (Details)

external_component_dbFontSize Default Value

The default value is:

json
14

external_component_dbFontFamily

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

external_component_dbFontFamily

external_component_dbFontFamily Type

string

external_component_dbFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_component_dbFontWeight Type

any of the folllowing: string or number (Details)

external_component_dbFontWeight Default Value

The default value is:

json
"normal"

component_queueFontSize

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

component_queueFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

component_queueFontSize Type

any of the folllowing: string or number (Details)

component_queueFontSize Default Value

The default value is:

json
14

component_queueFontFamily

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

component_queueFontFamily

component_queueFontFamily Type

string

component_queueFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

component_queueFontWeight Type

any of the folllowing: string or number (Details)

component_queueFontWeight Default Value

The default value is:

json
"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_component_queueFontSize Type

any of the folllowing: string or number (Details)

external_component_queueFontSize Default Value

The default value is:

json
14

external_component_queueFontFamily

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

external_component_queueFontFamily

external_component_queueFontFamily Type

string

external_component_queueFontFamily Default Value

The default value is:

json
"\"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 folllowing: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

external_component_queueFontWeight Type

any of the folllowing: string or number (Details)

external_component_queueFontWeight Default Value

The default value is:

json
"normal"

wrap

This sets the auto-wrap state for the diagram

wrap

wrap Type

boolean

wrap Default Value

The default value is:

json
true

wrapPadding

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

wrapPadding

wrapPadding Type

number

wrapPadding Default Value

The default value is:

json
10

person_bg_color

person_bg_color

person_bg_color Type

string

person_bg_color Default Value

The default value is:

json
"#08427B"

person_border_color

person_border_color

person_border_color Type

string

person_border_color Default Value

The default value is:

json
"#073B6F"

external_person_bg_color

external_person_bg_color

external_person_bg_color Type

string

external_person_bg_color Default Value

The default value is:

json
"#686868"

external_person_border_color

external_person_border_color

external_person_border_color Type

string

external_person_border_color Default Value

The default value is:

json
"#8A8A8A"

system_bg_color

system_bg_color

system_bg_color Type

string

system_bg_color Default Value

The default value is:

json
"#1168BD"

system_border_color

system_border_color

system_border_color Type

string

system_border_color Default Value

The default value is:

json
"#3C7FC0"

system_db_bg_color

system_db_bg_color

system_db_bg_color Type

string

system_db_bg_color Default Value

The default value is:

json
"#1168BD"

system_db_border_color

system_db_border_color

system_db_border_color Type

string

system_db_border_color Default Value

The default value is:

json
"#3C7FC0"

system_queue_bg_color

system_queue_bg_color

system_queue_bg_color Type

string

system_queue_bg_color Default Value

The default value is:

json
"#1168BD"

system_queue_border_color

system_queue_border_color

system_queue_border_color Type

string

system_queue_border_color Default Value

The default value is:

json
"#3C7FC0"

external_system_bg_color

external_system_bg_color

external_system_bg_color Type

string

external_system_bg_color Default Value

The default value is:

json
"#999999"

external_system_border_color

external_system_border_color

external_system_border_color Type

string

external_system_border_color Default Value

The default value is:

json
"#8A8A8A"

external_system_db_bg_color

external_system_db_bg_color

external_system_db_bg_color Type

string

external_system_db_bg_color Default Value

The default value is:

json
"#999999"

external_system_db_border_color

external_system_db_border_color

external_system_db_border_color Type

string

external_system_db_border_color Default Value

The default value is:

json
"#8A8A8A"

external_system_queue_bg_color

external_system_queue_bg_color

external_system_queue_bg_color Type

string

external_system_queue_bg_color Default Value

The default value is:

json
"#999999"

external_system_queue_border_color

external_system_queue_border_color

external_system_queue_border_color Type

string

external_system_queue_border_color Default Value

The default value is:

json
"#8A8A8A"

container_bg_color

container_bg_color

container_bg_color Type

string

container_bg_color Default Value

The default value is:

json
"#438DD5"

container_border_color

container_border_color

container_border_color Type

string

container_border_color Default Value

The default value is:

json
"#3C7FC0"

container_db_bg_color

container_db_bg_color

container_db_bg_color Type

string

container_db_bg_color Default Value

The default value is:

json
"#438DD5"

container_db_border_color

container_db_border_color

container_db_border_color Type

string

container_db_border_color Default Value

The default value is:

json
"#3C7FC0"

container_queue_bg_color

container_queue_bg_color

container_queue_bg_color Type

string

container_queue_bg_color Default Value

The default value is:

json
"#438DD5"

container_queue_border_color

container_queue_border_color

container_queue_border_color Type

string

container_queue_border_color Default Value

The default value is:

json
"#3C7FC0"

external_container_bg_color

external_container_bg_color

external_container_bg_color Type

string

external_container_bg_color Default Value

The default value is:

json
"#B3B3B3"

external_container_border_color

external_container_border_color

external_container_border_color Type

string

external_container_border_color Default Value

The default value is:

json
"#A6A6A6"

external_container_db_bg_color

external_container_db_bg_color

external_container_db_bg_color Type

string

external_container_db_bg_color Default Value

The default value is:

json
"#B3B3B3"

external_container_db_border_color

external_container_db_border_color

external_container_db_border_color Type

string

external_container_db_border_color Default Value

The default value is:

json
"#A6A6A6"

external_container_queue_bg_color

external_container_queue_bg_color

external_container_queue_bg_color Type

string

external_container_queue_bg_color Default Value

The default value is:

json
"#B3B3B3"

external_container_queue_border_color

external_container_queue_border_color

external_container_queue_border_color Type

string

external_container_queue_border_color Default Value

The default value is:

json
"#A6A6A6"

component_bg_color

component_bg_color

component_bg_color Type

string

component_bg_color Default Value

The default value is:

json
"#85BBF0"

component_border_color

component_border_color

component_border_color Type

string

component_border_color Default Value

The default value is:

json
"#78A8D8"

component_db_bg_color

component_db_bg_color

component_db_bg_color Type

string

component_db_bg_color Default Value

The default value is:

json
"#85BBF0"

component_db_border_color

component_db_border_color

component_db_border_color Type

string

component_db_border_color Default Value

The default value is:

json
"#78A8D8"

component_queue_bg_color

component_queue_bg_color

component_queue_bg_color Type

string

component_queue_bg_color Default Value

The default value is:

json
"#85BBF0"

component_queue_border_color

component_queue_border_color

component_queue_border_color Type

string

component_queue_border_color Default Value

The default value is:

json
"#78A8D8"

external_component_bg_color

external_component_bg_color

external_component_bg_color Type

string

external_component_bg_color Default Value

The default value is:

json
"#CCCCCC"

external_component_border_color

external_component_border_color

external_component_border_color Type

string

external_component_border_color Default Value

The default value is:

json
"#BFBFBF"

external_component_db_bg_color

external_component_db_bg_color

external_component_db_bg_color Type

string

external_component_db_bg_color Default Value

The default value is:

json
"#CCCCCC"

external_component_db_border_color

external_component_db_border_color

external_component_db_border_color Type

string

external_component_db_border_color Default Value

The default value is:

json
"#BFBFBF"

external_component_queue_bg_color

external_component_queue_bg_color

external_component_queue_bg_color Type

string

external_component_queue_bg_color Default Value

The default value is:

json
"#CCCCCC"

external_component_queue_border_color

external_component_queue_border_color

external_component_queue_border_color Type

string

external_component_queue_border_color Default Value

The default value is:

json
"#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:

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

personFont

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:

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

external_personFont

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:

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

systemFont

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:

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

external_systemFont

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:

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

system_dbFont

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:

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

external_system_dbFont

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:

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

system_queueFont

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:

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

external_system_queueFont

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:

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

containerFont

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:

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

external_containerFont

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:

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

container_dbFont

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:

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

external_container_dbFont

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:

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

container_queueFont

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:

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

external_container_queueFont

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:

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

componentFont

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:

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

external_componentFont

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:

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

component_dbFont

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:

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

external_component_dbFont

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:

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

component_queueFont

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:

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

external_component_queueFont

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:

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

boundaryFont

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:

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

messageFont

messageFont Type

unknown (Font Calculator)

Definitions group GitGraphDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/GitGraphDiagramConfig" }
PropertyTypeRequiredNullableDefined by
titleTopMarginintegerRequiredcannot be nullMermaid Config
diagramPaddingnumberOptionalcannot be nullMermaid Config
nodeLabelMergedOptionalcannot be nullMermaid Config
mainBranchNamestringOptionalcannot be nullMermaid Config
mainBranchOrdernumberOptionalcannot be nullMermaid Config
showCommitLabelbooleanOptionalcannot be nullMermaid Config
showBranchesbooleanOptionalcannot be nullMermaid Config
rotateCommitLabelbooleanOptionalcannot be nullMermaid Config
parallelCommitsbooleanOptionalcannot be nullMermaid Config
arrowMarkerAbsolutebooleanOptionalcannot be nullMermaid Config

titleTopMargin

Margin top for the text over the diagram

titleTopMargin

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:

json
25

diagramPadding

diagramPadding

diagramPadding Type

number

diagramPadding Default Value

The default value is:

json
8

nodeLabel

nodeLabel

nodeLabel Type

object (Details)

all of

nodeLabel Default Value

The default value is:

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

mainBranchName

mainBranchName

mainBranchName Type

string

mainBranchName Default Value

The default value is:

json
"main"

mainBranchOrder

mainBranchOrder

mainBranchOrder Type

number

showCommitLabel

showCommitLabel

showCommitLabel Type

boolean

showCommitLabel Default Value

The default value is:

json
true

showBranches

showBranches

showBranches Type

boolean

showBranches Default Value

The default value is:

json
true

rotateCommitLabel

rotateCommitLabel

rotateCommitLabel Type

boolean

rotateCommitLabel Default Value

The default value is:

json
true

parallelCommits

parallelCommits

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

arrowMarkerAbsolute Type

boolean

Definitions group NodeLabel

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/NodeLabel" }
PropertyTypeRequiredNullableDefined by
widthnumberOptionalcannot be nullMermaid Config
heightnumberOptionalcannot be nullMermaid Config
xnumberOptionalcannot be nullMermaid Config
ynumberOptionalcannot be nullMermaid Config

width

width

width Type

number

height

height

height Type

number

x

x

x Type

number

y

y

y Type

number

Definitions group RequirementDiagramConfig

Reference this group by using

json
{
  "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/RequirementDiagramConfig"
}
PropertyTypeRequiredNullableDefined by
rect_fillstringOptionalcannot be nullMermaid Config
text_colorstringOptionalcannot be nullMermaid Config
rect_border_sizestringOptionalcannot be nullMermaid Config
rect_border_colorstringOptionalcannot be nullMermaid Config
rect_min_widthnumberOptionalcannot be nullMermaid Config
rect_min_heightnumberOptionalcannot be nullMermaid Config
fontSizenumberOptionalcannot be nullMermaid Config
rect_paddingnumberOptionalcannot be nullMermaid Config
line_heightnumberOptionalcannot be nullMermaid Config

rect_fill

rect_fill

rect_fill Type

string

rect_fill Default Value

The default value is:

json
"#f9f9f9"

text_color

text_color

text_color Type

string

text_color Default Value

The default value is:

json
"#333"

rect_border_size

rect_border_size

rect_border_size Type

string

rect_border_size Default Value

The default value is:

json
"0.5px"

rect_border_color

rect_border_color

rect_border_color Type

string

rect_border_color Default Value

The default value is:

json
"#bbb"

rect_min_width

rect_min_width

rect_min_width Type

number

rect_min_width Default Value

The default value is:

json
200

rect_min_height

rect_min_height

rect_min_height Type

number

rect_min_height Default Value

The default value is:

json
200

fontSize

fontSize

fontSize Type

number

fontSize Default Value

The default value is:

json
14

rect_padding

rect_padding

rect_padding Type

number

rect_padding Default Value

The default value is:

json
10

line_height

line_height

line_height Type

number

line_height Default Value

The default value is:

json
20

Definitions group MindmapDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/MindmapDiagramConfig" }
PropertyTypeRequiredNullableDefined by
paddingnumberRequiredcannot be nullMermaid Config
maxNodeWidthnumberRequiredcannot be nullMermaid Config

padding

padding

padding Type

number

padding Default Value

The default value is:

json
10

maxNodeWidth

maxNodeWidth

maxNodeWidth Type

number

maxNodeWidth Default Value

The default value is:

json
200

Definitions group PieDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/PieDiagramConfig" }
PropertyTypeRequiredNullableDefined by
textPositionnumberOptionalcannot be nullMermaid Config

textPosition

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

textPosition

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:

json
0.75

Definitions group QuadrantChartConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/QuadrantChartConfig" }
PropertyTypeRequiredNullableDefined by
chartWidthnumberRequiredcannot be nullMermaid Config
chartHeightnumberRequiredcannot be nullMermaid Config
titleFontSizenumberRequiredcannot be nullMermaid Config
titlePaddingnumberRequiredcannot be nullMermaid Config
quadrantPaddingnumberRequiredcannot be nullMermaid Config
xAxisLabelPaddingnumberRequiredcannot be nullMermaid Config
yAxisLabelPaddingnumberRequiredcannot be nullMermaid Config
xAxisLabelFontSizenumberRequiredcannot be nullMermaid Config
yAxisLabelFontSizenumberRequiredcannot be nullMermaid Config
quadrantLabelFontSizenumberRequiredcannot be nullMermaid Config
quadrantTextTopPaddingnumberRequiredcannot be nullMermaid Config
pointTextPaddingnumberRequiredcannot be nullMermaid Config
pointLabelFontSizenumberRequiredcannot be nullMermaid Config
pointRadiusnumberRequiredcannot be nullMermaid Config
xAxisPositionstringRequiredcannot be nullMermaid Config
yAxisPositionstringRequiredcannot be nullMermaid Config
quadrantInternalBorderStrokeWidthnumberRequiredcannot be nullMermaid Config
quadrantExternalBorderStrokeWidthnumberRequiredcannot be nullMermaid Config

chartWidth

Width of the chart

chartWidth

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:

json
500

chartHeight

Height of the chart

chartHeight

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:

json
500

titleFontSize

Chart title top and bottom padding

titleFontSize

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:

json
20

titlePadding

Padding around the quadrant square

titlePadding

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:

json
10

quadrantPadding

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

quadrantPadding

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:

json
5

xAxisLabelPadding

Padding around x-axis labels

xAxisLabelPadding

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:

json
5

yAxisLabelPadding

Padding around y-axis labels

yAxisLabelPadding

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:

json
5

xAxisLabelFontSize

x-axis label font size

xAxisLabelFontSize

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:

json
16

yAxisLabelFontSize

y-axis label font size

yAxisLabelFontSize

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:

json
16

quadrantLabelFontSize

quadrant title font size

quadrantLabelFontSize

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:

json
16

quadrantTextTopPadding

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

quadrantTextTopPadding

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:

json
5

pointTextPadding

padding between point and point label

pointTextPadding

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:

json
5

pointLabelFontSize

point title font size

pointLabelFontSize

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:

json
12

pointRadius

radius of the point to be drawn

pointRadius

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:

json
5

xAxisPosition

position of x-axis labels

xAxisPosition

xAxisPosition Type

string

xAxisPosition Constraints

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

ValueExplanation
"top"
"bottom"

xAxisPosition Default Value

The default value is:

json
"top"

yAxisPosition

position of y-axis labels

yAxisPosition

yAxisPosition Type

string

yAxisPosition Constraints

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

ValueExplanation
"left"
"right"

yAxisPosition Default Value

The default value is:

json
"left"

quadrantInternalBorderStrokeWidth

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

quadrantInternalBorderStrokeWidth

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:

json
1

quadrantExternalBorderStrokeWidth

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

quadrantExternalBorderStrokeWidth

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:

json
2

Definitions group XYChartAxisConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/XYChartAxisConfig" }
PropertyTypeRequiredNullableDefined by
showLabelbooleanRequiredcannot be nullMermaid Config
labelFontSizenumberRequiredcannot be nullMermaid Config
labelPaddingnumberRequiredcannot be nullMermaid Config
showTitlebooleanRequiredcannot be nullMermaid Config
titleFontSizenumberRequiredcannot be nullMermaid Config
titlePaddingnumberRequiredcannot be nullMermaid Config
showTickbooleanRequiredcannot be nullMermaid Config
tickLengthnumberRequiredcannot be nullMermaid Config
tickWidthnumberRequiredcannot be nullMermaid Config
showAxisLinebooleanRequiredcannot be nullMermaid Config
axisLineWidthnumberRequiredcannot be nullMermaid Config

showLabel

Should show the axis labels (tick text)

showLabel

showLabel Type

boolean

showLabel Default Value

The default value is:

json
true

labelFontSize

font size of the axis labels (tick text)

labelFontSize

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:

json
14

labelPadding

top and bottom space from axis label (tick text)

labelPadding

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:

json
5

showTitle

Should show the axis title

showTitle

showTitle Type

boolean

showTitle Default Value

The default value is:

json
true

titleFontSize

font size of the axis title

titleFontSize

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:

json
16

titlePadding

top and bottom space from axis title

titlePadding

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:

json
5

showTick

Should show the axis tick lines

showTick

showTick Type

boolean

showTick Default Value

The default value is:

json
true

tickLength

length of the axis tick lines

tickLength

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:

json
5

tickWidth

width of the axis tick lines

tickWidth

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:

json
2

showAxisLine

Show line across the axis

showAxisLine

showAxisLine Type

boolean

showAxisLine Default Value

The default value is:

json
true

axisLineWidth

Width of the axis line

axisLineWidth

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:

json
2

Definitions group XYChartConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/XYChartConfig" }
PropertyTypeRequiredNullableDefined by
widthnumberRequiredcannot be nullMermaid Config
heightnumberRequiredcannot be nullMermaid Config
titleFontSizenumberRequiredcannot be nullMermaid Config
titlePaddingnumberRequiredcannot be nullMermaid Config
showTitlebooleanRequiredcannot be nullMermaid Config
xAxisobjectRequiredcannot be nullMermaid Config
yAxisobjectRequiredcannot be nullMermaid Config
chartOrientationNot specifiedRequiredcannot be nullMermaid Config
plotReservedSpacePercentnumberRequiredcannot be nullMermaid Config

width

width of the chart

width

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:

json
700

height

height of the chart

height

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:

json
500

titleFontSize

Font size of the chart title

titleFontSize

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:

json
20

titlePadding

Top and bottom space from the chart title

titlePadding

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:

json
10

showTitle

Should show the chart title

showTitle

showTitle Type

boolean

showTitle Default Value

The default value is:

json
true

xAxis

This object contains configuration for XYChart axis config

xAxis

xAxis Type

object (XYChart axis config)

xAxis Default Value

The default value is:

json
{
  "$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

yAxis Type

object (XYChart axis config)

yAxis Default Value

The default value is:

json
{
  "$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:

json
"vertical"

plotReservedSpacePercent

Minimum percent of space plots of the chart will take

plotReservedSpacePercent

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:

json
50

Definitions group ErDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/ErDiagramConfig" }
PropertyTypeRequiredNullableDefined by
titleTopMarginintegerRequiredcannot be nullMermaid Config
diagramPaddingintegerRequiredcannot be nullMermaid Config
layoutDirectionstringRequiredcannot be nullMermaid Config
minEntityWidthintegerRequiredcannot be nullMermaid Config
minEntityHeightintegerRequiredcannot be nullMermaid Config
entityPaddingintegerRequiredcannot be nullMermaid Config
strokestringRequiredcannot be nullMermaid Config
fillstringRequiredcannot be nullMermaid Config
fontSizeintegerOptionalcannot be nullMermaid Config

titleTopMargin

Margin top for the text over the diagram

titleTopMargin

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:

json
25

diagramPadding

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

diagramPadding

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:

json
20

layoutDirection

Directional bias for layout of entities

layoutDirection

  • is required

  • Type: string

  • cannot be null

  • defined in: Mermaid Config

  • tsType: string | "TB" | "BT" | "LR" | "RL"

layoutDirection Type

string

layoutDirection Constraints

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

ValueExplanation
"TB"Top-Bottom
"BT"Bottom-Top
"LR"Left-Right
"RL"Right to Left

layoutDirection Default Value

The default value is:

json
"TB"

minEntityWidth

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

minEntityWidth

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:

json
100

minEntityHeight

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

minEntityHeight

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:

json
75

entityPadding

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

entityPadding

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:

json
15

stroke

Stroke color of box edges and lines.

stroke

stroke Type

string

stroke Default Value

The default value is:

json
"gray"

fill

Fill color of entity boxes

fill

fill Type

string

fill Default Value

The default value is:

json
"honeydew"

fontSize

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

fontSize

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:

json
12

Definitions group StateDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/StateDiagramConfig" }
PropertyTypeRequiredNullableDefined by
titleTopMarginintegerRequiredcannot be nullMermaid Config
arrowMarkerAbsolutebooleanOptionalcannot be nullMermaid Config
dividerMarginnumberOptionalcannot be nullMermaid Config
sizeUnitnumberOptionalcannot be nullMermaid Config
paddingnumberOptionalcannot be nullMermaid Config
textHeightnumberOptionalcannot be nullMermaid Config
titleShiftnumberOptionalcannot be nullMermaid Config
noteMarginnumberOptionalcannot be nullMermaid Config
forkWidthnumberOptionalcannot be nullMermaid Config
forkHeightnumberOptionalcannot be nullMermaid Config
miniPaddingnumberOptionalcannot be nullMermaid Config
fontSizeFactornumberOptionalcannot be nullMermaid Config
fontSizenumberOptionalcannot be nullMermaid Config
labelHeightnumberOptionalcannot be nullMermaid Config
edgeLengthFactorstringOptionalcannot be nullMermaid Config
compositTitleSizenumberOptionalcannot be nullMermaid Config
radiusnumberOptionalcannot be nullMermaid Config
defaultRendererstringRequiredcannot be nullMermaid Config

titleTopMargin

Margin top for the text over the diagram

titleTopMargin

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:

json
25

arrowMarkerAbsolute

arrowMarkerAbsolute

arrowMarkerAbsolute Type

boolean

dividerMargin

dividerMargin

dividerMargin Type

number

dividerMargin Default Value

The default value is:

json
10

sizeUnit

sizeUnit

sizeUnit Type

number

sizeUnit Default Value

The default value is:

json
5

padding

padding

padding Type

number

padding Default Value

The default value is:

json
8

textHeight

textHeight

textHeight Type

number

textHeight Default Value

The default value is:

json
10

titleShift

titleShift

titleShift Type

number

titleShift Default Value

The default value is:

json
-15

noteMargin

noteMargin

noteMargin Type

number

noteMargin Default Value

The default value is:

json
10

forkWidth

forkWidth

forkWidth Type

number

forkWidth Default Value

The default value is:

json
70

forkHeight

forkHeight

forkHeight Type

number

forkHeight Default Value

The default value is:

json
7

miniPadding

miniPadding

miniPadding Type

number

miniPadding Default Value

The default value is:

json
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

fontSizeFactor Type

number

fontSizeFactor Default Value

The default value is:

json
5.02

fontSize

fontSize

fontSize Type

number

fontSize Default Value

The default value is:

json
24

labelHeight

labelHeight

labelHeight Type

number

labelHeight Default Value

The default value is:

json
16

edgeLengthFactor

edgeLengthFactor

edgeLengthFactor Type

string

edgeLengthFactor Default Value

The default value is:

json
"20"

compositTitleSize

compositTitleSize

compositTitleSize Type

number

compositTitleSize Default Value

The default value is:

json
35

radius

radius

radius Type

number

radius Default Value

The default value is:

json
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

  • tsType: string | "dagre-d3" | "dagre-wrapper" | "elk"

defaultRenderer Type

string

defaultRenderer Constraints

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

ValueExplanation
"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:

json
"dagre-wrapper"

Definitions group ClassDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/ClassDiagramConfig" }
PropertyTypeRequiredNullableDefined by
titleTopMarginintegerRequiredcannot be nullMermaid Config
arrowMarkerAbsolutebooleanOptionalcannot be nullMermaid Config
dividerMarginnumberOptionalcannot be nullMermaid Config
paddingnumberOptionalcannot be nullMermaid Config
textHeightnumberOptionalcannot be nullMermaid Config
defaultRendererstringRequiredcannot be nullMermaid Config
nodeSpacingintegerOptionalcannot be nullMermaid Config
rankSpacingintegerOptionalcannot be nullMermaid Config
diagramPaddingintegerOptionalcannot be nullMermaid Config
htmlLabelsbooleanOptionalcannot be nullMermaid Config

titleTopMargin

Margin top for the text over the diagram

titleTopMargin

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:

json
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

arrowMarkerAbsolute Type

boolean

dividerMargin

dividerMargin

dividerMargin Type

number

dividerMargin Default Value

The default value is:

json
10

padding

padding

padding Type

number

padding Default Value

The default value is:

json
5

textHeight

textHeight

textHeight Type

number

textHeight Default Value

The default value is:

json
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

  • tsType: string | "dagre-d3" | "dagre-wrapper" | "elk"

defaultRenderer Type

string

defaultRenderer Constraints

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

ValueExplanation
"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:

json
"dagre-wrapper"

nodeSpacing

nodeSpacing

nodeSpacing Type

integer

nodeSpacing Constraints

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

rankSpacing

rankSpacing

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

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:

json
20

htmlLabels

htmlLabels

htmlLabels Type

boolean

Definitions group JourneyDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/JourneyDiagramConfig" }
PropertyTypeRequiredNullableDefined by
diagramMarginXintegerRequiredcannot be nullMermaid Config
diagramMarginYintegerRequiredcannot be nullMermaid Config
leftMarginintegerRequiredcannot be nullMermaid Config
widthintegerRequiredcannot be nullMermaid Config
heightintegerRequiredcannot be nullMermaid Config
boxMarginintegerRequiredcannot be nullMermaid Config
boxTextMarginintegerRequiredcannot be nullMermaid Config
noteMarginintegerRequiredcannot be nullMermaid Config
messageMarginintegerRequiredcannot be nullMermaid Config
messageAlignstringRequiredcannot be nullMermaid Config
bottomMarginAdjintegerRequiredcannot be nullMermaid Config
rightAnglesbooleanRequiredcannot be nullMermaid Config
taskFontSizeMultipleOptionalcannot be nullMermaid Config
taskFontFamilystringOptionalcannot be nullMermaid Config
taskMarginnumberOptionalcannot be nullMermaid Config
activationWidthnumberOptionalcannot be nullMermaid Config
textPlacementstringOptionalcannot be nullMermaid Config
actorColoursarrayOptionalcannot be nullMermaid Config
sectionFillsarrayOptionalcannot be nullMermaid Config
sectionColoursarrayOptionalcannot be nullMermaid Config

diagramMarginX

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

diagramMarginX

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:

json
50

diagramMarginY

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

diagramMarginY

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:

json
10

leftMargin

Margin between actors

leftMargin

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:

json
150

width

Width of actor boxes

width

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:

json
150

height

Height of actor boxes

height

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:

json
50

boxMargin

Margin around loop boxes

boxMargin

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:

json
10

boxTextMargin

Margin around the text in loop/alt/opt boxes

boxTextMargin

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:

json
5

noteMargin

Margin around notes

noteMargin

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:

json
10

messageMargin

Space between messages.

messageMargin

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:

json
35

messageAlign

Multiline message alignment

messageAlign

  • is required

  • Type: string

  • cannot be null

  • defined in: Mermaid Config

  • tsType: string | "left" | "center" | "right"

messageAlign Type

string

messageAlign Constraints

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

ValueExplanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

json
"center"

bottomMarginAdj

Prolongs the edge of the diagram downwards.

Depending on css styling this might need adjustment.

bottomMarginAdj

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:

json
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

rightAngles Type

boolean

taskFontSize

taskFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

taskFontSize Type

any of the folllowing: string or number (Details)

taskFontSize Default Value

The default value is:

json
14

taskFontFamily

taskFontFamily

taskFontFamily Type

string

taskFontFamily Default Value

The default value is:

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

taskMargin

taskMargin

taskMargin Type

number

taskMargin Default Value

The default value is:

json
50

activationWidth

Width of activation box

activationWidth

activationWidth Type

number

activationWidth Default Value

The default value is:

json
10

textPlacement

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

textPlacement

textPlacement Type

string

textPlacement Default Value

The default value is:

json
"fo"

actorColours

actorColours

actorColours Type

string[]

actorColours Default Value

The default value is:

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

sectionFills

sectionFills

sectionFills Type

string[]

sectionFills Default Value

The default value is:

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

sectionColours

sectionColours

sectionColours Type

string[]

sectionColours Default Value

The default value is:

json
["#fff"]

Definitions group TimelineDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/TimelineDiagramConfig" }
PropertyTypeRequiredNullableDefined by
diagramMarginXintegerRequiredcannot be nullMermaid Config
diagramMarginYintegerRequiredcannot be nullMermaid Config
leftMarginintegerRequiredcannot be nullMermaid Config
widthintegerRequiredcannot be nullMermaid Config
heightintegerRequiredcannot be nullMermaid Config
paddingnumberOptionalcannot be nullMermaid Config
boxMarginintegerRequiredcannot be nullMermaid Config
boxTextMarginintegerRequiredcannot be nullMermaid Config
noteMarginintegerRequiredcannot be nullMermaid Config
messageMarginintegerRequiredcannot be nullMermaid Config
messageAlignstringRequiredcannot be nullMermaid Config
bottomMarginAdjintegerRequiredcannot be nullMermaid Config
rightAnglesbooleanOptionalcannot be nullMermaid Config
taskFontSizeMultipleOptionalcannot be nullMermaid Config
taskFontFamilystringOptionalcannot be nullMermaid Config
taskMarginnumberOptionalcannot be nullMermaid Config
activationWidthnumberOptionalcannot be nullMermaid Config
textPlacementstringOptionalcannot be nullMermaid Config
actorColoursarrayOptionalcannot be nullMermaid Config
sectionFillsarrayOptionalcannot be nullMermaid Config
sectionColoursarrayOptionalcannot be nullMermaid Config
disableMulticolorbooleanOptionalcannot be nullMermaid Config

diagramMarginX

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

diagramMarginX

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:

json
50

diagramMarginY

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

diagramMarginY

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:

json
10

leftMargin

Margin between actors

leftMargin

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:

json
150

width

Width of actor boxes

width

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:

json
150

height

Height of actor boxes

height

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:

json
50

padding

padding

padding Type

number

boxMargin

Margin around loop boxes

boxMargin

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:

json
10

boxTextMargin

Margin around the text in loop/alt/opt boxes

boxTextMargin

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:

json
5

noteMargin

Margin around notes

noteMargin

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:

json
10

messageMargin

Space between messages.

messageMargin

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:

json
35

messageAlign

Multiline message alignment

messageAlign

  • is required

  • Type: string

  • cannot be null

  • defined in: Mermaid Config

  • tsType: string | "left" | "center" | "right"

messageAlign Type

string

messageAlign Constraints

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

ValueExplanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

json
"center"

bottomMarginAdj

Prolongs the edge of the diagram downwards.

Depending on css styling this might need adjustment.

bottomMarginAdj

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:

json
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

rightAngles Type

boolean

taskFontSize

taskFontSize

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

taskFontSize Type

any of the folllowing: string or number (Details)

taskFontSize Default Value

The default value is:

json
14

taskFontFamily

taskFontFamily

taskFontFamily Type

string

taskFontFamily Default Value

The default value is:

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

taskMargin

taskMargin

taskMargin Type

number

taskMargin Default Value

The default value is:

json
50

activationWidth

Width of activation box

activationWidth

activationWidth Type

number

activationWidth Default Value

The default value is:

json
10

textPlacement

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

textPlacement

textPlacement Type

string

textPlacement Default Value

The default value is:

json
"fo"

actorColours

actorColours

actorColours Type

string[]

actorColours Default Value

The default value is:

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

sectionFills

sectionFills

sectionFills Type

string[]

sectionFills Default Value

The default value is:

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

sectionColours

sectionColours

sectionColours Type

string[]

sectionColours Default Value

The default value is:

json
["#fff"]

disableMulticolor

disableMulticolor

disableMulticolor Type

boolean

Definitions group GanttDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/GanttDiagramConfig" }
PropertyTypeRequiredNullableDefined by
titleTopMarginintegerRequiredcannot be nullMermaid Config
barHeightintegerRequiredcannot be nullMermaid Config
barGapintegerOptionalcannot be nullMermaid Config
topPaddingintegerRequiredcannot be nullMermaid Config
rightPaddingintegerRequiredcannot be nullMermaid Config
leftPaddingintegerRequiredcannot be nullMermaid Config
gridLineStartPaddingintegerRequiredcannot be nullMermaid Config
fontSizeintegerRequiredcannot be nullMermaid Config
sectionFontSizeintegerRequiredcannot be nullMermaid Config
numberSectionStylesintegerRequiredcannot be nullMermaid Config
axisFormatstringRequiredcannot be nullMermaid Config
tickIntervalstringOptionalcannot be nullMermaid Config
topAxisbooleanRequiredcannot be nullMermaid Config
displayModestringOptionalcannot be nullMermaid Config
weekdaystringRequiredcannot be nullMermaid Config

titleTopMargin

Margin top for the text over the diagram

titleTopMargin

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:

json
25

barHeight

The height of the bars in the graph

barHeight

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:

json
20

barGap

The margin between the different activities in the gantt diagram

barGap

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:

json
4

topPadding

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

topPadding

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:

json
50

rightPadding

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

rightPadding

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:

json
75

leftPadding

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

leftPadding

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:

json
75

gridLineStartPadding

Vertical starting position of the grid lines

gridLineStartPadding

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:

json
35

fontSize

Font size

fontSize

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:

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

json
11

numberSectionStyles

The number of alternating section styles

numberSectionStyles

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:

json
4

axisFormat

Date/time format of the axis

This might need adjustment to match your locale and preferences.

axisFormat

axisFormat Type

string

axisFormat Default Value

The default value is:

json
"%Y-%m-%d"

tickInterval

axis ticks

Pattern is:

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

tickInterval

tickInterval Type

string

tickInterval Constraints

pattern: the string must match the following regular expression:

javascript
/^([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

topAxis Type

boolean

displayMode

Controls the display mode.

displayMode

  • is optional

  • Type: string

  • cannot be null

  • defined in: Mermaid Config

  • tsType: string | "compact"

displayMode Type

string

displayMode Constraints

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

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

  • tsType: "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"

weekday Type

string

weekday Constraints

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

ValueExplanation
"monday"
"tuesday"
"wednesday"
"thursday"
"friday"
"saturday"
"sunday"

weekday Default Value

The default value is:

json
"sunday"

Definitions group SequenceDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/SequenceDiagramConfig" }
PropertyTypeRequiredNullableDefined by
arrowMarkerAbsolutebooleanOptionalcannot be nullMermaid Config
hideUnusedParticipantsbooleanOptionalcannot be nullMermaid Config
activationWidthintegerRequiredcannot be nullMermaid Config
diagramMarginXintegerRequiredcannot be nullMermaid Config
diagramMarginYintegerRequiredcannot be nullMermaid Config
actorMarginintegerRequiredcannot be nullMermaid Config
widthintegerRequiredcannot be nullMermaid Config
heightintegerRequiredcannot be nullMermaid Config
boxMarginintegerRequiredcannot be nullMermaid Config
boxTextMarginintegerRequiredcannot be nullMermaid Config
noteMarginintegerRequiredcannot be nullMermaid Config
messageMarginintegerRequiredcannot be nullMermaid Config
messageAlignstringRequiredcannot be nullMermaid Config
mirrorActorsbooleanRequiredcannot be nullMermaid Config
forceMenusbooleanRequiredcannot be nullMermaid Config
bottomMarginAdjintegerRequiredcannot be nullMermaid Config
rightAnglesbooleanRequiredcannot be nullMermaid Config
showSequenceNumbersbooleanRequiredcannot be nullMermaid Config
actorFontSizeMultipleRequiredcannot be nullMermaid Config
actorFontFamilystringRequiredcannot be nullMermaid Config
actorFontWeightMultipleRequiredcannot be nullMermaid Config
noteFontSizeMultipleRequiredcannot be nullMermaid Config
noteFontFamilystringRequiredcannot be nullMermaid Config
noteFontWeightMultipleRequiredcannot be nullMermaid Config
noteAlignstringRequiredcannot be nullMermaid Config
messageFontSizeMultipleRequiredcannot be nullMermaid Config
messageFontFamilystringRequiredcannot be nullMermaid Config
messageFontWeightMultipleRequiredcannot be nullMermaid Config
wrapbooleanOptionalcannot be nullMermaid Config
wrapPaddingnumberOptionalcannot be nullMermaid Config
labelBoxWidthnumberOptionalcannot be nullMermaid Config
labelBoxHeightnumberOptionalcannot be nullMermaid Config
messageFontNot specifiedOptionalcannot be nullMermaid Config
noteFontNot specifiedOptionalcannot be nullMermaid Config
actorFontNot specifiedOptionalcannot be nullMermaid Config

arrowMarkerAbsolute

arrowMarkerAbsolute

arrowMarkerAbsolute Type

boolean

hideUnusedParticipants

hideUnusedParticipants

hideUnusedParticipants Type

boolean

activationWidth

Width of the activation rect

activationWidth

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:

json
10

diagramMarginX

Margin to the right and left of the sequence diagram

diagramMarginX

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:

json
50

diagramMarginY

Margin to the over and under the sequence diagram

diagramMarginY

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:

json
10

actorMargin

Margin between actors

actorMargin

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:

json
50

width

Width of actor boxes

width

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:

json
150

height

Height of actor boxes

height

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:

json
50

boxMargin

Margin around loop boxes

boxMargin

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:

json
10

boxTextMargin

Margin around the text in loop/alt/opt boxes

boxTextMargin

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:

json
5

noteMargin

Margin around notes

noteMargin

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:

json
10

messageMargin

Space between messages.

messageMargin

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:

json
35

messageAlign

Multiline message alignment

messageAlign

  • is required

  • Type: string

  • cannot be null

  • defined in: Mermaid Config

  • tsType: string | "left" | "center" | "right"

messageAlign Type

string

messageAlign Constraints

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

ValueExplanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

json
"center"

mirrorActors

Mirror actors under diagram

mirrorActors

mirrorActors Type

boolean

mirrorActors Default Value

The default value is:

json
true

forceMenus

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

forceMenus

forceMenus Type

boolean

bottomMarginAdj

Prolongs the edge of the diagram downwards.

Depending on css styling this might need adjustment.

bottomMarginAdj

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:

json
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

rightAngles Type

boolean

showSequenceNumbers

This will show the node numbers

showSequenceNumbers

showSequenceNumbers Type

boolean

actorFontSize

This sets the font size of the actor's description

actorFontSize

  • is required

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

  • cannot be null

  • defined in: Mermaid Config

actorFontSize Type

any of the folllowing: string or number (Details)

actorFontSize Default Value

The default value is:

json
14

actorFontFamily

This sets the font family of the actor's description

actorFontFamily

actorFontFamily Type

string

actorFontFamily Default Value

The default value is:

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

actorFontWeight

This sets the font weight of the actor's description

actorFontWeight

  • is required

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

  • cannot be null

  • defined in: Mermaid Config

actorFontWeight Type

any of the folllowing: string or number (Details)

actorFontWeight Default Value

The default value is:

json
400

noteFontSize

This sets the font size of actor-attached notes

noteFontSize

  • is required

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

  • cannot be null

  • defined in: Mermaid Config

noteFontSize Type

any of the folllowing: string or number (Details)

noteFontSize Default Value

The default value is:

json
14

noteFontFamily

This sets the font family of actor-attached notes

noteFontFamily

noteFontFamily Type

string

noteFontFamily Default Value

The default value is:

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

noteFontWeight

This sets the font weight of actor-attached notes

noteFontWeight

  • is required

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

  • cannot be null

  • defined in: Mermaid Config

noteFontWeight Type

any of the folllowing: string or number (Details)

noteFontWeight Default Value

The default value is:

json
400

noteAlign

This sets the text alignment of actor-attached notes

noteAlign

  • is required

  • Type: string

  • cannot be null

  • defined in: Mermaid Config

  • tsType: string | "left" | "center" | "right"

noteAlign Type

string

noteAlign Constraints

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

ValueExplanation
"left"
"center"
"right"

noteAlign Default Value

The default value is:

json
"center"

messageFontSize

This sets the font size of actor messages

messageFontSize

  • is required

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

  • cannot be null

  • defined in: Mermaid Config

messageFontSize Type

any of the folllowing: string or number (Details)

messageFontSize Default Value

The default value is:

json
16

messageFontFamily

This sets the font family of actor messages

messageFontFamily

messageFontFamily Type

string

messageFontFamily Default Value

The default value is:

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

messageFontWeight

This sets the font weight of actor messages

messageFontWeight

  • is required

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

  • cannot be null

  • defined in: Mermaid Config

messageFontWeight Type

any of the folllowing: string or number (Details)

messageFontWeight Default Value

The default value is:

json
400

wrap

This sets the auto-wrap state for the diagram

wrap

wrap Type

boolean

wrapPadding

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

wrapPadding

wrapPadding Type

number

wrapPadding Default Value

The default value is:

json
10

labelBoxWidth

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

labelBoxWidth

labelBoxWidth Type

number

labelBoxWidth Default Value

The default value is:

json
50

labelBoxHeight

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

labelBoxHeight

labelBoxHeight Type

number

labelBoxHeight Default Value

The default value is:

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

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

messageFont

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:

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

noteFont

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:

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

actorFont

actorFont Type

unknown (Font Calculator)

Definitions group FlowchartDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/FlowchartDiagramConfig" }
PropertyTypeRequiredNullableDefined by
titleTopMarginintegerRequiredcannot be nullMermaid Config
subGraphTitleMarginobjectRequiredcannot be nullMermaid Config
arrowMarkerAbsolutebooleanOptionalcannot be nullMermaid Config
diagramPaddingintegerRequiredcannot be nullMermaid Config
htmlLabelsbooleanRequiredcannot be nullMermaid Config
nodeSpacingintegerRequiredcannot be nullMermaid Config
rankSpacingintegerRequiredcannot be nullMermaid Config
curvestringRequiredcannot be nullMermaid Config
paddingnumberOptionalcannot be nullMermaid Config
defaultRendererstringRequiredcannot be nullMermaid Config
wrappingWidthnumberRequiredcannot be nullMermaid Config

titleTopMargin

Margin top for the text over the diagram

titleTopMargin

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:

json
25

subGraphTitleMargin

Defines a top/bottom margin for subgraph titles

subGraphTitleMargin

subGraphTitleMargin Type

object (Details)

subGraphTitleMargin Default Value

The default value is:

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

arrowMarkerAbsolute

arrowMarkerAbsolute

arrowMarkerAbsolute Type

boolean

diagramPadding

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

diagramPadding

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:

json
20

htmlLabels

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

htmlLabels

htmlLabels Type

boolean

htmlLabels Default Value

The default value is:

json
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

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:

json
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

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:

json
50

curve

Defines how mermaid renders curves for flowcharts.

curve

  • is required

  • Type: string

  • cannot be null

  • defined in: Mermaid Config

  • tsType: string | "basis" | "linear" | "cardinal"

curve Type

string

curve Constraints

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

ValueExplanation
"basis"
"linear"
"cardinal"

curve Default Value

The default value is:

json
"basis"

padding

Represents the padding between the labels and the shape

Only used in new experimental rendering.

padding

padding Type

number

padding Default Value

The default value is:

json
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

  • tsType: string | "dagre-d3" | "dagre-wrapper" | "elk"

defaultRenderer Type

string

defaultRenderer Constraints

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

ValueExplanation
"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:

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

wrappingWidth Type

number

wrappingWidth Default Value

The default value is:

json
200

Definitions group SankeyLinkColor

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/SankeyLinkColor" }
PropertyTypeRequiredNullableDefined by

Definitions group SankeyNodeAlignment

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/SankeyNodeAlignment" }
PropertyTypeRequiredNullableDefined by

Definitions group SankeyDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/SankeyDiagramConfig" }
PropertyTypeRequiredNullableDefined by
widthnumberOptionalcannot be nullMermaid Config
heightnumberOptionalcannot be nullMermaid Config
linkColorMergedOptionalcannot be nullMermaid Config
nodeAlignmentstringOptionalcannot be nullMermaid Config
useMaxWidthNot specifiedOptionalcannot be nullMermaid Config
showValuesNot specifiedOptionalcannot be nullMermaid Config
prefixstringOptionalcannot be nullMermaid Config
suffixstringOptionalcannot be nullMermaid Config

width

width

width Type

number

width Default Value

The default value is:

json
600

height

height

height Type

number

height Default Value

The default value is:

json
400

linkColor

The color of the links in the sankey diagram.

linkColor

linkColor Type

merged type (Details)

any of

linkColor Default Value

The default value is:

json
"gradient"

nodeAlignment

Controls the alignment of the Sankey diagrams.

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

nodeAlignment

nodeAlignment Type

string

nodeAlignment Constraints

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

ValueExplanation
"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:

json
"justify"

useMaxWidth

useMaxWidth

useMaxWidth Type

unknown

showValues

Toggle to display or hide values along with title.

showValues

showValues Type

unknown

showValues Default Value

The default value is:

json
true

prefix

The prefix to use for values

prefix

prefix Type

string

suffix

The suffix to use for values

suffix

suffix Type

string

Definitions group BlockDiagramConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/BlockDiagramConfig" }
PropertyTypeRequiredNullableDefined by
paddingNot specifiedOptionalcannot be nullMermaid Config

padding

padding

padding Type

unknown

padding Default Value

The default value is:

json
8

Definitions group FontCalculator

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/FontCalculator" }
PropertyTypeRequiredNullableDefined by

Definitions group FontConfig

Reference this group by using

json
{ "$ref": "https://mermaid-js.github.io/schemas/config.schema.json#/$defs/FontConfig" }
PropertyTypeRequiredNullableDefined by
fontSizeMultipleOptionalcannot be nullMermaid Config
fontFamilystringOptionalcannot be nullMermaid Config
fontWeightMultipleOptionalcannot be nullMermaid Config

fontSize

The font size to use

fontSize

fontSize Type

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

fontSize Default Value

The default value is:

json
14

fontFamily

The CSS font-family to use.

fontFamily

fontFamily Type

string

fontFamily Default Value

The default value is:

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

fontWeight

The font weight to use.

fontWeight

  • is optional

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

  • cannot be null

  • defined in: Mermaid Config

fontWeight Type

any of the folllowing: string or number (Details)

fontWeight Default Value

The default value is:

json
"normal"