インターフェース: MermaidConfig
mermaid.MermaidConfig
プロパティ
altFontFamily
• オプション
altFontFamily: string
定義場所
packages/mermaid/src/config.type.ts:122
architecture
• オプション
architecture: ArchitectureDiagramConfig
定義場所
packages/mermaid/src/config.type.ts:194
arrowMarkerAbsolute
• オプション
arrowMarkerAbsolute: boolean
HTMLコード内の矢印マーカーが絶対パスかアンカーかを制御します。これは、baseタグ設定を使用している場合に重要になります。
定義場所
packages/mermaid/src/config.type.ts:141
block
• オプション
block: BlockDiagramConfig
定義場所
packages/mermaid/src/config.type.ts:201
c4
• オプション
c4: C4DiagramConfig
定義場所
packages/mermaid/src/config.type.ts:198
class
• オプション
class: ClassDiagramConfig
定義場所
packages/mermaid/src/config.type.ts:187
darkMode
• オプション
darkMode: boolean
定義場所
packages/mermaid/src/config.type.ts:113
deterministicIDSeed
• オプション
deterministicIDSeed: string
このオプションは、決定性IDのためのオプションのシードです。 undefined
に設定されているが deterministicIds が true
の場合、単純な数値イテレータが使用されます。この属性を静的文字列に基づいてシードを設定できます。
定義場所
packages/mermaid/src/config.type.ts:181
deterministicIds
• オプション
deterministicIds: boolean
このオプションは、SVG内のノードの生成されたIDがランダムに生成されるか、シードに基づいて生成されるかを制御します。false
に設定すると、IDは現在の日付に基づいて生成されるため、決定的ではありません。これがデフォルトの動作です。
これは、ファイルがソース管理(例:git)にチェックインされており、コンテンツが変更されない限り変更されないようにする必要がある場合に重要になります。
定義場所
packages/mermaid/src/config.type.ts:174
dompurifyConfig
• オプション
dompurifyConfig: Config
定義場所
packages/mermaid/src/config.type.ts:202
elk
• オプション
elk: Object
型宣言
名前 | 型 | 説明 |
---|---|---|
cycleBreakingStrategy? | "GREEDY" | "DEPTH_FIRST" | "INTERACTIVE" | "MODEL_ORDER" | "GREEDY_MODEL_ORDER" | この戦略は、グラフ内のサイクルを見つけ、ループを解除するために調整が必要なエッジを決定する方法を決定します。 |
mergeEdges? | boolean | エッジが都合の良い場所でパスを共有できるようにする、Elk固有のオプションです。これにより、見栄えの良い図を作成できますが、図を読みにくくする可能性もあります。 |
nodePlacementStrategy? | "SIMPLE" | "NETWORK_SIMPLEX" | "LINEAR_SEGMENTS" | "BRANDES_KOEPF" | ノードの配置方法に影響を与えるElk固有のオプション。 |
定義場所
packages/mermaid/src/config.type.ts:91
er
• オプション
er: ErDiagramConfig
定義場所
packages/mermaid/src/config.type.ts:189
flowchart
• オプション
flowchart: FlowchartDiagramConfig
定義場所
packages/mermaid/src/config.type.ts:182
fontFamily
• オプション
fontFamily: string
レンダリングされた図で使用するフォントを指定します。任意のCSS font-family
が使用できます。 https://developer.mozilla.org/en-US/docs/Web/CSS/font-family を参照してください
定義場所
packages/mermaid/src/config.type.ts:121
fontSize
• オプション
fontSize: number
定義場所
packages/mermaid/src/config.type.ts:204
forceLegacyMathML
• オプション
forceLegacyMathML: boolean
このオプションは、MermaidがMathMLのレンダリングのためにKaTeX独自のスタイルシートに依存するように強制します。OSフォントとブラウザのMathML実装の違いにより、一貫したレンダリングが重要な場合は、このオプションをお勧めします。trueに設定すると、legacyMathMLは無視されます。
定義場所
packages/mermaid/src/config.type.ts:163
gantt
• オプション
gantt: GanttDiagramConfig
定義場所
packages/mermaid/src/config.type.ts:184
gitGraph
• オプション
gitGraph: GitGraphDiagramConfig
定義場所
packages/mermaid/src/config.type.ts:197
handDrawnSeed
• オプション
handDrawnSeed: number
手書き風の外観を使用する際に使用するシードを定義します。これは自動テストにとって重要です。シードがないと、常に違いが見つかるためです。デフォルト値は0で、ランダムなシードが与えられます。
定義場所
packages/mermaid/src/config.type.ts:76
htmlLabels
• オプション
htmlLabels: boolean
定義場所:
packages/mermaid/src/config.type.ts:114
journey
• オプション
journey: JourneyDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:185
kanban
• オプション
kanban: KanbanDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:196
layout
• オプション
layout: string
ダイアグラムのレンダリングに使用するレイアウトアルゴリズムを定義します。
定義場所:
packages/mermaid/src/config.type.ts:81
legacyMathML
• オプション
legacyMathML: boolean
このオプションは、Mermaidが、MathML実装を持たないブラウザのために、KaTeXスタイルシートを含めることを期待できるかどうかを指定します。このオプションが無効で、MathMLがサポートされていない場合、数式は警告に置き換えられます。このオプションが有効で、MathMLがサポートされていない場合、MermaidはKaTeXのレガシーレンダリングにフォールバックします。
定義場所:
packages/mermaid/src/config.type.ts:156
logLevel
• オプション
logLevel: 0
| 2
| 1
| "trace"
| "debug"
| "info"
| "warn"
| "error"
| "fatal"
| 3
| 4
| 5
このオプションは、Mermaidで使用されるログの量を決定します。
定義場所:
packages/mermaid/src/config.type.ts:127
look
• オプション
look: "classic"
| "handDrawn"
ダイアグラムに使用するメインのルックを定義します。
定義場所:
packages/mermaid/src/config.type.ts:71
markdownAutoWrap
• オプション
markdownAutoWrap: boolean
定義場所:
packages/mermaid/src/config.type.ts:205
maxEdges
• オプション
maxEdges: number
グラフに描画できるエッジの最大数を定義します。
定義場所:
packages/mermaid/src/config.type.ts:90
maxTextSize
• オプション
maxTextSize: number
ユーザーのテキストダイアグラムで許可される最大サイズ
定義場所:
packages/mermaid/src/config.type.ts:85
mindmap
• オプション
mindmap: MindmapDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:195
packet
• オプション
packet: PacketDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:200
pie
• オプション
pie: PieDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:190
quadrantChart
• オプション
quadrantChart: QuadrantChartConfig
定義場所:
packages/mermaid/src/config.type.ts:191
requirement
• オプション
requirement: RequirementDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:193
sankey
• オプション
sankey: SankeyDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:199
secure
• オプション
secure: string
[]
このオプションは、どのcurrentConfig
キーを安全と見なし、mermaid.initialize
への呼び出しによってのみ変更できるようにするかを制御します。これにより、悪意のあるグラフディレクティブがサイトのデフォルトのセキュリティをオーバーライドするのを防ぎます。
定義場所:
packages/mermaid/src/config.type.ts:148
securityLevel
• オプション
securityLevel: "strict"
| "loose"
| "antiscript"
| "sandbox"
解析されたダイアグラムの信頼レベル
定義場所:
packages/mermaid/src/config.type.ts:131
sequence
• オプション
sequence: SequenceDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:183
startOnLoad
• オプション
startOnLoad: boolean
ページ読み込み時にMermaidを開始するかどうかを指定します
定義場所:
packages/mermaid/src/config.type.ts:135
state
• オプション
state: StateDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:188
suppressErrorRendering
• オプション
suppressErrorRendering: boolean
DOMへの「構文エラー」ダイアグラムの挿入を抑制します。これは、アプリケーションで構文エラーを処理する方法を制御したい場合に役立ちます。
定義場所:
packages/mermaid/src/config.type.ts:211
theme
• オプション
theme: "default"
| "base"
| "dark"
| "forest"
| "neutral"
| "null"
テーマ、CSSスタイルシート。themeCSS
を使用してこの値をオーバーライドすることもできます。
定義場所:
packages/mermaid/src/config.type.ts:64
themeCSS
• オプション
themeCSS: string
定義場所:
packages/mermaid/src/config.type.ts:66
themeVariables
• オプション
themeVariables: any
定義場所:
packages/mermaid/src/config.type.ts:65
timeline
• オプション
timeline: TimelineDiagramConfig
定義場所:
packages/mermaid/src/config.type.ts:186
wrap
• オプション
wrap: boolean
定義場所:
packages/mermaid/src/config.type.ts:203
xyChart
• オプション
xyChart: XYChartConfig