Sequence Diagram Config Schema

txt

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

The object containing configurations specific for sequence diagrams

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

SequenceDiagramConfig Type

object (Sequence Diagram Config)

all of

Base Diagram Config

SequenceDiagramConfig Properties

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

arrowMarkerAbsolute

arrowMarkerAbsolute

is optional
Type: boolean
cannot be null
defined in: Mermaid Config

arrowMarkerAbsolute Type

boolean

hideUnusedParticipants

hideUnusedParticipants

is optional
Type: boolean
cannot be null
defined in: Mermaid Config

hideUnusedParticipants Type

boolean

activationWidth

Width of the activation rect

activationWidth

is required
Type: integer
cannot be null
defined in: Mermaid Config

activationWidth Type

integer

activationWidth Constraints

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

activationWidth Default Value

The default value is:

json

diagramMarginX

Margin to the right and left of the sequence diagram

diagramMarginX

is required
Type: integer
cannot be null
defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

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

diagramMarginX Default Value

The default value is:

json

diagramMarginY

Margin to the over and under the sequence diagram

diagramMarginY

is required
Type: integer
cannot be null
defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

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

diagramMarginY Default Value

The default value is:

json

actorMargin

Margin between actors

actorMargin

is required
Type: integer
cannot be null
defined in: Mermaid Config

actorMargin Type

integer

actorMargin Constraints

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

actorMargin Default Value

The default value is:

json

width

Width of actor boxes

width

is required
Type: integer
cannot be null
defined in: Mermaid Config

width Type

integer

width Constraints

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

width Default Value

The default value is:

json

height

Height of actor boxes

height

is required
Type: integer
cannot be null
defined in: Mermaid Config

height Type

integer

height Constraints

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

height Default Value

The default value is:

json

boxMargin

Margin around loop boxes

boxMargin

is required
Type: integer
cannot be null
defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

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

boxMargin Default Value

The default value is:

json

boxTextMargin

Margin around the text in loop/alt/opt boxes

boxTextMargin

is required
Type: integer
cannot be null
defined in: Mermaid Config

boxTextMargin Type

integer

boxTextMargin Constraints

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

boxTextMargin Default Value

The default value is:

json

noteMargin

Margin around notes

noteMargin

is required
Type: integer
cannot be null
defined in: Mermaid Config

noteMargin Type

integer

noteMargin Constraints

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

noteMargin Default Value

The default value is:

json

messageMargin

Space between messages.

messageMargin

is required
Type: integer
cannot be null
defined in: Mermaid Config

messageMargin Type

integer

messageMargin Constraints

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

messageMargin Default Value

The default value is:

json

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:

Value	Explanation
`"left"`
`"center"`
`"right"`

messageAlign Default Value

The default value is:

json

"center"

mirrorActors

Mirror actors under diagram

mirrorActors

is required
Type: boolean
cannot be null
defined in: Mermaid Config

mirrorActors Type

boolean

mirrorActors Default Value

The default value is:

json

true

forceMenus

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

forceMenus

is required
Type: boolean
cannot be null
defined in: Mermaid Config

forceMenus Type

boolean

bottomMarginAdj

Prolongs the edge of the diagram downwards.

Depending on css styling this might need adjustment.

bottomMarginAdj

is required
Type: integer
cannot be null
defined in: Mermaid Config

bottomMarginAdj Type

integer

bottomMarginAdj Constraints

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

bottomMarginAdj Default Value

The default value is:

json

rightAngles

Curved Arrows become Right Angles

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

rightAngles

is required
Type: boolean
cannot be null
defined in: Mermaid Config

rightAngles Type

boolean

showSequenceNumbers

This will show the node numbers

showSequenceNumbers

is required
Type: boolean
cannot be null
defined in: Mermaid Config

showSequenceNumbers Type

boolean

actorFontSize

This sets the font size of the actor's description

actorFontSize

is required
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

actorFontSize Type

any of the following: string or number (Details)

actorFontSize Default Value

The default value is:

json

actorFontFamily

This sets the font family of the actor's description

actorFontFamily

is required
Type: string
cannot be null
defined in: Mermaid Config

actorFontFamily Type

string

actorFontFamily Default Value

The default value is:

json

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

actorFontWeight

This sets the font weight of the actor's description

actorFontWeight

is required
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

actorFontWeight Type

any of the following: string or number (Details)

actorFontWeight Default Value

The default value is:

json

noteFontSize

This sets the font size of actor-attached notes

noteFontSize

is required
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

noteFontSize Type

any of the following: string or number (Details)

noteFontSize Default Value

The default value is:

json

noteFontFamily

This sets the font family of actor-attached notes

noteFontFamily

is required
Type: string
cannot be null
defined in: Mermaid Config

noteFontFamily Type

string

noteFontFamily Default Value

The default value is:

json

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

noteFontWeight

This sets the font weight of actor-attached notes

noteFontWeight

is required
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

noteFontWeight Type

any of the following: string or number (Details)

noteFontWeight Default Value

The default value is:

json

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:

