インターフェース: Mermaid
mermaid.Mermaid
プロパティ
contentLoaded
• contentLoaded: () => void
型宣言
▸ (): void
##contentLoaded ページが読み込まれたときに呼び出されるコールバック関数。この関数は、mermaidレンダリングの設定を取得し、ページ上のmermaid図をレンダリングするためにinitを呼び出します。
戻り値
void
定義場所
packages/mermaid/src/mermaid.ts:436
detectType
• detectType: (text: string, config?: MermaidConfig) => string
型宣言
▸ (text, config?): string
グラフテキストのタイプを検出します。
%%initディレクティブの存在を考慮します。
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
text | string | グラフを定義するテキスト。例：mermaid %%{initialize: {"startOnLoad": true, logLevel: "fatal" }}%% graph LR a-->b b-->c c-->d d-->e e-->f f-->g g-->h |
config? | MermaidConfig | mermaidの設定。 |
戻り値
string
グラフ定義キー
定義場所
packages/mermaid/src/mermaid.ts:438
init
• init: (config?: MermaidConfig, nodes?: string | HTMLElement | NodeListOf<HTMLElement>, callback?: (id: string) => unknown) => Promise<void>
非推奨
initializeとrunを代わりに使用してください。
型宣言
▸ (config?, nodes?, callback?): Promise<void>
パラメーター
| 名前 | 型 |
|---|---|
config? | MermaidConfig |
nodes? | string | HTMLElement | NodeListOf<HTMLElement> |
callback? | (id: string) => unknown |
戻り値
Promise<void>
定義場所
packages/mermaid/src/mermaid.ts:431
initialize
• initialize: (config: MermaidConfig) => void
型宣言
▸ (config): void
mermaidの設定を行うために使用されます。この関数は、run関数の前に呼び出す必要があります。
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
config | MermaidConfig | mermaidの設定オブジェクト。 |
戻り値
void
定義場所
packages/mermaid/src/mermaid.ts:435
mermaidAPI
• mermaidAPI: Readonly<{ defaultConfig: MermaidConfig = configApi.defaultConfig; getConfig: () => MermaidConfig = configApi.getConfig; getDiagramFromText: (text: string, metadata: Pick<DiagramMetadata, "title">) => Promise<Diagram> ; getSiteConfig: () => MermaidConfig = configApi.getSiteConfig; globalReset: () => void ; initialize: (userOptions: MermaidConfig) => void ; parse: (text: string, parseOptions: ParseOptions & { suppressErrors: true }) => Promise<ParseResult | false>(text: string, parseOptions?: ParseOptions) => Promise<ParseResult> ; render: (id: string, text: string, svgContainingElement?: Element) => Promise<RenderResult> ; reset: () => void ; setConfig: (conf: MermaidConfig) => MermaidConfig = configApi.setConfig; updateSiteConfig: (conf: MermaidConfig) => MermaidConfig = configApi.updateSiteConfig }>
非推奨
parseとrenderを代わりに使用してください。あなたのユースケースが新しいAPIに適合しない場合は、ディスカッションを開いてください。
定義場所
packages/mermaid/src/mermaid.ts:425
parse
• parse: (text: string, parseOptions: ParseOptions & { suppressErrors: true }) => Promise<ParseResult | false>(text: string, parseOptions?: ParseOptions) => Promise<ParseResult>
型宣言
▸ (text, parseOptions): Promise<ParseResult | false>
テキストを解析し、構文を検証します。
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
text | string | mermaid図の定義。 |
parseOptions | ParseOptions & { suppressErrors: true } | 解析のオプション。 |
戻り値
Promise<ParseResult | false>
有効な場合は、diagramTypeが図のタイプに設定されたオブジェクト。それ以外の場合は、parseOptions.suppressErrorsがtrueの場合、false。
参照
スロー
図が無効で、parseOptions.suppressErrorsがfalseまたは設定されていない場合のエラー。
▸ (text, parseOptions?): Promise<ParseResult>
パラメーター
| 名前 | 型 |
|---|---|
text | string |
parseOptions? | ParseOptions |
戻り値
Promise<ParseResult>
定義場所
packages/mermaid/src/mermaid.ts:426
parseError
• Optional parseError: ParseErrorFunction
定義場所
packages/mermaid/src/mermaid.ts:420
registerExternalDiagrams
• registerExternalDiagrams: (diagrams: ExternalDiagramDefinition[], opts: { lazyLoad?: boolean = true }) => Promise<void>
型宣言
▸ (diagrams, opts?): Promise<void>
外部の図のタイプを登録するために使用します。
パラメーター
| 名前 | 型 | デフォルト値 | 説明 |
|---|---|---|---|
diagrams | ExternalDiagramDefinition[] | undefined | ExternalDiagramDefinitionの配列。 |
opts | オブジェクト | {} | opts.lazyLoadがfalseの場合、図はすぐに読み込まれます。 |
opts.lazyLoad? | boolean | true | - |
戻り値
Promise<void>
定義場所
packages/mermaid/src/mermaid.ts:434
registerIconPacks
• registerIconPacks: (iconLoaders: IconLoader[]) => void
型宣言
▸ (iconLoaders): void
パラメーター
| 名前 | 型 |
|---|---|
iconLoaders | IconLoader[] |
戻り値
void
定義場所
packages/mermaid/src/mermaid.ts:439
registerLayoutLoaders
• registerLayoutLoaders: (loaders: LayoutLoaderDefinition[]) => void
型宣言
▸ (loaders): void
パラメーター
| 名前 | 型 |
|---|---|
loaders | LayoutLoaderDefinition[] |
戻り値
void
定義場所
packages/mermaid/src/mermaid.ts:433
render
• render: (id: string, text: string, svgContainingElement?: Element) => Promise<RenderResult>
型宣言
▸ (id, text, svgContainingElement?): Promise<RenderResult>
パラメーター
| 名前 | 型 |
|---|---|
id | string |
text | string |
svgContainingElement? | Element |
戻り値
Promise<RenderResult>
定義場所
packages/mermaid/src/mermaid.ts:427
run
• run: (options: RunOptions) => Promise<void>
型宣言
▸ (options?): Promise<void>
run
ドキュメント内にあるチャート定義を見つけて、それらをレンダリングする関数です。
この関数は、処理済み属性に属性data-processedを付与し、すでに設定されている属性を持つ要素を無視します。これにより、init関数を複数回トリガーできます。
mermaidダイアグラムをレンダリングします。
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
options | RunOptions | オプションの実行時設定 |
戻り値
Promise<void>
定義場所
packages/mermaid/src/mermaid.ts:432
setParseErrorHandler
• setParseErrorHandler: (parseErrorHandler: (err: any, hash: any) => void) => void
型宣言
▸ (parseErrorHandler): void
setParseErrorHandler parseErrorを直接設定する代わりに以下を使用します:
mermaid.parseError = function (err, hash) {
forExampleDisplayErrorInGui(err); // do something with the error
};これは、mermaidオブジェクトに新しいメンバーを追加できない環境（例：dart interopラッパー）向けに提供されます。（当初、mermaidにはparseErrorメンバーはありません。）
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
parseErrorHandler | (err: any, hash: any) => void | 新しいparseError()コールバック。 |
戻り値
void
定義場所
packages/mermaid/src/mermaid.ts:437
startOnLoad
• startOnLoad: boolean