モジュール: config
変数
defaultConfig
• const defaultConfig: MermaidConfig
定義場所
packages/mermaid/src/config.ts:8
関数
addDirective
▸ addDirective(directive): void
設定にディレクティブをプッシュします
引数
| 名前 | 型 | 説明 |
|---|---|---|
directive | MermaidConfig | プッシュするディレクティブ |
戻り値
void
定義場所
packages/mermaid/src/config.ts:188
getConfig
▸ getConfig(): MermaidConfig
getConfig
| 関数 | 説明 | 型 | 戻り値 |
|---|---|---|---|
| getConfig | currentConfigを取得します | GETリクエスト | 現在の設定からの任意の値 |
注: この関数を繰り返し呼び出すことは避けてください。代わりに、結果を変数に格納して使用し、関数呼び出しに渡してください。
戻り値
currentConfig
定義場所
packages/mermaid/src/config.ts:131
getSiteConfig
▸ getSiteConfig(): MermaidConfig
getSiteConfig
| 関数 | 説明 | 型 | 値 |
|---|---|---|---|
| setSiteConfig | 現在のsiteConfigのベース設定を返します | GETリクエスト | siteConfigの任意の値を返します |
注: siteConfigの任意の値を返します。
戻り値
siteConfig
定義場所
packages/mermaid/src/config.ts:96
reset
▸ reset(config?): void
reset
| 関数 | 説明 | 型 | 必須 | 値 |
|---|---|---|---|---|
| reset | currentConfigをconfにリセットします | PUTリクエスト | 必須 | なし |
conf
| パラメータ | 説明 | 型 | 必須 | 値 |
|---|---|---|---|---|
| conf | currentConfigがリセットできる基本値のセット。 | 辞書 | 必須 | セキュア配列に関する任意の値 |
注: (デフォルト: 現在のsiteConfig ) (オプション、デフォルトgetSiteConfig())
引数
| 名前 | 型 | デフォルト値 | 説明 |
|---|---|---|---|
config | MermaidConfig | siteConfig | currentConfigがリセットできる基本値のセット。デフォルトは現在のsiteConfig（例：getSiteConfigによって返される）です。 |
戻り値
void
定義場所
packages/mermaid/src/config.ts:221
sanitize
▸ sanitize(options): void
sanitize
| 関数 | 説明 | 型 | 値 |
|---|---|---|---|
| sanitize | siteConfigを希望の値に設定します。 | PUTリクエスト | なし |
optionsパラメータがsiteConfigのセキュアキーを上書きしようとしないようにします。注: オプションをインプレースで変更します
引数
| 名前 | 型 | 説明 |
|---|---|---|
options | any | 潜在的なsetConfigパラメータ |
戻り値
void
定義場所
packages/mermaid/src/config.ts:146
saveConfigFromInitialize
▸ saveConfigFromInitialize(conf): void
引数
| 名前 | 型 |
|---|---|
conf | MermaidConfig |
戻り値
void
定義場所
packages/mermaid/src/config.ts:75
setConfig
▸ setConfig(conf): MermaidConfig
setConfig
| 関数 | 説明 | 型 | 値 |
|---|---|---|---|
| setSiteConfig | siteConfigを希望の値に設定します | PUTリクエスト | セキュア配列内の値を除く任意の値 |
注: currentConfigを設定します。パラメータconfはsiteConfigに基づいてサニタイズされます。siteConfig.secureで見つかったキーを持つconfで見つかった値は、対応するsiteConfigの値に置き換えられます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
conf | MermaidConfig | 潜在的なcurrentConfig |
戻り値
サニタイズされたconfとマージされたcurrentConfig
定義場所
packages/mermaid/src/config.ts:113
setSiteConfig
▸ setSiteConfig(conf): MermaidConfig
setSiteConfig
| 関数 | 説明 | 型 | 値 |
|---|---|---|---|
| setSiteConfig | siteConfigを希望の値に設定します | PUTリクエスト | セキュア配列内の値を除く任意の値 |
注: siteConfigを設定します。siteConfigは、繰り返し使用するための保護された設定です。reset()を呼び出すと、currentConfigがsiteConfigにリセットされます。reset(configApi.defaultConfig)を呼び出すと、siteConfigとcurrentConfigがdefaultConfigにリセットされます。注: この関数ではcurrentConfigが設定されます。デフォルト値: デフォルトでは、グローバル設定を反映します
引数
| 名前 | 型 | 説明 |
|---|---|---|
conf | MermaidConfig | siteConfigとして使用するベースのcurrentConfig |
戻り値
新しいsiteConfig
定義場所
packages/mermaid/src/config.ts:61
updateCurrentConfig
▸ updateCurrentConfig(siteCfg, _directives): MermaidConfig
引数
| 名前 | 型 |
|---|---|
siteCfg | MermaidConfig |
_directives | MermaidConfig[] |
戻り値
定義場所
packages/mermaid/src/config.ts:15
updateSiteConfig
▸ updateSiteConfig(conf): MermaidConfig
パラメータ
| 名前 | 型 |
|---|---|
conf | MermaidConfig |