Value	Explanation
`"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 following: string or number (Details)
cannot be null
defined in: Mermaid Config

messageFontSize Type

any of the following: string or number (Details)

messageFontSize Default Value

The default value is:

json

messageFontFamily

This sets the font family of actor messages

messageFontFamily

is required
Type: string
cannot be null
defined in: Mermaid Config

messageFontFamily Type

string

messageFontFamily Default Value

The default value is:

json

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

messageFontWeight

This sets the font weight of actor messages

messageFontWeight

is required
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

messageFontWeight Type

any of the following: string or number (Details)

messageFontWeight Default Value

The default value is:

json

wrap

This sets the auto-wrap state for the diagram

wrap

is optional
Type: boolean
cannot be null
defined in: Mermaid Config

wrap Type

boolean

wrapPadding

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

wrapPadding

is optional
Type: number
cannot be null
defined in: Mermaid Config

wrapPadding Type

number

wrapPadding Default Value

The default value is:

json

labelBoxWidth

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

labelBoxWidth

is optional
Type: number
cannot be null
defined in: Mermaid Config

labelBoxWidth Type

number

labelBoxWidth Default Value

The default value is:

json

labelBoxHeight

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

labelBoxHeight

is optional
Type: number
cannot be null
defined in: Mermaid Config

labelBoxHeight Type

number

labelBoxHeight Default Value

The default value is:

json

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

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

messageFont Type

unknown (Font Calculator)

noteFont

JavaScript function that returns a FontConfig.

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

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

javascript

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

noteFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

noteFont Type

unknown (Font Calculator)

actorFont

JavaScript function that returns a FontConfig.

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

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

javascript

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

actorFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

actorFont Type

unknown (Font Calculator)

Sequence Diagram Config Schema ​

SequenceDiagramConfig Type ​

SequenceDiagramConfig Properties ​

arrowMarkerAbsolute ​

arrowMarkerAbsolute Type ​

hideUnusedParticipants ​

hideUnusedParticipants Type ​

activationWidth ​

activationWidth Type ​

activationWidth Constraints ​

activationWidth Default Value ​

diagramMarginX ​

diagramMarginX Type ​

diagramMarginX Constraints ​

diagramMarginX Default Value ​

diagramMarginY ​

diagramMarginY Type ​

diagramMarginY Constraints ​

diagramMarginY Default Value ​

actorMargin ​

actorMargin Type ​

actorMargin Constraints ​

actorMargin Default Value ​

width ​

width Type ​

width Constraints ​

width Default Value ​

height ​

height Type ​

height Constraints ​

height Default Value ​

boxMargin ​

boxMargin Type ​

boxMargin Constraints ​

boxMargin Default Value ​

boxTextMargin ​

boxTextMargin Type ​

boxTextMargin Constraints ​

boxTextMargin Default Value ​

noteMargin ​

noteMargin Type ​

noteMargin Constraints ​

noteMargin Default Value ​

messageMargin ​

messageMargin Type ​

messageMargin Constraints ​

messageMargin Default Value ​

messageAlign ​

messageAlign Type ​

messageAlign Constraints ​

messageAlign Default Value ​

mirrorActors ​

mirrorActors Type ​

mirrorActors Default Value ​

forceMenus ​

forceMenus Type ​

bottomMarginAdj ​

bottomMarginAdj Type ​

bottomMarginAdj Constraints ​

bottomMarginAdj Default Value ​

rightAngles ​

rightAngles Type ​

showSequenceNumbers ​

showSequenceNumbers Type ​

actorFontSize ​

actorFontSize Type ​

actorFontSize Default Value ​

actorFontFamily ​

actorFontFamily Type ​

actorFontFamily Default Value ​

actorFontWeight ​

actorFontWeight Type ​

actorFontWeight Default Value ​

noteFontSize ​

noteFontSize Type ​

noteFontSize Default Value ​

noteFontFamily ​

noteFontFamily Type ​

noteFontFamily Default Value ​

noteFontWeight ​

Sequence Diagram Config Schema

SequenceDiagramConfig Type

SequenceDiagramConfig Properties

arrowMarkerAbsolute

arrowMarkerAbsolute Type

hideUnusedParticipants

hideUnusedParticipants Type

activationWidth

activationWidth Type

activationWidth Constraints

activationWidth Default Value

diagramMarginX

diagramMarginX Type

diagramMarginX Constraints

diagramMarginX Default Value

diagramMarginY

diagramMarginY Type

diagramMarginY Constraints

diagramMarginY Default Value

actorMargin

actorMargin Type

actorMargin Constraints

actorMargin Default Value

width

width Type

width Constraints

width Default Value

height

height Type

height Constraints

height Default Value

boxMargin

boxMargin Type

boxMargin Constraints

boxMargin Default Value

boxTextMargin

boxTextMargin Type

boxTextMargin Constraints

boxTextMargin Default Value

noteMargin

noteMargin Type

noteMargin Constraints

noteMargin Default Value

messageMargin

messageMargin Type

messageMargin Constraints

messageMargin Default Value

messageAlign

messageAlign Type

messageAlign Constraints

messageAlign Default Value

mirrorActors

mirrorActors Type

mirrorActors Default Value

forceMenus

forceMenus Type

bottomMarginAdj

bottomMarginAdj Type

bottomMarginAdj Constraints

bottomMarginAdj Default Value

rightAngles

rightAngles Type

showSequenceNumbers

showSequenceNumbers Type

actorFontSize

actorFontSize Type

actorFontSize Default Value

actorFontFamily

actorFontFamily Type

actorFontFamily Default Value

actorFontWeight

actorFontWeight Type

actorFontWeight Default Value

noteFontSize

noteFontSize Type

noteFontSize Default Value

noteFontFamily

noteFontFamily Type

noteFontFamily Default Value

noteFontWeight