シーケンス図の設定スキーマ

https://mermaid.dokyumento.jp/schemas/config.schema.json#/$defs/SequenceDiagramConfig

シーケンス図に特有の設定を含むオブジェクト

抽象的	拡張可能	ステータス	識別可能	カスタムプロパティ	追加のプロパティ	アクセス制限	定義元
インスタンス化可能	いいえ	不明なステータス	いいえ	禁止	許可	なし	config.schema.json*

SequenceDiagramConfig タイプ

object (シーケンス図の設定)

すべて

• ベース図設定

SequenceDiagramConfig プロパティ

プロパティ	タイプ	必須	Null 許容	定義元
arrowMarkerAbsolute	boolean	オプション	null にすることはできません	Mermaid 設定
hideUnusedParticipants	boolean	オプション	null にすることはできません	Mermaid 設定
activationWidth	integer	必須	null にすることはできません	Mermaid 設定
diagramMarginX	integer	必須	null にすることはできません	Mermaid 設定
diagramMarginY	integer	必須	null にすることはできません	Mermaid 設定
actorMargin	integer	必須	null にすることはできません	Mermaid 設定
width	integer	必須	null にすることはできません	Mermaid 設定
height	integer	必須	null にすることはできません	Mermaid 設定
boxMargin	integer	必須	null にすることはできません	Mermaid 設定
boxTextMargin	integer	必須	null にすることはできません	Mermaid 設定
noteMargin	integer	必須	null にすることはできません	Mermaid 設定
messageMargin	integer	必須	null にすることはできません	Mermaid 設定
messageAlign	string	必須	null にすることはできません	Mermaid 設定
mirrorActors	boolean	必須	null にすることはできません	Mermaid 設定
forceMenus	boolean	必須	null にすることはできません	Mermaid 設定
bottomMarginAdj	integer	必須	null にすることはできません	Mermaid 設定
rightAngles	boolean	必須	null にすることはできません	Mermaid 設定
showSequenceNumbers	boolean	必須	null にすることはできません	Mermaid 設定
actorFontSize	Multiple	必須	null にすることはできません	Mermaid 設定
actorFontFamily	string	必須	null にすることはできません	Mermaid 設定
actorFontWeight	Multiple	必須	null にすることはできません	Mermaid 設定
noteFontSize	Multiple	必須	null にすることはできません	Mermaid 設定
noteFontFamily	string	必須	null にすることはできません	Mermaid 設定
noteFontWeight	Multiple	必須	null にすることはできません	Mermaid 設定
noteAlign	string	必須	null にすることはできません	Mermaid 設定
messageFontSize	Multiple	必須	null にすることはできません	Mermaid 設定
messageFontFamily	string	必須	null にすることはできません	Mermaid 設定
messageFontWeight	Multiple	必須	null にすることはできません	Mermaid 設定
wrap	boolean	オプション	null にすることはできません	Mermaid 設定
wrapPadding	number	オプション	null にすることはできません	Mermaid 設定
labelBoxWidth	number	オプション	null にすることはできません	Mermaid 設定
labelBoxHeight	number	オプション	null にすることはできません	Mermaid 設定
messageFont	未指定	オプション	null にすることはできません	Mermaid 設定
noteFont	未指定	オプション	null にすることはできません	Mermaid 設定
actorFont	未指定	オプション	null にすることはできません	Mermaid 設定

arrowMarkerAbsolute

arrowMarkerAbsolute

• オプションです

• タイプ: boolean

• null にすることはできません

• 定義元: Mermaid 設定

arrowMarkerAbsolute タイプ

boolean

hideUnusedParticipants

hideUnusedParticipants

• オプションです

• タイプ: boolean

• null にすることはできません

• 定義元: Mermaid 設定

hideUnusedParticipants タイプ

boolean

activationWidth

アクティベーションの長方形の幅

activationWidth

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

activationWidth タイプ

integer

activationWidth の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

activationWidth のデフォルト値

デフォルト値は

10

diagramMarginX

シーケンス図の左右の余白

diagramMarginX

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

diagramMarginX タイプ

integer

diagramMarginX の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

diagramMarginX のデフォルト値

デフォルト値は

50

diagramMarginY

シーケンス図の上と下の余白

diagramMarginY

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

diagramMarginY タイプ

integer

diagramMarginY の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

diagramMarginY のデフォルト値

デフォルト値は

10

actorMargin

