Skip to content

Railroad Diagram Config Schema ​

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

Configuration for Railroad (Syntax) Diagrams

AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedNoUnknown statusNoForbiddenAllowednoneconfig.schema.json*

RailroadDiagramConfig Type ​

object (Railroad Diagram Config)

all of

RailroadDiagramConfig Properties ​

PropertyTypeRequiredNullableDefined by
compactModebooleanOptionalcannot be nullMermaid Config
paddingnumberOptionalcannot be nullMermaid Config
verticalSeparationnumberOptionalcannot be nullMermaid Config
horizontalSeparationnumberOptionalcannot be nullMermaid Config
arcRadiusnumberOptionalcannot be nullMermaid Config
fontSizenumberOptionalcannot be nullMermaid Config
fontFamilystringOptionalcannot be nullMermaid Config
terminalFillstringOptionalcannot be nullMermaid Config
terminalStrokestringOptionalcannot be nullMermaid Config
terminalTextColorstringOptionalcannot be nullMermaid Config
nonTerminalFillstringOptionalcannot be nullMermaid Config
nonTerminalStrokestringOptionalcannot be nullMermaid Config
nonTerminalTextColorstringOptionalcannot be nullMermaid Config
lineColorstringOptionalcannot be nullMermaid Config
strokeWidthnumberOptionalcannot be nullMermaid Config
markerFillstringOptionalcannot be nullMermaid Config
commentFillstringOptionalcannot be nullMermaid Config
commentStrokestringOptionalcannot be nullMermaid Config
commentTextColorstringOptionalcannot be nullMermaid Config
specialFillstringOptionalcannot be nullMermaid Config
specialStrokestringOptionalcannot be nullMermaid Config
ruleNameColorstringOptionalcannot be nullMermaid Config
showMarkersbooleanOptionalcannot be nullMermaid Config
markerRadiusnumberOptionalcannot be nullMermaid Config

compactMode ​

Use compact layout mode

compactMode

compactMode Type ​

boolean

compactMode Default Value ​

The default value is:

json
false

padding ​

Padding around elements

padding

padding Type ​

number

padding Constraints ​

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

padding Default Value ​

The default value is:

json
10

verticalSeparation ​

Vertical separation between elements

verticalSeparation

verticalSeparation Type ​

number

verticalSeparation Constraints ​

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

verticalSeparation Default Value ​

The default value is:

json
8

horizontalSeparation ​

Horizontal separation between elements

horizontalSeparation

horizontalSeparation Type ​

number

horizontalSeparation Constraints ​

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

horizontalSeparation Default Value ​

The default value is:

json
10

arcRadius ​

Radius for curved paths

arcRadius

arcRadius Type ​

number

arcRadius Constraints ​

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

arcRadius Default Value ​

The default value is:

json
10

fontSize ​

Font size for text

fontSize

fontSize Type ​

number

fontSize Constraints ​

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

fontSize Default Value ​

The default value is:

json
14

fontFamily ​

Font family for text

fontFamily

fontFamily Type ​

string

fontFamily Default Value ​

The default value is:

json
"monospace"

terminalFill ​

Fill color for terminal elements

terminalFill

terminalFill Type ​

string

terminalFill Default Value ​

The default value is:

json
"#FFFFC0"

terminalStroke ​

Stroke color for terminal elements

terminalStroke

terminalStroke Type ​

string

terminalStroke Default Value ​

The default value is:

json
"#000000"

terminalTextColor ​

Text color for terminal elements

terminalTextColor

terminalTextColor Type ​

string

terminalTextColor Default Value ​

The default value is:

json
"#000000"

nonTerminalFill ​

Fill color for non-terminal elements

nonTerminalFill

nonTerminalFill Type ​

string

nonTerminalFill Default Value ​

The default value is:

json
"#FFFFFF"

nonTerminalStroke ​

Stroke color for non-terminal elements

nonTerminalStroke

nonTerminalStroke Type ​

string

nonTerminalStroke Default Value ​

The default value is:

json
"#000000"

nonTerminalTextColor ​

Text color for non-terminal elements

nonTerminalTextColor

nonTerminalTextColor Type ​

string

nonTerminalTextColor Default Value ​

The default value is:

json
"#000000"

lineColor ​

Color for connection lines

lineColor

lineColor Type ​

string

lineColor Default Value ​

The default value is:

json
"#000000"

strokeWidth ​

Width of strokes

strokeWidth

strokeWidth Type ​

number

strokeWidth Constraints ​

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

strokeWidth Default Value ​

The default value is:

json
2

markerFill ​

Fill color for start/end markers

markerFill

markerFill Type ​

string

markerFill Default Value ​

The default value is:

json
"#000000"

commentFill ​

Fill color for comments

commentFill

commentFill Type ​

string

commentFill Default Value ​

The default value is:

json
"#E8E8E8"

commentStroke ​

Stroke color for comments

commentStroke

commentStroke Type ​

string

commentStroke Default Value ​

The default value is:

json
"#888888"

commentTextColor ​

Text color for comments

commentTextColor

commentTextColor Type ​

string

commentTextColor Default Value ​

The default value is:

json
"#666666"

specialFill ​

Fill color for special sequences

specialFill

specialFill Type ​

string

specialFill Default Value ​

The default value is:

json
"#F0E0FF"

specialStroke ​

Stroke color for special sequences

specialStroke

specialStroke Type ​

string

specialStroke Default Value ​

The default value is:

json
"#8800CC"

ruleNameColor ​

Color for rule names

ruleNameColor

ruleNameColor Type ​

string

ruleNameColor Default Value ​

The default value is:

json
"#000066"

showMarkers ​

Show start/end markers

showMarkers

showMarkers Type ​

boolean

showMarkers Default Value ​

The default value is:

json
true

markerRadius ​

Radius of start/end markers

markerRadius

markerRadius Type ​

number

markerRadius Constraints ​

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

markerRadius Default Value ​

The default value is:

json
5
Opens in mermaid.ai