アクター間の余白

actorMargin

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

actorMargin タイプ

integer

actorMargin の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

actorMargin のデフォルト値

デフォルト値は

50

width

アクターボックスの幅

width

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

width タイプ

integer

width の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

width のデフォルト値

デフォルト値は

150

height

アクターボックスの高さ

height

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

height タイプ

integer

height の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

height のデフォルト値

デフォルト値は

50

boxMargin

ループボックスの周りの余白

boxMargin

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

boxMargin タイプ

integer

boxMargin の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

boxMargin のデフォルト値

デフォルト値は

10

boxTextMargin

ループ/alt/opt ボックス内のテキストの周りの余白

boxTextMargin

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

boxTextMargin タイプ

integer

boxTextMargin の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

boxTextMargin のデフォルト値

デフォルト値は

5

noteMargin

ノートの周りの余白

noteMargin

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

noteMargin タイプ

integer

noteMargin の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

noteMargin のデフォルト値

デフォルト値は

10

messageMargin

メッセージ間のスペース。

messageMargin

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid 設定

messageMargin タイプ

integer

messageMargin の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

messageMargin のデフォルト値

デフォルト値は

35

messageAlign

複数行メッセージの配置

messageAlign

• 必須です

• タイプ: string

• null にすることはできません

• 定義元: Mermaid 設定

messageAlign の種類

string

messageAlign の制約

enum: このプロパティの値は、以下のいずれかの値と等しくなければなりません

値	説明
"left"
"center"
"right"

messageAlign のデフォルト値

デフォルト値は

"center"

mirrorActors

ダイアグラムの下にアクターをミラー表示します

mirrorActors

• 必須です

• タイプ: boolean

• null にすることはできません

• 定義元: Mermaid Config

mirrorActors の種類

boolean

mirrorActors のデフォルト値

デフォルト値は

true

forceMenus

アクターのポップアップメニューを常に表示するように強制します（E2Eテストをサポートするため）。

forceMenus

• 必須です

• タイプ: boolean

• null にすることはできません

• 定義元: Mermaid Config

forceMenus の種類

boolean

bottomMarginAdj

ダイアグラムの下端を延長します。

CSSスタイルによっては調整が必要になる場合があります。

bottomMarginAdj

• 必須です

• タイプ: integer

• null にすることはできません

• 定義元: Mermaid Config

bottomMarginAdj の種類

integer

bottomMarginAdj の制約

最小値: この数値の値は、次の値以上でなければなりません: 0

bottomMarginAdj のデフォルト値

デフォルト値は

1

rightAngles

曲線矢印を直角にします

これにより、同じノードで開始および終了する矢印が、曲線ではなく直角として表示されます。

rightAngles

• 必須です

• タイプ: boolean

• null にすることはできません

• 定義元: Mermaid Config

rightAngles の種類

boolean

showSequenceNumbers

これにより、ノード番号が表示されます

showSequenceNumbers

• 必須です

• タイプ: boolean

• null にすることはできません

• 定義元: Mermaid Config

showSequenceNumbers の種類

boolean

actorFontSize

アクターの説明のフォントサイズを設定します

actorFontSize

• 必須です

• 種類: string または number のいずれか (詳細)

• null にすることはできません

• 定義元: Mermaid Config

actorFontSize の種類

string または number のいずれか (詳細)

actorFontSize のデフォルト値

デフォルト値は

14

actorFontFamily

アクターの説明のフォントファミリーを設定します

actorFontFamily

• 必須です

• タイプ: string

• null にすることはできません

• 定義元: Mermaid Config

actorFontFamily の種類

string

actorFontFamily のデフォルト値

デフォルト値は

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

actorFontWeight

アクターの説明のフォントの太さを設定します

actorFontWeight

• 必須です

• 種類: string または number のいずれか (詳細)

• null にすることはできません

• 定義元: Mermaid Config

actorFontWeight の種類

string または number のいずれか (詳細)

actorFontWeight のデフォルト値

デフォルト値は

400

noteFontSize

アクターに付随する注釈のフォントサイズを設定します

noteFontSize

• 必須です

• 種類: string または number のいずれか (詳細)

• null にすることはできません

• 定義元: Mermaid Config

noteFontSize の種類

string または number のいずれか (詳細)

noteFontSize のデフォルト値

デフォルト値は

14

noteFontFamily

アクターに付随する注釈のフォントファミリーを設定します

noteFontFamily

• 必須です

• タイプ: string

• null にすることはできません

• 定義元: Mermaid Config

noteFontFamily の種類

string

noteFontFamily のデフォルト値

デフォルト値は

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

noteFontWeight

アクターに付随する注釈のフォントの太さを設定します

noteFontWeight

• 必須です

• 種類: string または number のいずれか (詳細)

• null にすることはできません

• 定義元: Mermaid Config

noteFontWeight の種類

string または number のいずれか (詳細)

noteFontWeight のデフォルト値

デフォルト値は

400

noteAlign

アクターに付随する注釈のテキスト配置を設定します

noteAlign

• 必須です

• タイプ: string

• null にすることはできません

• 定義元: Mermaid Config

noteAlign の種類

string

noteAlign の制約

enum: このプロパティの値は、以下のいずれかの値と等しくなければなりません

値	説明
"left"
"center"
"right"

noteAlign のデフォルト値

デフォルト値は

"center"

messageFontSize

アクターメッセージのフォントサイズを設定します

messageFontSize

• 必須です

• 種類: string または number のいずれか (詳細)

• null にすることはできません

• 定義元: Mermaid Config

messageFontSize の種類

string または number のいずれか (詳細)

messageFontSize のデフォルト値

デフォルト値は

16

messageFontFamily

アクターメッセージのフォントファミリーを設定します

messageFontFamily

• 必須です

• タイプ: string

• null にすることはできません

• 定義元: Mermaid Config

messageFontFamily の種類

string

messageFontFamily のデフォルト値

デフォルト値は

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

messageFontWeight

アクターメッセージのフォントの太さを設定します

messageFontWeight

• 必須です

• 種類: string または number のいずれか (詳細)

• null にすることはできません

• 定義元: Mermaid Config

messageFontWeight の種類

string または number のいずれか (詳細)

messageFontWeight のデフォルト値

デフォルト値は

400

wrap

ダイアグラムの自動折り返し状態を設定します

wrap

• オプションです

• タイプ: boolean

• null にすることはできません

• 定義元: Mermaid Config

wrap の種類

boolean

wrapPadding

ダイアグラムの自動折り返しパディングを設定します（両端のみ）

wrapPadding

• オプションです

• 種類: number

• null にすることはできません

• 定義元: Mermaid Config

wrapPadding の種類

number

wrapPadding のデフォルト値

デフォルト値は

10

labelBoxWidth

ループボックス（loop、alt、opt、par）の幅を設定します

labelBoxWidth

• オプションです

• 種類: number

• null にすることはできません

• 定義元: Mermaid Config

labelBoxWidth の種類

number

labelBoxWidth のデフォルト値

デフォルト値は

50

labelBoxHeight

ループボックス（loop、alt、opt、par）の高さを設定します

labelBoxHeight

• オプションです

• 種類: number

• null にすることはできません

• 定義元: Mermaid Config

labelBoxHeight の種類

number

labelBoxHeight のデフォルト値

デフォルト値は

20

messageFont

FontConfig を返す JavaScript 関数。

デフォルトでは、適切な *FontSize、*FontFamily、*FontWeight の値を返します。

たとえば、boundaryFont というフォント計算機は次のように定義できます。

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

messageFont

• オプションです

• 種類: 不明 (フォント計算機)

• null にすることはできません

• 定義元: Mermaid Config

• tsType: () => Partial<FontConfig>

messageFont の種類

不明 (フォント計算機)

noteFont

FontConfig を返す JavaScript 関数。

デフォルトでは、適切な *FontSize、*FontFamily、*FontWeight の値を返します。

たとえば、boundaryFont というフォント計算機は次のように定義できます。

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

noteFont

• オプションです

• タイプ: 不明 (フォント計算機)

• null にすることはできません

• 定義元: Mermaid Config

• tsType: () => Partial<FontConfig>

noteFont タイプ

不明 (フォント計算機)

actorFont

FontConfig を返す JavaScript 関数。

デフォルトでは、適切な *FontSize、*FontFamily、*FontWeight の値を返します。

たとえば、boundaryFont というフォント計算機は次のように定義できます。

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

actorFont

• オプションです

• タイプ: 不明 (フォント計算機)

• null にすることはできません

• 定義元: Mermaid Config

• tsType: () => Partial<FontConfig>

actorFont タイプ

不明 (フォント計算機)