mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-08-23 10:16:43 +02:00
Compare commits
1 Commits
@mermaid-j
...
update-pro
Author | SHA1 | Date | |
---|---|---|---|
![]() |
516f38ab3b |
@@ -4,14 +4,12 @@
|
|||||||
>
|
>
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/README.md](../../../packages/mermaid/src/docs/config/setup/README.md).
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/README.md](../../../packages/mermaid/src/docs/config/setup/README.md).
|
||||||
|
|
||||||
**mermaid**
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# mermaid
|
# mermaid
|
||||||
|
|
||||||
## Modules
|
## Table of contents
|
||||||
|
|
||||||
- [config](config/README.md)
|
### Modules
|
||||||
- [defaultConfig](defaultConfig/README.md)
|
|
||||||
- [mermaid](mermaid/README.md)
|
- [config](modules/config.md)
|
||||||
|
- [defaultConfig](modules/defaultConfig.md)
|
||||||
|
- [mermaid](modules/mermaid.md)
|
||||||
|
190
docs/config/setup/classes/mermaid.UnknownDiagramError.md
Normal file
190
docs/config/setup/classes/mermaid.UnknownDiagramError.md
Normal file
@@ -0,0 +1,190 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/classes/mermaid.UnknownDiagramError.md](../../../../packages/mermaid/src/docs/config/setup/classes/mermaid.UnknownDiagramError.md).
|
||||||
|
|
||||||
|
# Class: UnknownDiagramError
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).UnknownDiagramError
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Error`
|
||||||
|
|
||||||
|
↳ **`UnknownDiagramError`**
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Constructors
|
||||||
|
|
||||||
|
- [constructor](mermaid.UnknownDiagramError.md#constructor)
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [cause](mermaid.UnknownDiagramError.md#cause)
|
||||||
|
- [message](mermaid.UnknownDiagramError.md#message)
|
||||||
|
- [name](mermaid.UnknownDiagramError.md#name)
|
||||||
|
- [stack](mermaid.UnknownDiagramError.md#stack)
|
||||||
|
- [prepareStackTrace](mermaid.UnknownDiagramError.md#preparestacktrace)
|
||||||
|
- [stackTraceLimit](mermaid.UnknownDiagramError.md#stacktracelimit)
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
|
- [captureStackTrace](mermaid.UnknownDiagramError.md#capturestacktrace)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### constructor
|
||||||
|
|
||||||
|
• **new UnknownDiagramError**(`message`): [`UnknownDiagramError`](mermaid.UnknownDiagramError.md)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :-------- | :------- |
|
||||||
|
| `message` | `string` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`UnknownDiagramError`](mermaid.UnknownDiagramError.md)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Error.constructor
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/errors.ts:2](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/errors.ts#L2)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### cause
|
||||||
|
|
||||||
|
• `Optional` **cause**: `unknown`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Error.cause
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/.pnpm/typescript\@5.4.5/node_modules/typescript/lib/lib.es2022.error.d.ts:24
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### message
|
||||||
|
|
||||||
|
• **message**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Error.message
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/.pnpm/typescript\@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1077
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Error.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/.pnpm/typescript\@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1076
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### stack
|
||||||
|
|
||||||
|
• `Optional` **stack**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Error.stack
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/.pnpm/typescript\@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1078
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### prepareStackTrace
|
||||||
|
|
||||||
|
▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`\[]) => `any`
|
||||||
|
|
||||||
|
Optional override for formatting stack traces
|
||||||
|
|
||||||
|
**`See`**
|
||||||
|
|
||||||
|
<https://v8.dev/docs/stack-trace-api#customizing-stack-traces>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`err`, `stackTraces`): `any`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------------ | :------------ |
|
||||||
|
| `err` | `Error` |
|
||||||
|
| `stackTraces` | `CallSite`\[] |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`any`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Error.prepareStackTrace
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/.pnpm/@types+node\@22.13.5/node_modules/@types/node/globals.d.ts:143
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### stackTraceLimit
|
||||||
|
|
||||||
|
▪ `Static` **stackTraceLimit**: `number`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Error.stackTraceLimit
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/.pnpm/@types+node\@22.13.5/node_modules/@types/node/globals.d.ts:145
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### captureStackTrace
|
||||||
|
|
||||||
|
▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
|
||||||
|
|
||||||
|
Create .stack property on a target object
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :---------------- | :--------- |
|
||||||
|
| `targetObject` | `object` |
|
||||||
|
| `constructorOpt?` | `Function` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Error.captureStackTrace
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/.pnpm/@types+node\@22.13.5/node_modules/@types/node/globals.d.ts:136
|
@@ -1,28 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/README.md](../../../../packages/mermaid/src/docs/config/setup/config/README.md).
|
|
||||||
|
|
||||||
[**mermaid**](../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# config
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
- [defaultConfig](variables/defaultConfig.md)
|
|
||||||
|
|
||||||
## Functions
|
|
||||||
|
|
||||||
- [addDirective](functions/addDirective.md)
|
|
||||||
- [getConfig](functions/getConfig.md)
|
|
||||||
- [getSiteConfig](functions/getSiteConfig.md)
|
|
||||||
- [reset](functions/reset.md)
|
|
||||||
- [sanitize](functions/sanitize.md)
|
|
||||||
- [saveConfigFromInitialize](functions/saveConfigFromInitialize.md)
|
|
||||||
- [setConfig](functions/setConfig.md)
|
|
||||||
- [setSiteConfig](functions/setSiteConfig.md)
|
|
||||||
- [updateCurrentConfig](functions/updateCurrentConfig.md)
|
|
||||||
- [updateSiteConfig](functions/updateSiteConfig.md)
|
|
@@ -1,29 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/addDirective.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/addDirective.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: addDirective()
|
|
||||||
|
|
||||||
> **addDirective**(`directive`): `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:188](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L188)
|
|
||||||
|
|
||||||
Pushes in a directive to the configuration
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
### directive
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
The directive to push in
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
`void`
|
|
@@ -1,29 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/getConfig.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/getConfig.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: getConfig()
|
|
||||||
|
|
||||||
> **getConfig**(): [`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:131](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L131)
|
|
||||||
|
|
||||||
## getConfig
|
|
||||||
|
|
||||||
| Function | Description | Type | Return Values |
|
|
||||||
| --------- | ------------------------- | ----------- | ------------------------------ |
|
|
||||||
| getConfig | Obtains the currentConfig | Get Request | Any Values from current Config |
|
|
||||||
|
|
||||||
**Notes**: Avoid calling this function repeatedly. Instead, store the result in a variable and use it, and pass it down to function calls.
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
The currentConfig
|
|
@@ -1,29 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/getSiteConfig.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/getSiteConfig.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: getSiteConfig()
|
|
||||||
|
|
||||||
> **getSiteConfig**(): [`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:96](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L96)
|
|
||||||
|
|
||||||
## getSiteConfig
|
|
||||||
|
|
||||||
| Function | Description | Type | Values |
|
|
||||||
| ------------- | ------------------------------------------------- | ----------- | -------------------------------- |
|
|
||||||
| setSiteConfig | Returns the current siteConfig base configuration | Get Request | Returns Any Values in siteConfig |
|
|
||||||
|
|
||||||
**Notes**: Returns **any** values in siteConfig.
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
The siteConfig
|
|
@@ -1,42 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/reset.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/reset.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: reset()
|
|
||||||
|
|
||||||
> **reset**(`config`): `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:221](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L221)
|
|
||||||
|
|
||||||
## reset
|
|
||||||
|
|
||||||
| Function | Description | Type | Required | Values |
|
|
||||||
| -------- | ---------------------------- | ----------- | -------- | ------ |
|
|
||||||
| reset | Resets currentConfig to conf | Put Request | Required | None |
|
|
||||||
|
|
||||||
## conf
|
|
||||||
|
|
||||||
| Parameter | Description | Type | Required | Values |
|
|
||||||
| --------- | -------------------------------------------------------------- | ---------- | -------- | -------------------------------------------- |
|
|
||||||
| conf | base set of values, which currentConfig could be **reset** to. | Dictionary | Required | Any Values, with respect to the secure Array |
|
|
||||||
|
|
||||||
**Notes**: (default: current siteConfig ) (optional, default `getSiteConfig()`)
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
### config
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md) = `siteConfig`
|
|
||||||
|
|
||||||
base set of values, which currentConfig could be **reset** to.
|
|
||||||
Defaults to the current siteConfig (e.g returned by [getSiteConfig](getSiteConfig.md)).
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
`void`
|
|
@@ -1,36 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/sanitize.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/sanitize.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: sanitize()
|
|
||||||
|
|
||||||
> **sanitize**(`options`): `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L146)
|
|
||||||
|
|
||||||
## sanitize
|
|
||||||
|
|
||||||
| Function | Description | Type | Values |
|
|
||||||
| -------- | -------------------------------------- | ----------- | ------ |
|
|
||||||
| sanitize | Sets the siteConfig to desired values. | Put Request | None |
|
|
||||||
|
|
||||||
Ensures options parameter does not attempt to override siteConfig secure keys **Notes**: modifies
|
|
||||||
options in-place
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
### options
|
|
||||||
|
|
||||||
`any`
|
|
||||||
|
|
||||||
The potential setConfig parameter
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
`void`
|
|
@@ -1,25 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/saveConfigFromInitialize.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/saveConfigFromInitialize.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: saveConfigFromInitialize()
|
|
||||||
|
|
||||||
> **saveConfigFromInitialize**(`conf`): `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L75)
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
### conf
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
`void`
|
|
@@ -1,39 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/setConfig.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/setConfig.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: setConfig()
|
|
||||||
|
|
||||||
> **setConfig**(`conf`): [`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L113)
|
|
||||||
|
|
||||||
## setConfig
|
|
||||||
|
|
||||||
| Function | Description | Type | Values |
|
|
||||||
| ------------- | ------------------------------------- | ----------- | --------------------------------------- |
|
|
||||||
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
|
|
||||||
|
|
||||||
**Notes**: Sets the currentConfig. The parameter conf is sanitized based on the siteConfig.secure
|
|
||||||
keys. Any values found in conf with key found in siteConfig.secure will be replaced with the
|
|
||||||
corresponding siteConfig value.
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
### conf
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
The potential currentConfig
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
The currentConfig merged with the sanitized conf
|
|
@@ -1,40 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/setSiteConfig.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/setSiteConfig.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: setSiteConfig()
|
|
||||||
|
|
||||||
> **setSiteConfig**(`conf`): [`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:61](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L61)
|
|
||||||
|
|
||||||
## setSiteConfig
|
|
||||||
|
|
||||||
| Function | Description | Type | Values |
|
|
||||||
| ------------- | ------------------------------------- | ----------- | --------------------------------------- |
|
|
||||||
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
|
|
||||||
|
|
||||||
**Notes:** Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls
|
|
||||||
to reset() will reset the currentConfig to siteConfig. Calls to reset(configApi.defaultConfig)
|
|
||||||
will reset siteConfig and currentConfig to the defaultConfig Note: currentConfig is set in this
|
|
||||||
function _Default value: At default, will mirror Global Config_
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
### conf
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
The base currentConfig to use as siteConfig
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
The new siteConfig
|
|
@@ -1,29 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/updateCurrentConfig.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/updateCurrentConfig.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: updateCurrentConfig()
|
|
||||||
|
|
||||||
> **updateCurrentConfig**(`siteCfg`, `_directives`): [`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:15](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L15)
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
### siteCfg
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
### \_directives
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)\[]
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
@@ -1,25 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/updateSiteConfig.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/updateSiteConfig.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Function: updateSiteConfig()
|
|
||||||
|
|
||||||
> **updateSiteConfig**(`conf`): [`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:79](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L79)
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
### conf
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
@@ -1,15 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/variables/defaultConfig.md](../../../../../packages/mermaid/src/docs/config/setup/config/variables/defaultConfig.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Variable: defaultConfig
|
|
||||||
|
|
||||||
> `const` **defaultConfig**: [`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.ts:8](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L8)
|
|
@@ -1,16 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/defaultConfig/README.md](../../../../packages/mermaid/src/docs/config/setup/defaultConfig/README.md).
|
|
||||||
|
|
||||||
[**mermaid**](../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# defaultConfig
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
- [configKeys](variables/configKeys.md)
|
|
||||||
- [default](variables/default.md)
|
|
@@ -1,15 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/defaultConfig/variables/configKeys.md](../../../../../packages/mermaid/src/docs/config/setup/defaultConfig/variables/configKeys.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Variable: configKeys
|
|
||||||
|
|
||||||
> `const` **configKeys**: `Set`<`string`>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/defaultConfig.ts:270](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L270)
|
|
@@ -1,21 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/defaultConfig/variables/default.md](../../../../../packages/mermaid/src/docs/config/setup/defaultConfig/variables/default.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Variable: default
|
|
||||||
|
|
||||||
> `const` **default**: `RequiredDeep`<[`MermaidConfig`](../../mermaid/interfaces/MermaidConfig.md)>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/defaultConfig.ts:18](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L18)
|
|
||||||
|
|
||||||
Default mermaid configuration options.
|
|
||||||
|
|
||||||
Please see the Mermaid config JSON Schema for the default JSON values.
|
|
||||||
Non-JSON JS default values are listed in this file, e.g. functions, or
|
|
||||||
`undefined` (explicitly set so that `configKeys` finds them).
|
|
58
docs/config/setup/interfaces/mermaid.DetailedError.md
Normal file
58
docs/config/setup/interfaces/mermaid.DetailedError.md
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.DetailedError.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.DetailedError.md).
|
||||||
|
|
||||||
|
# Interface: DetailedError
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).DetailedError
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [error](mermaid.DetailedError.md#error)
|
||||||
|
- [hash](mermaid.DetailedError.md#hash)
|
||||||
|
- [message](mermaid.DetailedError.md#message)
|
||||||
|
- [str](mermaid.DetailedError.md#str)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### error
|
||||||
|
|
||||||
|
• `Optional` **error**: `any`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/utils.ts:788](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L788)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### hash
|
||||||
|
|
||||||
|
• **hash**: `any`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/utils.ts:786](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L786)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### message
|
||||||
|
|
||||||
|
• `Optional` **message**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/utils.ts:789](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L789)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### str
|
||||||
|
|
||||||
|
• **str**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/utils.ts:784](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L784)
|
@@ -0,0 +1,47 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.ExternalDiagramDefinition.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.ExternalDiagramDefinition.md).
|
||||||
|
|
||||||
|
# Interface: ExternalDiagramDefinition
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).ExternalDiagramDefinition
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [detector](mermaid.ExternalDiagramDefinition.md#detector)
|
||||||
|
- [id](mermaid.ExternalDiagramDefinition.md#id)
|
||||||
|
- [loader](mermaid.ExternalDiagramDefinition.md#loader)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### detector
|
||||||
|
|
||||||
|
• **detector**: `DiagramDetector`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/diagram-api/types.ts:101](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L101)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### id
|
||||||
|
|
||||||
|
• **id**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/diagram-api/types.ts:100](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L100)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### loader
|
||||||
|
|
||||||
|
• **loader**: `DiagramLoader`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/diagram-api/types.ts:102](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L102)
|
51
docs/config/setup/interfaces/mermaid.LayoutData.md
Normal file
51
docs/config/setup/interfaces/mermaid.LayoutData.md
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.LayoutData.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.LayoutData.md).
|
||||||
|
|
||||||
|
# Interface: LayoutData
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).LayoutData
|
||||||
|
|
||||||
|
## Indexable
|
||||||
|
|
||||||
|
▪ \[key: `string`]: `any`
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [config](mermaid.LayoutData.md#config)
|
||||||
|
- [edges](mermaid.LayoutData.md#edges)
|
||||||
|
- [nodes](mermaid.LayoutData.md#nodes)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### config
|
||||||
|
|
||||||
|
• **config**: [`MermaidConfig`](mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/rendering-util/types.ts:148](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L148)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### edges
|
||||||
|
|
||||||
|
• **edges**: `Edge`\[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/rendering-util/types.ts:147](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L147)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### nodes
|
||||||
|
|
||||||
|
• **nodes**: `Node`\[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/rendering-util/types.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L146)
|
@@ -0,0 +1,47 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.LayoutLoaderDefinition.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.LayoutLoaderDefinition.md).
|
||||||
|
|
||||||
|
# Interface: LayoutLoaderDefinition
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).LayoutLoaderDefinition
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [algorithm](mermaid.LayoutLoaderDefinition.md#algorithm)
|
||||||
|
- [loader](mermaid.LayoutLoaderDefinition.md#loader)
|
||||||
|
- [name](mermaid.LayoutLoaderDefinition.md#name)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### algorithm
|
||||||
|
|
||||||
|
• `Optional` **algorithm**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/rendering-util/render.ts:24](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L24)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### loader
|
||||||
|
|
||||||
|
• **loader**: `LayoutLoader`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/rendering-util/render.ts:23](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L23)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• **name**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/rendering-util/render.ts:22](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L22)
|
407
docs/config/setup/interfaces/mermaid.Mermaid.md
Normal file
407
docs/config/setup/interfaces/mermaid.Mermaid.md
Normal file
@@ -0,0 +1,407 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.Mermaid.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.Mermaid.md).
|
||||||
|
|
||||||
|
# Interface: Mermaid
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).Mermaid
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [contentLoaded](mermaid.Mermaid.md#contentloaded)
|
||||||
|
- [detectType](mermaid.Mermaid.md#detecttype)
|
||||||
|
- [init](mermaid.Mermaid.md#init)
|
||||||
|
- [initialize](mermaid.Mermaid.md#initialize)
|
||||||
|
- [mermaidAPI](mermaid.Mermaid.md#mermaidapi)
|
||||||
|
- [parse](mermaid.Mermaid.md#parse)
|
||||||
|
- [parseError](mermaid.Mermaid.md#parseerror)
|
||||||
|
- [registerExternalDiagrams](mermaid.Mermaid.md#registerexternaldiagrams)
|
||||||
|
- [registerIconPacks](mermaid.Mermaid.md#registericonpacks)
|
||||||
|
- [registerLayoutLoaders](mermaid.Mermaid.md#registerlayoutloaders)
|
||||||
|
- [render](mermaid.Mermaid.md#render)
|
||||||
|
- [run](mermaid.Mermaid.md#run)
|
||||||
|
- [setParseErrorHandler](mermaid.Mermaid.md#setparseerrorhandler)
|
||||||
|
- [startOnLoad](mermaid.Mermaid.md#startonload)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### contentLoaded
|
||||||
|
|
||||||
|
• **contentLoaded**: () => `void`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): `void`
|
||||||
|
|
||||||
|
\##contentLoaded Callback function that is called when page is loaded. This functions fetches
|
||||||
|
configuration for mermaid rendering and calls init for rendering the mermaid diagrams on the
|
||||||
|
page.
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:436](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L436)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### detectType
|
||||||
|
|
||||||
|
• **detectType**: (`text`: `string`, `config?`: [`MermaidConfig`](mermaid.MermaidConfig.md)) => `string`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`text`, `config?`): `string`
|
||||||
|
|
||||||
|
Detects the type of the graph text.
|
||||||
|
|
||||||
|
Takes into consideration the possible existence of an `%%init` directive
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :-------- | :------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `text` | `string` | The text defining the graph. For example: `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.MermaidConfig.md) | The mermaid config. |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`string`
|
||||||
|
|
||||||
|
A graph definition key
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:438](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L438)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### init
|
||||||
|
|
||||||
|
• **init**: (`config?`: [`MermaidConfig`](mermaid.MermaidConfig.md), `nodes?`: `string` | `HTMLElement` | `NodeListOf`<`HTMLElement`>, `callback?`: (`id`: `string`) => `unknown`) => `Promise`<`void`>
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Use [initialize](mermaid.Mermaid.md#initialize) and [run](mermaid.Mermaid.md#run) instead.
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`config?`, `nodes?`, `callback?`): `Promise`<`void`>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :---------- | :------------------------------------------------------- |
|
||||||
|
| `config?` | [`MermaidConfig`](mermaid.MermaidConfig.md) |
|
||||||
|
| `nodes?` | `string` \| `HTMLElement` \| `NodeListOf`<`HTMLElement`> |
|
||||||
|
| `callback?` | (`id`: `string`) => `unknown` |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Promise`<`void`>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:431](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L431)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### initialize
|
||||||
|
|
||||||
|
• **initialize**: (`config`: [`MermaidConfig`](mermaid.MermaidConfig.md)) => `void`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`config`): `void`
|
||||||
|
|
||||||
|
Used to set configurations for mermaid.
|
||||||
|
This function should be called before the run function.
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :------- | :------------------------------------------ | :-------------------------------- |
|
||||||
|
| `config` | [`MermaidConfig`](mermaid.MermaidConfig.md) | Configuration object for mermaid. |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:435](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L435)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### mermaidAPI
|
||||||
|
|
||||||
|
• **mermaidAPI**: `Readonly`<{ `defaultConfig`: [`MermaidConfig`](mermaid.MermaidConfig.md) = configApi.defaultConfig; `getConfig`: () => [`MermaidConfig`](mermaid.MermaidConfig.md) = configApi.getConfig; `getDiagramFromText`: (`text`: `string`, `metadata`: `Pick`<`DiagramMetadata`, `"title"`>) => `Promise`<`Diagram`> ; `getSiteConfig`: () => [`MermaidConfig`](mermaid.MermaidConfig.md) = configApi.getSiteConfig; `globalReset`: () => `void` ; `initialize`: (`userOptions`: [`MermaidConfig`](mermaid.MermaidConfig.md)) => `void` ; `parse`: (`text`: `string`, `parseOptions`: [`ParseOptions`](mermaid.ParseOptions.md) & { `suppressErrors`: `true` }) => `Promise`<[`ParseResult`](mermaid.ParseResult.md) | `false`>(`text`: `string`, `parseOptions?`: [`ParseOptions`](mermaid.ParseOptions.md)) => `Promise`<[`ParseResult`](mermaid.ParseResult.md)> ; `render`: (`id`: `string`, `text`: `string`, `svgContainingElement?`: `Element`) => `Promise`<[`RenderResult`](mermaid.RenderResult.md)> ; `reset`: () => `void` ; `setConfig`: (`conf`: [`MermaidConfig`](mermaid.MermaidConfig.md)) => [`MermaidConfig`](mermaid.MermaidConfig.md) = configApi.setConfig; `updateSiteConfig`: (`conf`: [`MermaidConfig`](mermaid.MermaidConfig.md)) => [`MermaidConfig`](mermaid.MermaidConfig.md) = configApi.updateSiteConfig }>
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Use [parse](mermaid.Mermaid.md#parse) and [render](mermaid.Mermaid.md#render) instead. Please [open a discussion](https://github.com/mermaid-js/mermaid/discussions) if your use case does not fit the new API.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:425](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L425)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### parse
|
||||||
|
|
||||||
|
• **parse**: (`text`: `string`, `parseOptions`: [`ParseOptions`](mermaid.ParseOptions.md) & { `suppressErrors`: `true` }) => `Promise`<[`ParseResult`](mermaid.ParseResult.md) | `false`>(`text`: `string`, `parseOptions?`: [`ParseOptions`](mermaid.ParseOptions.md)) => `Promise`<[`ParseResult`](mermaid.ParseResult.md)>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`text`, `parseOptions`): `Promise`<[`ParseResult`](mermaid.ParseResult.md) | `false`>
|
||||||
|
|
||||||
|
Parse the text and validate the syntax.
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :------------- | :----------------------------------------------------------------------- | :------------------------------ |
|
||||||
|
| `text` | `string` | The mermaid diagram definition. |
|
||||||
|
| `parseOptions` | [`ParseOptions`](mermaid.ParseOptions.md) & { `suppressErrors`: `true` } | Options for parsing. |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Promise`<[`ParseResult`](mermaid.ParseResult.md) | `false`>
|
||||||
|
|
||||||
|
An object with the `diagramType` set to type of the diagram if valid. Otherwise `false` if parseOptions.suppressErrors is `true`.
|
||||||
|
|
||||||
|
**`See`**
|
||||||
|
|
||||||
|
[ParseOptions](mermaid.ParseOptions.md)
|
||||||
|
|
||||||
|
**`Throws`**
|
||||||
|
|
||||||
|
Error if the diagram is invalid and parseOptions.suppressErrors is false or not set.
|
||||||
|
|
||||||
|
▸ (`text`, `parseOptions?`): `Promise`<[`ParseResult`](mermaid.ParseResult.md)>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :-------------- | :---------------------------------------- |
|
||||||
|
| `text` | `string` |
|
||||||
|
| `parseOptions?` | [`ParseOptions`](mermaid.ParseOptions.md) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Promise`<[`ParseResult`](mermaid.ParseResult.md)>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:426](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L426)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### parseError
|
||||||
|
|
||||||
|
• `Optional` **parseError**: [`ParseErrorFunction`](../modules/mermaid.md#parseerrorfunction)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:420](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L420)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### registerExternalDiagrams
|
||||||
|
|
||||||
|
• **registerExternalDiagrams**: (`diagrams`: [`ExternalDiagramDefinition`](mermaid.ExternalDiagramDefinition.md)\[], `opts`: { `lazyLoad?`: `boolean` = true }) => `Promise`<`void`>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`diagrams`, `opts?`): `Promise`<`void`>
|
||||||
|
|
||||||
|
Used to register external diagram types.
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Default value | Description |
|
||||||
|
| :--------------- | :--------------------------------------------------------------------- | :------------ | :-------------------------------------------------------------------------- |
|
||||||
|
| `diagrams` | [`ExternalDiagramDefinition`](mermaid.ExternalDiagramDefinition.md)\[] | `undefined` | Array of [ExternalDiagramDefinition](mermaid.ExternalDiagramDefinition.md). |
|
||||||
|
| `opts` | `Object` | `{}` | If opts.lazyLoad is false, the diagrams will be loaded immediately. |
|
||||||
|
| `opts.lazyLoad?` | `boolean` | `true` | - |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Promise`<`void`>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:434](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L434)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### registerIconPacks
|
||||||
|
|
||||||
|
• **registerIconPacks**: (`iconLoaders`: `IconLoader`\[]) => `void`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`iconLoaders`): `void`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------------ | :-------------- |
|
||||||
|
| `iconLoaders` | `IconLoader`\[] |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:439](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L439)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### registerLayoutLoaders
|
||||||
|
|
||||||
|
• **registerLayoutLoaders**: (`loaders`: [`LayoutLoaderDefinition`](mermaid.LayoutLoaderDefinition.md)\[]) => `void`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`loaders`): `void`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :-------- | :--------------------------------------------------------------- |
|
||||||
|
| `loaders` | [`LayoutLoaderDefinition`](mermaid.LayoutLoaderDefinition.md)\[] |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:433](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L433)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### render
|
||||||
|
|
||||||
|
• **render**: (`id`: `string`, `text`: `string`, `svgContainingElement?`: `Element`) => `Promise`<[`RenderResult`](mermaid.RenderResult.md)>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`id`, `text`, `svgContainingElement?`): `Promise`<[`RenderResult`](mermaid.RenderResult.md)>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :---------------------- | :-------- |
|
||||||
|
| `id` | `string` |
|
||||||
|
| `text` | `string` |
|
||||||
|
| `svgContainingElement?` | `Element` |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Promise`<[`RenderResult`](mermaid.RenderResult.md)>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:427](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L427)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### run
|
||||||
|
|
||||||
|
• **run**: (`options`: [`RunOptions`](mermaid.RunOptions.md)) => `Promise`<`void`>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`options?`): `Promise`<`void`>
|
||||||
|
|
||||||
|
## run
|
||||||
|
|
||||||
|
Function that goes through the document to find the chart definitions in there and render them.
|
||||||
|
|
||||||
|
The function tags the processed attributes with the attribute data-processed and ignores found
|
||||||
|
elements with the attribute already set. This way the init function can be triggered several
|
||||||
|
times.
|
||||||
|
|
||||||
|
```mermaid-example
|
||||||
|
graph LR;
|
||||||
|
a(Find elements)-->b{Processed}
|
||||||
|
b-->|Yes|c(Leave element)
|
||||||
|
b-->|No |d(Transform)
|
||||||
|
```
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
graph LR;
|
||||||
|
a(Find elements)-->b{Processed}
|
||||||
|
b-->|Yes|c(Leave element)
|
||||||
|
b-->|No |d(Transform)
|
||||||
|
```
|
||||||
|
|
||||||
|
Renders the mermaid diagrams
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :-------- | :------------------------------------ | :----------------------- |
|
||||||
|
| `options` | [`RunOptions`](mermaid.RunOptions.md) | Optional runtime configs |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Promise`<`void`>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:432](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L432)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### setParseErrorHandler
|
||||||
|
|
||||||
|
• **setParseErrorHandler**: (`parseErrorHandler`: (`err`: `any`, `hash`: `any`) => `void`) => `void`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`parseErrorHandler`): `void`
|
||||||
|
|
||||||
|
## setParseErrorHandler Alternative to directly setting parseError using:
|
||||||
|
|
||||||
|
```js
|
||||||
|
mermaid.parseError = function (err, hash) {
|
||||||
|
forExampleDisplayErrorInGui(err); // do something with the error
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
This is provided for environments where the mermaid object can't directly have a new member added
|
||||||
|
to it (eg. dart interop wrapper). (Initially there is no parseError member of mermaid).
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :------------------ | :-------------------------------------- | :------------------------- |
|
||||||
|
| `parseErrorHandler` | (`err`: `any`, `hash`: `any`) => `void` | New parseError() callback. |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:437](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L437)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### startOnLoad
|
||||||
|
|
||||||
|
• **startOnLoad**: `boolean`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:419](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L419)
|
593
docs/config/setup/interfaces/mermaid.MermaidConfig.md
Normal file
593
docs/config/setup/interfaces/mermaid.MermaidConfig.md
Normal file
@@ -0,0 +1,593 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.MermaidConfig.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.MermaidConfig.md).
|
||||||
|
|
||||||
|
# Interface: MermaidConfig
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).MermaidConfig
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [altFontFamily](mermaid.MermaidConfig.md#altfontfamily)
|
||||||
|
- [architecture](mermaid.MermaidConfig.md#architecture)
|
||||||
|
- [arrowMarkerAbsolute](mermaid.MermaidConfig.md#arrowmarkerabsolute)
|
||||||
|
- [block](mermaid.MermaidConfig.md#block)
|
||||||
|
- [c4](mermaid.MermaidConfig.md#c4)
|
||||||
|
- [class](mermaid.MermaidConfig.md#class)
|
||||||
|
- [darkMode](mermaid.MermaidConfig.md#darkmode)
|
||||||
|
- [deterministicIDSeed](mermaid.MermaidConfig.md#deterministicidseed)
|
||||||
|
- [deterministicIds](mermaid.MermaidConfig.md#deterministicids)
|
||||||
|
- [dompurifyConfig](mermaid.MermaidConfig.md#dompurifyconfig)
|
||||||
|
- [elk](mermaid.MermaidConfig.md#elk)
|
||||||
|
- [er](mermaid.MermaidConfig.md#er)
|
||||||
|
- [flowchart](mermaid.MermaidConfig.md#flowchart)
|
||||||
|
- [fontFamily](mermaid.MermaidConfig.md#fontfamily)
|
||||||
|
- [fontSize](mermaid.MermaidConfig.md#fontsize)
|
||||||
|
- [forceLegacyMathML](mermaid.MermaidConfig.md#forcelegacymathml)
|
||||||
|
- [gantt](mermaid.MermaidConfig.md#gantt)
|
||||||
|
- [gitGraph](mermaid.MermaidConfig.md#gitgraph)
|
||||||
|
- [handDrawnSeed](mermaid.MermaidConfig.md#handdrawnseed)
|
||||||
|
- [htmlLabels](mermaid.MermaidConfig.md#htmllabels)
|
||||||
|
- [journey](mermaid.MermaidConfig.md#journey)
|
||||||
|
- [kanban](mermaid.MermaidConfig.md#kanban)
|
||||||
|
- [layout](mermaid.MermaidConfig.md#layout)
|
||||||
|
- [legacyMathML](mermaid.MermaidConfig.md#legacymathml)
|
||||||
|
- [logLevel](mermaid.MermaidConfig.md#loglevel)
|
||||||
|
- [look](mermaid.MermaidConfig.md#look)
|
||||||
|
- [markdownAutoWrap](mermaid.MermaidConfig.md#markdownautowrap)
|
||||||
|
- [maxEdges](mermaid.MermaidConfig.md#maxedges)
|
||||||
|
- [maxTextSize](mermaid.MermaidConfig.md#maxtextsize)
|
||||||
|
- [mindmap](mermaid.MermaidConfig.md#mindmap)
|
||||||
|
- [packet](mermaid.MermaidConfig.md#packet)
|
||||||
|
- [pie](mermaid.MermaidConfig.md#pie)
|
||||||
|
- [quadrantChart](mermaid.MermaidConfig.md#quadrantchart)
|
||||||
|
- [requirement](mermaid.MermaidConfig.md#requirement)
|
||||||
|
- [sankey](mermaid.MermaidConfig.md#sankey)
|
||||||
|
- [secure](mermaid.MermaidConfig.md#secure)
|
||||||
|
- [securityLevel](mermaid.MermaidConfig.md#securitylevel)
|
||||||
|
- [sequence](mermaid.MermaidConfig.md#sequence)
|
||||||
|
- [startOnLoad](mermaid.MermaidConfig.md#startonload)
|
||||||
|
- [state](mermaid.MermaidConfig.md#state)
|
||||||
|
- [suppressErrorRendering](mermaid.MermaidConfig.md#suppresserrorrendering)
|
||||||
|
- [theme](mermaid.MermaidConfig.md#theme)
|
||||||
|
- [themeCSS](mermaid.MermaidConfig.md#themecss)
|
||||||
|
- [themeVariables](mermaid.MermaidConfig.md#themevariables)
|
||||||
|
- [timeline](mermaid.MermaidConfig.md#timeline)
|
||||||
|
- [wrap](mermaid.MermaidConfig.md#wrap)
|
||||||
|
- [xyChart](mermaid.MermaidConfig.md#xychart)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### altFontFamily
|
||||||
|
|
||||||
|
• `Optional` **altFontFamily**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:122](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L122)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### architecture
|
||||||
|
|
||||||
|
• `Optional` **architecture**: `ArchitectureDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:194](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L194)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### arrowMarkerAbsolute
|
||||||
|
|
||||||
|
• `Optional` **arrowMarkerAbsolute**: `boolean`
|
||||||
|
|
||||||
|
Controls whether or arrow markers in html code are absolute paths or anchors.
|
||||||
|
This matters if you are using base tag settings.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:141](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L141)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### block
|
||||||
|
|
||||||
|
• `Optional` **block**: `BlockDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:201](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L201)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### c4
|
||||||
|
|
||||||
|
• `Optional` **c4**: `C4DiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:198](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L198)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### class
|
||||||
|
|
||||||
|
• `Optional` **class**: `ClassDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:187](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L187)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### darkMode
|
||||||
|
|
||||||
|
• `Optional` **darkMode**: `boolean`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L113)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### deterministicIDSeed
|
||||||
|
|
||||||
|
• `Optional` **deterministicIDSeed**: `string`
|
||||||
|
|
||||||
|
This option is the optional seed for deterministic ids.
|
||||||
|
If set to `undefined` but deterministicIds is `true`, a simple number iterator is used.
|
||||||
|
You can set this attribute to base the seed on a static string.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:181](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L181)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### deterministicIds
|
||||||
|
|
||||||
|
• `Optional` **deterministicIds**: `boolean`
|
||||||
|
|
||||||
|
This option controls if the generated ids of nodes in the SVG are
|
||||||
|
generated randomly or based on a seed.
|
||||||
|
If set to `false`, the IDs are generated based on the current date and
|
||||||
|
thus are not deterministic. This is the default behavior.
|
||||||
|
|
||||||
|
This matters if your files are checked into source control e.g. git and
|
||||||
|
should not change unless content is changed.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:174](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L174)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### dompurifyConfig
|
||||||
|
|
||||||
|
• `Optional` **dompurifyConfig**: `Config`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:202](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L202)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### elk
|
||||||
|
|
||||||
|
• `Optional` **elk**: `Object`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :----------------------- | :-------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `cycleBreakingStrategy?` | `"GREEDY"` \| `"DEPTH_FIRST"` \| `"INTERACTIVE"` \| `"MODEL_ORDER"` \| `"GREEDY_MODEL_ORDER"` | This strategy decides how to find cycles in the graph and deciding which edges need adjustment to break loops. |
|
||||||
|
| `mergeEdges?` | `boolean` | Elk specific option that allows edges to share path where it convenient. It can make for pretty diagrams but can also make it harder to read the diagram. |
|
||||||
|
| `nodePlacementStrategy?` | `"SIMPLE"` \| `"NETWORK_SIMPLEX"` \| `"LINEAR_SEGMENTS"` \| `"BRANDES_KOEPF"` | Elk specific option affecting how nodes are placed. |
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:91](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L91)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### er
|
||||||
|
|
||||||
|
• `Optional` **er**: `ErDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:189](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L189)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### flowchart
|
||||||
|
|
||||||
|
• `Optional` **flowchart**: `FlowchartDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:182](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L182)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### fontFamily
|
||||||
|
|
||||||
|
• `Optional` **fontFamily**: `string`
|
||||||
|
|
||||||
|
Specifies the font to be used in the rendered diagrams.
|
||||||
|
Can be any possible CSS `font-family`.
|
||||||
|
See <https://developer.mozilla.org/en-US/docs/Web/CSS/font-family>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:121](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L121)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### fontSize
|
||||||
|
|
||||||
|
• `Optional` **fontSize**: `number`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:204](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L204)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### forceLegacyMathML
|
||||||
|
|
||||||
|
• `Optional` **forceLegacyMathML**: `boolean`
|
||||||
|
|
||||||
|
This option forces Mermaid to rely on KaTeX's own stylesheet for rendering MathML. Due to differences between OS
|
||||||
|
fonts and browser's MathML implementation, this option is recommended if consistent rendering is important.
|
||||||
|
If set to true, ignores legacyMathML.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:163](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L163)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### gantt
|
||||||
|
|
||||||
|
• `Optional` **gantt**: `GanttDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:184](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L184)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### gitGraph
|
||||||
|
|
||||||
|
• `Optional` **gitGraph**: `GitGraphDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:197](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L197)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### handDrawnSeed
|
||||||
|
|
||||||
|
• `Optional` **handDrawnSeed**: `number`
|
||||||
|
|
||||||
|
Defines the seed to be used when using handDrawn look. This is important for the automated tests as they will always find differences without the seed. The default value is 0 which gives a random seed.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:76](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L76)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### htmlLabels
|
||||||
|
|
||||||
|
• `Optional` **htmlLabels**: `boolean`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:114](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L114)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### journey
|
||||||
|
|
||||||
|
• `Optional` **journey**: `JourneyDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:185](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L185)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### kanban
|
||||||
|
|
||||||
|
• `Optional` **kanban**: `KanbanDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:196](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L196)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### layout
|
||||||
|
|
||||||
|
• `Optional` **layout**: `string`
|
||||||
|
|
||||||
|
Defines which layout algorithm to use for rendering the diagram.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:81](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L81)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### legacyMathML
|
||||||
|
|
||||||
|
• `Optional` **legacyMathML**: `boolean`
|
||||||
|
|
||||||
|
This option specifies if Mermaid can expect the dependent to include KaTeX stylesheets for browsers
|
||||||
|
without their own MathML implementation. If this option is disabled and MathML is not supported, the math
|
||||||
|
equations are replaced with a warning. If this option is enabled and MathML is not supported, Mermaid will
|
||||||
|
fall back to legacy rendering for KaTeX.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:156](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L156)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### logLevel
|
||||||
|
|
||||||
|
• `Optional` **logLevel**: `0` | `2` | `1` | `"trace"` | `"debug"` | `"info"` | `"warn"` | `"error"` | `"fatal"` | `3` | `4` | `5`
|
||||||
|
|
||||||
|
This option decides the amount of logging to be used by mermaid.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:127](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L127)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### look
|
||||||
|
|
||||||
|
• `Optional` **look**: `"classic"` | `"handDrawn"`
|
||||||
|
|
||||||
|
Defines which main look to use for the diagram.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:71](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L71)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### markdownAutoWrap
|
||||||
|
|
||||||
|
• `Optional` **markdownAutoWrap**: `boolean`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:205](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L205)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### maxEdges
|
||||||
|
|
||||||
|
• `Optional` **maxEdges**: `number`
|
||||||
|
|
||||||
|
Defines the maximum number of edges that can be drawn in a graph.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:90](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L90)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### maxTextSize
|
||||||
|
|
||||||
|
• `Optional` **maxTextSize**: `number`
|
||||||
|
|
||||||
|
The maximum allowed size of the users text diagram
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:85](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L85)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### mindmap
|
||||||
|
|
||||||
|
• `Optional` **mindmap**: `MindmapDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:195](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L195)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### packet
|
||||||
|
|
||||||
|
• `Optional` **packet**: `PacketDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:200](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L200)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### pie
|
||||||
|
|
||||||
|
• `Optional` **pie**: `PieDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:190](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L190)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### quadrantChart
|
||||||
|
|
||||||
|
• `Optional` **quadrantChart**: `QuadrantChartConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:191](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L191)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### requirement
|
||||||
|
|
||||||
|
• `Optional` **requirement**: `RequirementDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:193](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L193)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### sankey
|
||||||
|
|
||||||
|
• `Optional` **sankey**: `SankeyDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:199](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L199)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### secure
|
||||||
|
|
||||||
|
• `Optional` **secure**: `string`\[]
|
||||||
|
|
||||||
|
This option controls which `currentConfig` keys are considered secure and
|
||||||
|
can only be changed via call to `mermaid.initialize`.
|
||||||
|
This prevents malicious graph directives from overriding a site's default security.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:148](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L148)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### securityLevel
|
||||||
|
|
||||||
|
• `Optional` **securityLevel**: `"strict"` | `"loose"` | `"antiscript"` | `"sandbox"`
|
||||||
|
|
||||||
|
Level of trust for parsed diagram
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:131](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L131)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### sequence
|
||||||
|
|
||||||
|
• `Optional` **sequence**: `SequenceDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:183](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L183)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### startOnLoad
|
||||||
|
|
||||||
|
• `Optional` **startOnLoad**: `boolean`
|
||||||
|
|
||||||
|
Dictates whether mermaid starts on Page load
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:135](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L135)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### state
|
||||||
|
|
||||||
|
• `Optional` **state**: `StateDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:188](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L188)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### suppressErrorRendering
|
||||||
|
|
||||||
|
• `Optional` **suppressErrorRendering**: `boolean`
|
||||||
|
|
||||||
|
Suppresses inserting 'Syntax error' diagram in the DOM.
|
||||||
|
This is useful when you want to control how to handle syntax errors in your application.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:211](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L211)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### theme
|
||||||
|
|
||||||
|
• `Optional` **theme**: `"default"` | `"base"` | `"dark"` | `"forest"` | `"neutral"` | `"null"`
|
||||||
|
|
||||||
|
Theme, the CSS style sheet.
|
||||||
|
You may also use `themeCSS` to override this value.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:64](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L64)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### themeCSS
|
||||||
|
|
||||||
|
• `Optional` **themeCSS**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:66](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L66)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### themeVariables
|
||||||
|
|
||||||
|
• `Optional` **themeVariables**: `any`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:65](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L65)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### timeline
|
||||||
|
|
||||||
|
• `Optional` **timeline**: `TimelineDiagramConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:186](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L186)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### wrap
|
||||||
|
|
||||||
|
• `Optional` **wrap**: `boolean`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:203](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L203)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### xyChart
|
||||||
|
|
||||||
|
• `Optional` **xyChart**: `XYChartConfig`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.type.ts:192](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L192)
|
28
docs/config/setup/interfaces/mermaid.ParseOptions.md
Normal file
28
docs/config/setup/interfaces/mermaid.ParseOptions.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.ParseOptions.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.ParseOptions.md).
|
||||||
|
|
||||||
|
# Interface: ParseOptions
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).ParseOptions
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [suppressErrors](mermaid.ParseOptions.md#suppresserrors)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### suppressErrors
|
||||||
|
|
||||||
|
• `Optional` **suppressErrors**: `boolean`
|
||||||
|
|
||||||
|
If `true`, parse will return `false` instead of throwing error when the diagram is invalid.
|
||||||
|
The `parseError` function will not be called.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/types.ts:64](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L64)
|
40
docs/config/setup/interfaces/mermaid.ParseResult.md
Normal file
40
docs/config/setup/interfaces/mermaid.ParseResult.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.ParseResult.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.ParseResult.md).
|
||||||
|
|
||||||
|
# Interface: ParseResult
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).ParseResult
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [config](mermaid.ParseResult.md#config)
|
||||||
|
- [diagramType](mermaid.ParseResult.md#diagramtype)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### config
|
||||||
|
|
||||||
|
• **config**: [`MermaidConfig`](mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
The config passed as YAML frontmatter or directives
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/types.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L75)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### diagramType
|
||||||
|
|
||||||
|
• **diagramType**: `string`
|
||||||
|
|
||||||
|
The diagram type, e.g. 'flowchart', 'sequence', etc.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/types.ts:71](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L71)
|
25
docs/config/setup/interfaces/mermaid.RenderOptions.md
Normal file
25
docs/config/setup/interfaces/mermaid.RenderOptions.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.RenderOptions.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.RenderOptions.md).
|
||||||
|
|
||||||
|
# Interface: RenderOptions
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).RenderOptions
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [algorithm](mermaid.RenderOptions.md#algorithm)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### algorithm
|
||||||
|
|
||||||
|
• `Optional` **algorithm**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/rendering-util/render.ts:8](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L8)
|
74
docs/config/setup/interfaces/mermaid.RenderResult.md
Normal file
74
docs/config/setup/interfaces/mermaid.RenderResult.md
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.RenderResult.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.RenderResult.md).
|
||||||
|
|
||||||
|
# Interface: RenderResult
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).RenderResult
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [bindFunctions](mermaid.RenderResult.md#bindfunctions)
|
||||||
|
- [diagramType](mermaid.RenderResult.md#diagramtype)
|
||||||
|
- [svg](mermaid.RenderResult.md#svg)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### bindFunctions
|
||||||
|
|
||||||
|
• `Optional` **bindFunctions**: (`element`: `Element`) => `void`
|
||||||
|
|
||||||
|
Bind function to be called after the svg has been inserted into the DOM.
|
||||||
|
This is necessary for adding event listeners to the elements in the svg.
|
||||||
|
|
||||||
|
```js
|
||||||
|
const { svg, bindFunctions } = await mermaid.render('id1', 'graph TD;A-->B');
|
||||||
|
div.innerHTML = svg;
|
||||||
|
bindFunctions?.(div); // To call bindFunctions only if it's present.
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`element`): `void`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :-------- | :-------- |
|
||||||
|
| `element` | `Element` |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/types.ts:103](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L103)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### diagramType
|
||||||
|
|
||||||
|
• **diagramType**: `string`
|
||||||
|
|
||||||
|
The diagram type, e.g. 'flowchart', 'sequence', etc.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/types.ts:93](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L93)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### svg
|
||||||
|
|
||||||
|
• **svg**: `string`
|
||||||
|
|
||||||
|
The svg code for the rendered graph.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/types.ts:89](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L89)
|
80
docs/config/setup/interfaces/mermaid.RunOptions.md
Normal file
80
docs/config/setup/interfaces/mermaid.RunOptions.md
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.RunOptions.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.RunOptions.md).
|
||||||
|
|
||||||
|
# Interface: RunOptions
|
||||||
|
|
||||||
|
[mermaid](../modules/mermaid.md).RunOptions
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [nodes](mermaid.RunOptions.md#nodes)
|
||||||
|
- [postRenderCallback](mermaid.RunOptions.md#postrendercallback)
|
||||||
|
- [querySelector](mermaid.RunOptions.md#queryselector)
|
||||||
|
- [suppressErrors](mermaid.RunOptions.md#suppresserrors)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### nodes
|
||||||
|
|
||||||
|
• `Optional` **nodes**: `ArrayLike`<`HTMLElement`>
|
||||||
|
|
||||||
|
The nodes to render. If this is set, `querySelector` will be ignored.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:49](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L49)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### postRenderCallback
|
||||||
|
|
||||||
|
• `Optional` **postRenderCallback**: (`id`: `string`) => `unknown`
|
||||||
|
|
||||||
|
A callback to call after each diagram is rendered.
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`id`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------- |
|
||||||
|
| `id` | `string` |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:53](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L53)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### querySelector
|
||||||
|
|
||||||
|
• `Optional` **querySelector**: `string`
|
||||||
|
|
||||||
|
The query selector to use when finding elements to render. Default: `".mermaid"`.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:45](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L45)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### suppressErrors
|
||||||
|
|
||||||
|
• `Optional` **suppressErrors**: `boolean`
|
||||||
|
|
||||||
|
If `true`, errors will be logged to the console, but not thrown. Default: `false`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:57](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L57)
|
@@ -1,40 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/README.md](../../../../packages/mermaid/src/docs/config/setup/mermaid/README.md).
|
|
||||||
|
|
||||||
[**mermaid**](../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# mermaid
|
|
||||||
|
|
||||||
## Classes
|
|
||||||
|
|
||||||
- [UnknownDiagramError](classes/UnknownDiagramError.md)
|
|
||||||
|
|
||||||
## Interfaces
|
|
||||||
|
|
||||||
- [DetailedError](interfaces/DetailedError.md)
|
|
||||||
- [ExternalDiagramDefinition](interfaces/ExternalDiagramDefinition.md)
|
|
||||||
- [LayoutData](interfaces/LayoutData.md)
|
|
||||||
- [LayoutLoaderDefinition](interfaces/LayoutLoaderDefinition.md)
|
|
||||||
- [Mermaid](interfaces/Mermaid.md)
|
|
||||||
- [MermaidConfig](interfaces/MermaidConfig.md)
|
|
||||||
- [ParseOptions](interfaces/ParseOptions.md)
|
|
||||||
- [ParseResult](interfaces/ParseResult.md)
|
|
||||||
- [RenderOptions](interfaces/RenderOptions.md)
|
|
||||||
- [RenderResult](interfaces/RenderResult.md)
|
|
||||||
- [RunOptions](interfaces/RunOptions.md)
|
|
||||||
|
|
||||||
## Type Aliases
|
|
||||||
|
|
||||||
- [InternalHelpers](type-aliases/InternalHelpers.md)
|
|
||||||
- [ParseErrorFunction](type-aliases/ParseErrorFunction.md)
|
|
||||||
- [SVG](type-aliases/SVG.md)
|
|
||||||
- [SVGGroup](type-aliases/SVGGroup.md)
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
- [default](variables/default.md)
|
|
@@ -1,159 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/classes/UnknownDiagramError.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/classes/UnknownDiagramError.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Class: UnknownDiagramError
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/errors.ts:1](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/errors.ts#L1)
|
|
||||||
|
|
||||||
## Extends
|
|
||||||
|
|
||||||
- `Error`
|
|
||||||
|
|
||||||
## Constructors
|
|
||||||
|
|
||||||
### new UnknownDiagramError()
|
|
||||||
|
|
||||||
> **new UnknownDiagramError**(`message`): [`UnknownDiagramError`](UnknownDiagramError.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/errors.ts:2](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/errors.ts#L2)
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### message
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`UnknownDiagramError`](UnknownDiagramError.md)
|
|
||||||
|
|
||||||
#### Overrides
|
|
||||||
|
|
||||||
`Error.constructor`
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### cause?
|
|
||||||
|
|
||||||
> `optional` **cause**: `unknown`
|
|
||||||
|
|
||||||
Defined in: node_modules/.pnpm/typescript\@5.7.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
`Error.cause`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### message
|
|
||||||
|
|
||||||
> **message**: `string`
|
|
||||||
|
|
||||||
Defined in: node_modules/.pnpm/typescript\@5.7.3/node_modules/typescript/lib/lib.es5.d.ts:1077
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
`Error.message`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### name
|
|
||||||
|
|
||||||
> **name**: `string`
|
|
||||||
|
|
||||||
Defined in: node_modules/.pnpm/typescript\@5.7.3/node_modules/typescript/lib/lib.es5.d.ts:1076
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
`Error.name`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### stack?
|
|
||||||
|
|
||||||
> `optional` **stack**: `string`
|
|
||||||
|
|
||||||
Defined in: node_modules/.pnpm/typescript\@5.7.3/node_modules/typescript/lib/lib.es5.d.ts:1078
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
`Error.stack`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### prepareStackTrace()?
|
|
||||||
|
|
||||||
> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
|
|
||||||
|
|
||||||
Defined in: node_modules/.pnpm/@types+node\@22.13.5/node_modules/@types/node/globals.d.ts:143
|
|
||||||
|
|
||||||
Optional override for formatting stack traces
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### err
|
|
||||||
|
|
||||||
`Error`
|
|
||||||
|
|
||||||
##### stackTraces
|
|
||||||
|
|
||||||
`CallSite`\[]
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`any`
|
|
||||||
|
|
||||||
#### See
|
|
||||||
|
|
||||||
<https://v8.dev/docs/stack-trace-api#customizing-stack-traces>
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
`Error.prepareStackTrace`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### stackTraceLimit
|
|
||||||
|
|
||||||
> `static` **stackTraceLimit**: `number`
|
|
||||||
|
|
||||||
Defined in: node_modules/.pnpm/@types+node\@22.13.5/node_modules/@types/node/globals.d.ts:145
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
`Error.stackTraceLimit`
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### captureStackTrace()
|
|
||||||
|
|
||||||
> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
|
|
||||||
|
|
||||||
Defined in: node_modules/.pnpm/@types+node\@22.13.5/node_modules/@types/node/globals.d.ts:136
|
|
||||||
|
|
||||||
Create .stack property on a target object
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### targetObject
|
|
||||||
|
|
||||||
`object`
|
|
||||||
|
|
||||||
##### constructorOpt?
|
|
||||||
|
|
||||||
`Function`
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
`Error.captureStackTrace`
|
|
@@ -1,45 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/DetailedError.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/DetailedError.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: DetailedError
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/utils.ts:783](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L783)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### error?
|
|
||||||
|
|
||||||
> `optional` **error**: `any`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/utils.ts:788](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L788)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### hash
|
|
||||||
|
|
||||||
> **hash**: `any`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/utils.ts:786](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L786)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### message?
|
|
||||||
|
|
||||||
> `optional` **message**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/utils.ts:789](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L789)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### str
|
|
||||||
|
|
||||||
> **str**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/utils.ts:784](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/utils.ts#L784)
|
|
@@ -1,37 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/ExternalDiagramDefinition.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/ExternalDiagramDefinition.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: ExternalDiagramDefinition
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/diagram-api/types.ts:99](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L99)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### detector
|
|
||||||
|
|
||||||
> **detector**: `DiagramDetector`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/diagram-api/types.ts:101](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L101)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### id
|
|
||||||
|
|
||||||
> **id**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/diagram-api/types.ts:100](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L100)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### loader
|
|
||||||
|
|
||||||
> **loader**: `DiagramLoader`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/diagram-api/types.ts:102](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L102)
|
|
@@ -1,41 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutData.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutData.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: LayoutData
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/types.ts:145](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L145)
|
|
||||||
|
|
||||||
## Indexable
|
|
||||||
|
|
||||||
\[`key`: `string`]: `any`
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### config
|
|
||||||
|
|
||||||
> **config**: [`MermaidConfig`](MermaidConfig.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/types.ts:148](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L148)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### edges
|
|
||||||
|
|
||||||
> **edges**: `Edge`\[]
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/types.ts:147](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L147)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### nodes
|
|
||||||
|
|
||||||
> **nodes**: `Node`\[]
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/types.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L146)
|
|
@@ -1,37 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutLoaderDefinition.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutLoaderDefinition.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: LayoutLoaderDefinition
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/render.ts:21](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L21)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### algorithm?
|
|
||||||
|
|
||||||
> `optional` **algorithm**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/render.ts:24](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L24)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### loader
|
|
||||||
|
|
||||||
> **loader**: `LayoutLoader`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/render.ts:23](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L23)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### name
|
|
||||||
|
|
||||||
> **name**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/render.ts:22](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L22)
|
|
@@ -1,427 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/Mermaid.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/Mermaid.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: Mermaid
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:418](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L418)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### contentLoaded()
|
|
||||||
|
|
||||||
> **contentLoaded**: () => `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:436](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L436)
|
|
||||||
|
|
||||||
\##contentLoaded Callback function that is called when page is loaded. This functions fetches
|
|
||||||
configuration for mermaid rendering and calls init for rendering the mermaid diagrams on the
|
|
||||||
page.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### detectType()
|
|
||||||
|
|
||||||
> **detectType**: (`text`, `config`?) => `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:438](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L438)
|
|
||||||
|
|
||||||
Detects the type of the graph text.
|
|
||||||
|
|
||||||
Takes into consideration the possible existence of an `%%init` directive
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### text
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
The text defining the graph. For example:
|
|
||||||
|
|
||||||
```mermaid-example
|
|
||||||
%%{initialize: {"startOnLoad": true, logLevel: "fatal" }}%%
|
|
||||||
graph LR
|
|
||||||
a-->b
|
|
||||||
b-->c
|
|
||||||
c-->d
|
|
||||||
d-->e
|
|
||||||
e-->f
|
|
||||||
f-->g
|
|
||||||
g-->h
|
|
||||||
```
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
%%{initialize: {"startOnLoad": true, logLevel: "fatal" }}%%
|
|
||||||
graph LR
|
|
||||||
a-->b
|
|
||||||
b-->c
|
|
||||||
c-->d
|
|
||||||
d-->e
|
|
||||||
e-->f
|
|
||||||
f-->g
|
|
||||||
g-->h
|
|
||||||
```
|
|
||||||
|
|
||||||
##### config?
|
|
||||||
|
|
||||||
[`MermaidConfig`](MermaidConfig.md)
|
|
||||||
|
|
||||||
The mermaid config.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
A graph definition key
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ~~init()~~
|
|
||||||
|
|
||||||
> **init**: (`config`?, `nodes`?, `callback`?) => `Promise`<`void`>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:431](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L431)
|
|
||||||
|
|
||||||
## init
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### config?
|
|
||||||
|
|
||||||
[`MermaidConfig`](MermaidConfig.md)
|
|
||||||
|
|
||||||
**Deprecated**, please set configuration in [initialize](Mermaid.md#initialize).
|
|
||||||
|
|
||||||
##### nodes?
|
|
||||||
|
|
||||||
**Default**: `.mermaid`. One of the following:
|
|
||||||
|
|
||||||
- A DOM Node
|
|
||||||
- An array of DOM nodes (as would come from a jQuery selector)
|
|
||||||
- A W3C selector, a la `.mermaid`
|
|
||||||
|
|
||||||
`string` | `HTMLElement` | `NodeListOf`<`HTMLElement`>
|
|
||||||
|
|
||||||
##### callback?
|
|
||||||
|
|
||||||
(`id`) => `unknown`
|
|
||||||
|
|
||||||
Called once for each rendered diagram's id.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`Promise`<`void`>
|
|
||||||
|
|
||||||
#### Deprecated
|
|
||||||
|
|
||||||
Use [initialize](Mermaid.md#initialize) and [run](Mermaid.md#run) instead.
|
|
||||||
|
|
||||||
Renders the mermaid diagrams
|
|
||||||
|
|
||||||
#### Deprecated
|
|
||||||
|
|
||||||
Use [initialize](Mermaid.md#initialize) and [run](Mermaid.md#run) instead.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### initialize()
|
|
||||||
|
|
||||||
> **initialize**: (`config`) => `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:435](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L435)
|
|
||||||
|
|
||||||
Used to set configurations for mermaid.
|
|
||||||
This function should be called before the run function.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### config
|
|
||||||
|
|
||||||
[`MermaidConfig`](MermaidConfig.md)
|
|
||||||
|
|
||||||
Configuration object for mermaid.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ~~mermaidAPI~~
|
|
||||||
|
|
||||||
> **mermaidAPI**: `Readonly`<{ `defaultConfig`: [`MermaidConfig`](MermaidConfig.md); `getConfig`: () => [`MermaidConfig`](MermaidConfig.md); `getDiagramFromText`: (`text`, `metadata`) => `Promise`<`Diagram`>; `getSiteConfig`: () => [`MermaidConfig`](MermaidConfig.md); `globalReset`: () => `void`; `initialize`: (`userOptions`) => `void`; `parse`: (`text`, `parseOptions`) => `Promise`<`false` | [`ParseResult`](ParseResult.md)>(`text`, `parseOptions`?) => `Promise`<[`ParseResult`](ParseResult.md)>; `render`: (`id`, `text`, `svgContainingElement`?) => `Promise`<[`RenderResult`](RenderResult.md)>; `reset`: () => `void`; `setConfig`: (`conf`) => [`MermaidConfig`](MermaidConfig.md); `updateSiteConfig`: (`conf`) => [`MermaidConfig`](MermaidConfig.md); }>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:425](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L425)
|
|
||||||
|
|
||||||
**`Internal`**
|
|
||||||
|
|
||||||
#### Deprecated
|
|
||||||
|
|
||||||
Use [parse](Mermaid.md#parse) and [render](Mermaid.md#render) instead. Please [open a discussion](https://github.com/mermaid-js/mermaid/discussions) if your use case does not fit the new API.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### parse()
|
|
||||||
|
|
||||||
> **parse**: (`text`, `parseOptions`) => `Promise`<`false` | [`ParseResult`](ParseResult.md)>(`text`, `parseOptions`?) => `Promise`<[`ParseResult`](ParseResult.md)>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:426](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L426)
|
|
||||||
|
|
||||||
Parse the text and validate the syntax.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### text
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
The mermaid diagram definition.
|
|
||||||
|
|
||||||
##### parseOptions
|
|
||||||
|
|
||||||
[`ParseOptions`](ParseOptions.md) & `object`
|
|
||||||
|
|
||||||
Options for parsing.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`Promise`<`false` | [`ParseResult`](ParseResult.md)>
|
|
||||||
|
|
||||||
An object with the `diagramType` set to type of the diagram if valid. Otherwise `false` if parseOptions.suppressErrors is `true`.
|
|
||||||
|
|
||||||
#### See
|
|
||||||
|
|
||||||
[ParseOptions](ParseOptions.md)
|
|
||||||
|
|
||||||
#### Throws
|
|
||||||
|
|
||||||
Error if the diagram is invalid and parseOptions.suppressErrors is false or not set.
|
|
||||||
|
|
||||||
Parse the text and validate the syntax.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### text
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
The mermaid diagram definition.
|
|
||||||
|
|
||||||
##### parseOptions?
|
|
||||||
|
|
||||||
[`ParseOptions`](ParseOptions.md)
|
|
||||||
|
|
||||||
Options for parsing.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`Promise`<[`ParseResult`](ParseResult.md)>
|
|
||||||
|
|
||||||
An object with the `diagramType` set to type of the diagram if valid. Otherwise `false` if parseOptions.suppressErrors is `true`.
|
|
||||||
|
|
||||||
#### See
|
|
||||||
|
|
||||||
[ParseOptions](ParseOptions.md)
|
|
||||||
|
|
||||||
#### Throws
|
|
||||||
|
|
||||||
Error if the diagram is invalid and parseOptions.suppressErrors is false or not set.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### parseError?
|
|
||||||
|
|
||||||
> `optional` **parseError**: [`ParseErrorFunction`](../type-aliases/ParseErrorFunction.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:420](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L420)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### registerExternalDiagrams()
|
|
||||||
|
|
||||||
> **registerExternalDiagrams**: (`diagrams`, `opts`) => `Promise`<`void`>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:434](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L434)
|
|
||||||
|
|
||||||
Used to register external diagram types.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### diagrams
|
|
||||||
|
|
||||||
[`ExternalDiagramDefinition`](ExternalDiagramDefinition.md)\[]
|
|
||||||
|
|
||||||
Array of [ExternalDiagramDefinition](ExternalDiagramDefinition.md).
|
|
||||||
|
|
||||||
##### opts
|
|
||||||
|
|
||||||
If opts.lazyLoad is false, the diagrams will be loaded immediately.
|
|
||||||
|
|
||||||
###### lazyLoad?
|
|
||||||
|
|
||||||
`boolean` = `true`
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`Promise`<`void`>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### registerIconPacks()
|
|
||||||
|
|
||||||
> **registerIconPacks**: (`iconLoaders`) => `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:439](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L439)
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### iconLoaders
|
|
||||||
|
|
||||||
`IconLoader`\[]
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### registerLayoutLoaders()
|
|
||||||
|
|
||||||
> **registerLayoutLoaders**: (`loaders`) => `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:433](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L433)
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### loaders
|
|
||||||
|
|
||||||
[`LayoutLoaderDefinition`](LayoutLoaderDefinition.md)\[]
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### render()
|
|
||||||
|
|
||||||
> **render**: (`id`, `text`, `svgContainingElement`?) => `Promise`<[`RenderResult`](RenderResult.md)>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:427](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L427)
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### id
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
##### text
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
##### svgContainingElement?
|
|
||||||
|
|
||||||
`Element`
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`Promise`<[`RenderResult`](RenderResult.md)>
|
|
||||||
|
|
||||||
#### Deprecated
|
|
||||||
|
|
||||||
- use the `mermaid.render` function instead of `mermaid.mermaidAPI.render`
|
|
||||||
|
|
||||||
Deprecated for external use.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### run()
|
|
||||||
|
|
||||||
> **run**: (`options`) => `Promise`<`void`>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:432](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L432)
|
|
||||||
|
|
||||||
## run
|
|
||||||
|
|
||||||
Function that goes through the document to find the chart definitions in there and render them.
|
|
||||||
|
|
||||||
The function tags the processed attributes with the attribute data-processed and ignores found
|
|
||||||
elements with the attribute already set. This way the init function can be triggered several
|
|
||||||
times.
|
|
||||||
|
|
||||||
```mermaid-example
|
|
||||||
graph LR;
|
|
||||||
a(Find elements)-->b{Processed}
|
|
||||||
b-->|Yes|c(Leave element)
|
|
||||||
b-->|No |d(Transform)
|
|
||||||
```
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
graph LR;
|
|
||||||
a(Find elements)-->b{Processed}
|
|
||||||
b-->|Yes|c(Leave element)
|
|
||||||
b-->|No |d(Transform)
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders the mermaid diagrams
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### options
|
|
||||||
|
|
||||||
[`RunOptions`](RunOptions.md) = `...`
|
|
||||||
|
|
||||||
Optional runtime configs
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`Promise`<`void`>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### setParseErrorHandler()
|
|
||||||
|
|
||||||
> **setParseErrorHandler**: (`parseErrorHandler`) => `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:437](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L437)
|
|
||||||
|
|
||||||
## setParseErrorHandler Alternative to directly setting parseError using:
|
|
||||||
|
|
||||||
```js
|
|
||||||
mermaid.parseError = function (err, hash) {
|
|
||||||
forExampleDisplayErrorInGui(err); // do something with the error
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
This is provided for environments where the mermaid object can't directly have a new member added
|
|
||||||
to it (eg. dart interop wrapper). (Initially there is no parseError member of mermaid).
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### parseErrorHandler
|
|
||||||
|
|
||||||
(`err`, `hash`) => `void`
|
|
||||||
|
|
||||||
New parseError() callback.
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### startOnLoad
|
|
||||||
|
|
||||||
> **startOnLoad**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:419](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L419)
|
|
@@ -1,461 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/MermaidConfig.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/MermaidConfig.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: MermaidConfig
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:58](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L58)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### altFontFamily?
|
|
||||||
|
|
||||||
> `optional` **altFontFamily**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:122](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L122)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### architecture?
|
|
||||||
|
|
||||||
> `optional` **architecture**: `ArchitectureDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:194](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L194)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### arrowMarkerAbsolute?
|
|
||||||
|
|
||||||
> `optional` **arrowMarkerAbsolute**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:141](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L141)
|
|
||||||
|
|
||||||
Controls whether or arrow markers in html code are absolute paths or anchors.
|
|
||||||
This matters if you are using base tag settings.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### block?
|
|
||||||
|
|
||||||
> `optional` **block**: `BlockDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:201](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L201)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### c4?
|
|
||||||
|
|
||||||
> `optional` **c4**: `C4DiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:198](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L198)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### class?
|
|
||||||
|
|
||||||
> `optional` **class**: `ClassDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:187](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L187)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### darkMode?
|
|
||||||
|
|
||||||
> `optional` **darkMode**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L113)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### deterministicIds?
|
|
||||||
|
|
||||||
> `optional` **deterministicIds**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:174](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L174)
|
|
||||||
|
|
||||||
This option controls if the generated ids of nodes in the SVG are
|
|
||||||
generated randomly or based on a seed.
|
|
||||||
If set to `false`, the IDs are generated based on the current date and
|
|
||||||
thus are not deterministic. This is the default behavior.
|
|
||||||
|
|
||||||
This matters if your files are checked into source control e.g. git and
|
|
||||||
should not change unless content is changed.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### deterministicIDSeed?
|
|
||||||
|
|
||||||
> `optional` **deterministicIDSeed**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:181](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L181)
|
|
||||||
|
|
||||||
This option is the optional seed for deterministic ids.
|
|
||||||
If set to `undefined` but deterministicIds is `true`, a simple number iterator is used.
|
|
||||||
You can set this attribute to base the seed on a static string.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### dompurifyConfig?
|
|
||||||
|
|
||||||
> `optional` **dompurifyConfig**: `Config`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:202](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L202)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### elk?
|
|
||||||
|
|
||||||
> `optional` **elk**: `object`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:91](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L91)
|
|
||||||
|
|
||||||
#### cycleBreakingStrategy?
|
|
||||||
|
|
||||||
> `optional` **cycleBreakingStrategy**: `"GREEDY"` | `"DEPTH_FIRST"` | `"INTERACTIVE"` | `"MODEL_ORDER"` | `"GREEDY_MODEL_ORDER"`
|
|
||||||
|
|
||||||
This strategy decides how to find cycles in the graph and deciding which edges need adjustment to break loops.
|
|
||||||
|
|
||||||
#### mergeEdges?
|
|
||||||
|
|
||||||
> `optional` **mergeEdges**: `boolean`
|
|
||||||
|
|
||||||
Elk specific option that allows edges to share path where it convenient. It can make for pretty diagrams but can also make it harder to read the diagram.
|
|
||||||
|
|
||||||
#### nodePlacementStrategy?
|
|
||||||
|
|
||||||
> `optional` **nodePlacementStrategy**: `"SIMPLE"` | `"NETWORK_SIMPLEX"` | `"LINEAR_SEGMENTS"` | `"BRANDES_KOEPF"`
|
|
||||||
|
|
||||||
Elk specific option affecting how nodes are placed.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### er?
|
|
||||||
|
|
||||||
> `optional` **er**: `ErDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:189](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L189)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### flowchart?
|
|
||||||
|
|
||||||
> `optional` **flowchart**: `FlowchartDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:182](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L182)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### fontFamily?
|
|
||||||
|
|
||||||
> `optional` **fontFamily**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:121](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L121)
|
|
||||||
|
|
||||||
Specifies the font to be used in the rendered diagrams.
|
|
||||||
Can be any possible CSS `font-family`.
|
|
||||||
See <https://developer.mozilla.org/en-US/docs/Web/CSS/font-family>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### fontSize?
|
|
||||||
|
|
||||||
> `optional` **fontSize**: `number`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:204](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L204)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### forceLegacyMathML?
|
|
||||||
|
|
||||||
> `optional` **forceLegacyMathML**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:163](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L163)
|
|
||||||
|
|
||||||
This option forces Mermaid to rely on KaTeX's own stylesheet for rendering MathML. Due to differences between OS
|
|
||||||
fonts and browser's MathML implementation, this option is recommended if consistent rendering is important.
|
|
||||||
If set to true, ignores legacyMathML.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### gantt?
|
|
||||||
|
|
||||||
> `optional` **gantt**: `GanttDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:184](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L184)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### gitGraph?
|
|
||||||
|
|
||||||
> `optional` **gitGraph**: `GitGraphDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:197](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L197)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### handDrawnSeed?
|
|
||||||
|
|
||||||
> `optional` **handDrawnSeed**: `number`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:76](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L76)
|
|
||||||
|
|
||||||
Defines the seed to be used when using handDrawn look. This is important for the automated tests as they will always find differences without the seed. The default value is 0 which gives a random seed.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### htmlLabels?
|
|
||||||
|
|
||||||
> `optional` **htmlLabels**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:114](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L114)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### journey?
|
|
||||||
|
|
||||||
> `optional` **journey**: `JourneyDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:185](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L185)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### kanban?
|
|
||||||
|
|
||||||
> `optional` **kanban**: `KanbanDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:196](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L196)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### layout?
|
|
||||||
|
|
||||||
> `optional` **layout**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:81](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L81)
|
|
||||||
|
|
||||||
Defines which layout algorithm to use for rendering the diagram.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### legacyMathML?
|
|
||||||
|
|
||||||
> `optional` **legacyMathML**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:156](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L156)
|
|
||||||
|
|
||||||
This option specifies if Mermaid can expect the dependent to include KaTeX stylesheets for browsers
|
|
||||||
without their own MathML implementation. If this option is disabled and MathML is not supported, the math
|
|
||||||
equations are replaced with a warning. If this option is enabled and MathML is not supported, Mermaid will
|
|
||||||
fall back to legacy rendering for KaTeX.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### logLevel?
|
|
||||||
|
|
||||||
> `optional` **logLevel**: `0` | `2` | `1` | `"trace"` | `"debug"` | `"info"` | `"warn"` | `"error"` | `"fatal"` | `3` | `4` | `5`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:127](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L127)
|
|
||||||
|
|
||||||
This option decides the amount of logging to be used by mermaid.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### look?
|
|
||||||
|
|
||||||
> `optional` **look**: `"classic"` | `"handDrawn"`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:71](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L71)
|
|
||||||
|
|
||||||
Defines which main look to use for the diagram.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### markdownAutoWrap?
|
|
||||||
|
|
||||||
> `optional` **markdownAutoWrap**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:205](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L205)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### maxEdges?
|
|
||||||
|
|
||||||
> `optional` **maxEdges**: `number`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:90](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L90)
|
|
||||||
|
|
||||||
Defines the maximum number of edges that can be drawn in a graph.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### maxTextSize?
|
|
||||||
|
|
||||||
> `optional` **maxTextSize**: `number`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:85](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L85)
|
|
||||||
|
|
||||||
The maximum allowed size of the users text diagram
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### mindmap?
|
|
||||||
|
|
||||||
> `optional` **mindmap**: `MindmapDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:195](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L195)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### packet?
|
|
||||||
|
|
||||||
> `optional` **packet**: `PacketDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:200](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L200)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### pie?
|
|
||||||
|
|
||||||
> `optional` **pie**: `PieDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:190](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L190)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### quadrantChart?
|
|
||||||
|
|
||||||
> `optional` **quadrantChart**: `QuadrantChartConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:191](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L191)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### requirement?
|
|
||||||
|
|
||||||
> `optional` **requirement**: `RequirementDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:193](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L193)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### sankey?
|
|
||||||
|
|
||||||
> `optional` **sankey**: `SankeyDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:199](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L199)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### secure?
|
|
||||||
|
|
||||||
> `optional` **secure**: `string`\[]
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:148](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L148)
|
|
||||||
|
|
||||||
This option controls which `currentConfig` keys are considered secure and
|
|
||||||
can only be changed via call to `mermaid.initialize`.
|
|
||||||
This prevents malicious graph directives from overriding a site's default security.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### securityLevel?
|
|
||||||
|
|
||||||
> `optional` **securityLevel**: `"strict"` | `"loose"` | `"antiscript"` | `"sandbox"`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:131](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L131)
|
|
||||||
|
|
||||||
Level of trust for parsed diagram
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### sequence?
|
|
||||||
|
|
||||||
> `optional` **sequence**: `SequenceDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:183](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L183)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### startOnLoad?
|
|
||||||
|
|
||||||
> `optional` **startOnLoad**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:135](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L135)
|
|
||||||
|
|
||||||
Dictates whether mermaid starts on Page load
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### state?
|
|
||||||
|
|
||||||
> `optional` **state**: `StateDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:188](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L188)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### suppressErrorRendering?
|
|
||||||
|
|
||||||
> `optional` **suppressErrorRendering**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:211](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L211)
|
|
||||||
|
|
||||||
Suppresses inserting 'Syntax error' diagram in the DOM.
|
|
||||||
This is useful when you want to control how to handle syntax errors in your application.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### theme?
|
|
||||||
|
|
||||||
> `optional` **theme**: `"default"` | `"base"` | `"dark"` | `"forest"` | `"neutral"` | `"null"`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:64](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L64)
|
|
||||||
|
|
||||||
Theme, the CSS style sheet.
|
|
||||||
You may also use `themeCSS` to override this value.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### themeCSS?
|
|
||||||
|
|
||||||
> `optional` **themeCSS**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:66](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L66)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### themeVariables?
|
|
||||||
|
|
||||||
> `optional` **themeVariables**: `any`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:65](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L65)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### timeline?
|
|
||||||
|
|
||||||
> `optional` **timeline**: `TimelineDiagramConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:186](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L186)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### wrap?
|
|
||||||
|
|
||||||
> `optional` **wrap**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:203](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L203)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### xyChart?
|
|
||||||
|
|
||||||
> `optional` **xyChart**: `XYChartConfig`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/config.type.ts:192](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L192)
|
|
@@ -1,24 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/ParseOptions.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/ParseOptions.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: ParseOptions
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/types.ts:59](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L59)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### suppressErrors?
|
|
||||||
|
|
||||||
> `optional` **suppressErrors**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/types.ts:64](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L64)
|
|
||||||
|
|
||||||
If `true`, parse will return `false` instead of throwing error when the diagram is invalid.
|
|
||||||
The `parseError` function will not be called.
|
|
@@ -1,33 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/ParseResult.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/ParseResult.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: ParseResult
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/types.ts:67](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L67)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### config
|
|
||||||
|
|
||||||
> **config**: [`MermaidConfig`](MermaidConfig.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/types.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L75)
|
|
||||||
|
|
||||||
The config passed as YAML frontmatter or directives
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### diagramType
|
|
||||||
|
|
||||||
> **diagramType**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/types.ts:71](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L71)
|
|
||||||
|
|
||||||
The diagram type, e.g. 'flowchart', 'sequence', etc.
|
|
@@ -1,21 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/RenderOptions.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/RenderOptions.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: RenderOptions
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/render.ts:7](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L7)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### algorithm?
|
|
||||||
|
|
||||||
> `optional` **algorithm**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/rendering-util/render.ts:8](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L8)
|
|
@@ -1,60 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/RenderResult.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/RenderResult.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: RenderResult
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/types.ts:85](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L85)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### bindFunctions()?
|
|
||||||
|
|
||||||
> `optional` **bindFunctions**: (`element`) => `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/types.ts:103](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L103)
|
|
||||||
|
|
||||||
Bind function to be called after the svg has been inserted into the DOM.
|
|
||||||
This is necessary for adding event listeners to the elements in the svg.
|
|
||||||
|
|
||||||
```js
|
|
||||||
const { svg, bindFunctions } = await mermaid.render('id1', 'graph TD;A-->B');
|
|
||||||
div.innerHTML = svg;
|
|
||||||
bindFunctions?.(div); // To call bindFunctions only if it's present.
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### element
|
|
||||||
|
|
||||||
`Element`
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### diagramType
|
|
||||||
|
|
||||||
> **diagramType**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/types.ts:93](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L93)
|
|
||||||
|
|
||||||
The diagram type, e.g. 'flowchart', 'sequence', etc.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### svg
|
|
||||||
|
|
||||||
> **svg**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/types.ts:89](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L89)
|
|
||||||
|
|
||||||
The svg code for the rendered graph.
|
|
@@ -1,63 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/RunOptions.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/RunOptions.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Interface: RunOptions
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:41](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L41)
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### nodes?
|
|
||||||
|
|
||||||
> `optional` **nodes**: `ArrayLike`<`HTMLElement`>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:49](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L49)
|
|
||||||
|
|
||||||
The nodes to render. If this is set, `querySelector` will be ignored.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### postRenderCallback()?
|
|
||||||
|
|
||||||
> `optional` **postRenderCallback**: (`id`) => `unknown`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:53](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L53)
|
|
||||||
|
|
||||||
A callback to call after each diagram is rendered.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
##### id
|
|
||||||
|
|
||||||
`string`
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`unknown`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### querySelector?
|
|
||||||
|
|
||||||
> `optional` **querySelector**: `string`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:45](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L45)
|
|
||||||
|
|
||||||
The query selector to use when finding elements to render. Default: `".mermaid"`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### suppressErrors?
|
|
||||||
|
|
||||||
> `optional` **suppressErrors**: `boolean`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:57](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L57)
|
|
||||||
|
|
||||||
If `true`, errors will be logged to the console, but not thrown. Default: `false`
|
|
@@ -1,15 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/type-aliases/InternalHelpers.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/type-aliases/InternalHelpers.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Type Alias: InternalHelpers
|
|
||||||
|
|
||||||
> **InternalHelpers**: _typeof_ `internalHelpers`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/internals.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/internals.ts#L33)
|
|
@@ -1,29 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/type-aliases/ParseErrorFunction.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/type-aliases/ParseErrorFunction.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Type Alias: ParseErrorFunction()
|
|
||||||
|
|
||||||
> **ParseErrorFunction**: (`err`, `hash`?) => `void`
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/Diagram.ts:10](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/Diagram.ts#L10)
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
### err
|
|
||||||
|
|
||||||
`string` | [`DetailedError`](../interfaces/DetailedError.md) | `unknown`
|
|
||||||
|
|
||||||
### hash?
|
|
||||||
|
|
||||||
`any`
|
|
||||||
|
|
||||||
## Returns
|
|
||||||
|
|
||||||
`void`
|
|
@@ -1,15 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/type-aliases/SVG.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/type-aliases/SVG.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Type Alias: SVG
|
|
||||||
|
|
||||||
> **SVG**: `d3.Selection`<`SVGSVGElement`, `unknown`, `Element` | `null`, `unknown`>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/diagram-api/types.ts:130](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L130)
|
|
@@ -1,15 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/type-aliases/SVGGroup.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/type-aliases/SVGGroup.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Type Alias: SVGGroup
|
|
||||||
|
|
||||||
> **SVGGroup**: `d3.Selection`<`SVGGElement`, `unknown`, `Element` | `null`, `unknown`>
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/diagram-api/types.ts:132](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L132)
|
|
@@ -1,15 +0,0 @@
|
|||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
||||||
>
|
|
||||||
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/variables/default.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/variables/default.md).
|
|
||||||
|
|
||||||
[**mermaid**](../../README.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Variable: default
|
|
||||||
|
|
||||||
> `const` **default**: [`Mermaid`](../interfaces/Mermaid.md)
|
|
||||||
|
|
||||||
Defined in: [packages/mermaid/src/mermaid.ts:442](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L442)
|
|
295
docs/config/setup/modules/config.md
Normal file
295
docs/config/setup/modules/config.md
Normal file
@@ -0,0 +1,295 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/modules/config.md](../../../../packages/mermaid/src/docs/config/setup/modules/config.md).
|
||||||
|
|
||||||
|
# Module: config
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
- [defaultConfig](config.md#defaultconfig)
|
||||||
|
|
||||||
|
### Functions
|
||||||
|
|
||||||
|
- [addDirective](config.md#adddirective)
|
||||||
|
- [getConfig](config.md#getconfig)
|
||||||
|
- [getSiteConfig](config.md#getsiteconfig)
|
||||||
|
- [reset](config.md#reset)
|
||||||
|
- [sanitize](config.md#sanitize)
|
||||||
|
- [saveConfigFromInitialize](config.md#saveconfigfrominitialize)
|
||||||
|
- [setConfig](config.md#setconfig)
|
||||||
|
- [setSiteConfig](config.md#setsiteconfig)
|
||||||
|
- [updateCurrentConfig](config.md#updatecurrentconfig)
|
||||||
|
- [updateSiteConfig](config.md#updatesiteconfig)
|
||||||
|
|
||||||
|
## Variables
|
||||||
|
|
||||||
|
### defaultConfig
|
||||||
|
|
||||||
|
• `Const` **defaultConfig**: [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:8](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L8)
|
||||||
|
|
||||||
|
## Functions
|
||||||
|
|
||||||
|
### addDirective
|
||||||
|
|
||||||
|
▸ **addDirective**(`directive`): `void`
|
||||||
|
|
||||||
|
Pushes in a directive to the configuration
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :---------- | :-------------------------------------------------------- | :----------------------- |
|
||||||
|
| `directive` | [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md) | The directive to push in |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:188](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L188)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### getConfig
|
||||||
|
|
||||||
|
▸ **getConfig**(): [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
## getConfig
|
||||||
|
|
||||||
|
| Function | Description | Type | Return Values |
|
||||||
|
| --------- | ------------------------- | ----------- | ------------------------------ |
|
||||||
|
| getConfig | Obtains the currentConfig | Get Request | Any Values from current Config |
|
||||||
|
|
||||||
|
**Notes**: Avoid calling this function repeatedly. Instead, store the result in a variable and use it, and pass it down to function calls.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
The currentConfig
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:131](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L131)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### getSiteConfig
|
||||||
|
|
||||||
|
▸ **getSiteConfig**(): [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
## getSiteConfig
|
||||||
|
|
||||||
|
| Function | Description | Type | Values |
|
||||||
|
| ------------- | ------------------------------------------------- | ----------- | -------------------------------- |
|
||||||
|
| setSiteConfig | Returns the current siteConfig base configuration | Get Request | Returns Any Values in siteConfig |
|
||||||
|
|
||||||
|
**Notes**: Returns **any** values in siteConfig.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
The siteConfig
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:96](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L96)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### reset
|
||||||
|
|
||||||
|
▸ **reset**(`config?`): `void`
|
||||||
|
|
||||||
|
## reset
|
||||||
|
|
||||||
|
| Function | Description | Type | Required | Values |
|
||||||
|
| -------- | ---------------------------- | ----------- | -------- | ------ |
|
||||||
|
| reset | Resets currentConfig to conf | Put Request | Required | None |
|
||||||
|
|
||||||
|
## conf
|
||||||
|
|
||||||
|
| Parameter | Description | Type | Required | Values |
|
||||||
|
| --------- | -------------------------------------------------------------- | ---------- | -------- | -------------------------------------------- |
|
||||||
|
| conf | base set of values, which currentConfig could be **reset** to. | Dictionary | Required | Any Values, with respect to the secure Array |
|
||||||
|
|
||||||
|
**Notes**: (default: current siteConfig ) (optional, default `getSiteConfig()`)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Default value | Description |
|
||||||
|
| :------- | :-------------------------------------------------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `config` | [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md) | `siteConfig` | base set of values, which currentConfig could be **reset** to. Defaults to the current siteConfig (e.g returned by [getSiteConfig](config.md#getsiteconfig)). |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:221](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L221)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### sanitize
|
||||||
|
|
||||||
|
▸ **sanitize**(`options`): `void`
|
||||||
|
|
||||||
|
## sanitize
|
||||||
|
|
||||||
|
| Function | Description | Type | Values |
|
||||||
|
| -------- | -------------------------------------- | ----------- | ------ |
|
||||||
|
| sanitize | Sets the siteConfig to desired values. | Put Request | None |
|
||||||
|
|
||||||
|
Ensures options parameter does not attempt to override siteConfig secure keys **Notes**: modifies
|
||||||
|
options in-place
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :-------- | :---- | :-------------------------------- |
|
||||||
|
| `options` | `any` | The potential setConfig parameter |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L146)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### saveConfigFromInitialize
|
||||||
|
|
||||||
|
▸ **saveConfigFromInitialize**(`conf`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :----- | :-------------------------------------------------------- |
|
||||||
|
| `conf` | [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L75)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### setConfig
|
||||||
|
|
||||||
|
▸ **setConfig**(`conf`): [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
## setConfig
|
||||||
|
|
||||||
|
| Function | Description | Type | Values |
|
||||||
|
| ------------- | ------------------------------------- | ----------- | --------------------------------------- |
|
||||||
|
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
|
||||||
|
|
||||||
|
**Notes**: Sets the currentConfig. The parameter conf is sanitized based on the siteConfig.secure
|
||||||
|
keys. Any values found in conf with key found in siteConfig.secure will be replaced with the
|
||||||
|
corresponding siteConfig value.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :----- | :-------------------------------------------------------- | :-------------------------- |
|
||||||
|
| `conf` | [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md) | The potential currentConfig |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
The currentConfig merged with the sanitized conf
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L113)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### setSiteConfig
|
||||||
|
|
||||||
|
▸ **setSiteConfig**(`conf`): [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
## setSiteConfig
|
||||||
|
|
||||||
|
| Function | Description | Type | Values |
|
||||||
|
| ------------- | ------------------------------------- | ----------- | --------------------------------------- |
|
||||||
|
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
|
||||||
|
|
||||||
|
**Notes:** Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls
|
||||||
|
to reset() will reset the currentConfig to siteConfig. Calls to reset(configApi.defaultConfig)
|
||||||
|
will reset siteConfig and currentConfig to the defaultConfig Note: currentConfig is set in this
|
||||||
|
function _Default value: At default, will mirror Global Config_
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :----- | :-------------------------------------------------------- | :------------------------------------------ |
|
||||||
|
| `conf` | [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md) | The base currentConfig to use as siteConfig |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
The new siteConfig
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:61](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L61)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### updateCurrentConfig
|
||||||
|
|
||||||
|
▸ **updateCurrentConfig**(`siteCfg`, `_directives`): [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------------ | :----------------------------------------------------------- |
|
||||||
|
| `siteCfg` | [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md) |
|
||||||
|
| `_directives` | [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)\[] |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:15](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L15)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### updateSiteConfig
|
||||||
|
|
||||||
|
▸ **updateSiteConfig**(`conf`): [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :----- | :-------------------------------------------------------- |
|
||||||
|
| `conf` | [`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/config.ts:79](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L79)
|
40
docs/config/setup/modules/defaultConfig.md
Normal file
40
docs/config/setup/modules/defaultConfig.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/modules/defaultConfig.md](../../../../packages/mermaid/src/docs/config/setup/modules/defaultConfig.md).
|
||||||
|
|
||||||
|
# Module: defaultConfig
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
- [configKeys](defaultConfig.md#configkeys)
|
||||||
|
- [default](defaultConfig.md#default)
|
||||||
|
|
||||||
|
## Variables
|
||||||
|
|
||||||
|
### configKeys
|
||||||
|
|
||||||
|
• `Const` **configKeys**: `Set`<`string`>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/defaultConfig.ts:270](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L270)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### default
|
||||||
|
|
||||||
|
• `Const` **default**: `RequiredDeep`<[`MermaidConfig`](../interfaces/mermaid.MermaidConfig.md)>
|
||||||
|
|
||||||
|
Default mermaid configuration options.
|
||||||
|
|
||||||
|
Please see the Mermaid config JSON Schema for the default JSON values.
|
||||||
|
Non-JSON JS default values are listed in this file, e.g. functions, or
|
||||||
|
`undefined` (explicitly set so that `configKeys` finds them).
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/defaultConfig.ts:18](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L18)
|
103
docs/config/setup/modules/mermaid.md
Normal file
103
docs/config/setup/modules/mermaid.md
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
||||||
|
>
|
||||||
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/modules/mermaid.md](../../../../packages/mermaid/src/docs/config/setup/modules/mermaid.md).
|
||||||
|
|
||||||
|
# Module: mermaid
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
### Classes
|
||||||
|
|
||||||
|
- [UnknownDiagramError](../classes/mermaid.UnknownDiagramError.md)
|
||||||
|
|
||||||
|
### Interfaces
|
||||||
|
|
||||||
|
- [DetailedError](../interfaces/mermaid.DetailedError.md)
|
||||||
|
- [ExternalDiagramDefinition](../interfaces/mermaid.ExternalDiagramDefinition.md)
|
||||||
|
- [LayoutData](../interfaces/mermaid.LayoutData.md)
|
||||||
|
- [LayoutLoaderDefinition](../interfaces/mermaid.LayoutLoaderDefinition.md)
|
||||||
|
- [Mermaid](../interfaces/mermaid.Mermaid.md)
|
||||||
|
- [MermaidConfig](../interfaces/mermaid.MermaidConfig.md)
|
||||||
|
- [ParseOptions](../interfaces/mermaid.ParseOptions.md)
|
||||||
|
- [ParseResult](../interfaces/mermaid.ParseResult.md)
|
||||||
|
- [RenderOptions](../interfaces/mermaid.RenderOptions.md)
|
||||||
|
- [RenderResult](../interfaces/mermaid.RenderResult.md)
|
||||||
|
- [RunOptions](../interfaces/mermaid.RunOptions.md)
|
||||||
|
|
||||||
|
### Type Aliases
|
||||||
|
|
||||||
|
- [InternalHelpers](mermaid.md#internalhelpers)
|
||||||
|
- [ParseErrorFunction](mermaid.md#parseerrorfunction)
|
||||||
|
- [SVG](mermaid.md#svg)
|
||||||
|
- [SVGGroup](mermaid.md#svggroup)
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
- [default](mermaid.md#default)
|
||||||
|
|
||||||
|
## Type Aliases
|
||||||
|
|
||||||
|
### InternalHelpers
|
||||||
|
|
||||||
|
Ƭ **InternalHelpers**: typeof `internalHelpers`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/internals.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/internals.ts#L33)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ParseErrorFunction
|
||||||
|
|
||||||
|
Ƭ **ParseErrorFunction**: (`err`: `string` | [`DetailedError`](../interfaces/mermaid.DetailedError.md) | `unknown`, `hash?`: `any`) => `void`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`err`, `hash?`): `void`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :--------------------------------------------------------------------------------- |
|
||||||
|
| `err` | `string` \| [`DetailedError`](../interfaces/mermaid.DetailedError.md) \| `unknown` |
|
||||||
|
| `hash?` | `any` |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/Diagram.ts:10](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/Diagram.ts#L10)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### SVG
|
||||||
|
|
||||||
|
Ƭ **SVG**: `d3.Selection`<`SVGSVGElement`, `unknown`, `Element` | `null`, `unknown`>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/diagram-api/types.ts:130](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L130)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### SVGGroup
|
||||||
|
|
||||||
|
Ƭ **SVGGroup**: `d3.Selection`<`SVGGElement`, `unknown`, `Element` | `null`, `unknown`>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/diagram-api/types.ts:132](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L132)
|
||||||
|
|
||||||
|
## Variables
|
||||||
|
|
||||||
|
### default
|
||||||
|
|
||||||
|
• `Const` **default**: [`Mermaid`](../interfaces/mermaid.Mermaid.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[packages/mermaid/src/mermaid.ts:442](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L442)
|
@@ -6,122 +6,38 @@ interface Taglines {
|
|||||||
url: string;
|
url: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const allTaglines: { [key: string]: { design: number; taglines: Taglines[] } } = {
|
const taglines: Taglines[] = [
|
||||||
A: {
|
|
||||||
design: 1,
|
|
||||||
taglines: [
|
|
||||||
{
|
{
|
||||||
label: 'Replace ChatGPT Pro, Mermaid.live, and Lucid Chart with Mermaid Chart',
|
label: 'Replace ChatGPT Pro, Mermaid.live, and Lucid Chart with Mermaid Chart',
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=AIbundle_A',
|
url: 'https://www.mermaidchart.com/mermaid-ai?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=aibundle',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Diagram live with teammates in Mermaid Chart',
|
label: 'Diagram live with teammates in Mermaid Chart',
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=teams_A',
|
url: 'https://www.mermaidchart.com/landing?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=team_collaboration',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Use the Visual Editor in Mermaid Chart to design and build diagrams',
|
label: 'Use the Visual Editor in Mermaid Chart to design and build diagrams',
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=visual_editor_A',
|
url: 'https://www.mermaidchart.com/landing?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=visual_editor',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Explore the Mermaid Whiteboard from the creators of Mermaid',
|
label: 'Explore the Mermaid Whiteboard from the creators of Mermaid',
|
||||||
url: 'https://www.mermaidchart.com/whiteboard?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=whiteboard_A',
|
url: 'https://www.mermaidchart.com/whiteboard?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=whiteboard',
|
||||||
},
|
},
|
||||||
],
|
];
|
||||||
},
|
|
||||||
B: {
|
|
||||||
design: 2,
|
|
||||||
taglines: [
|
|
||||||
{
|
|
||||||
label: 'Replace ChatGPT Pro, Mermaid.live, and Lucid Chart with Mermaid Chart',
|
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=AIbundle_B',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Diagram live with teammates in Mermaid Chart',
|
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=teams_B',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Use the Visual Editor in Mermaid Chart to design and build diagrams',
|
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=visual_editor_B',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Explore the Mermaid Whiteboard from the creators of Mermaid',
|
|
||||||
url: 'https://www.mermaidchart.com/whiteboard?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=whiteboard_B',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
C: {
|
|
||||||
design: 1,
|
|
||||||
taglines: [
|
|
||||||
{
|
|
||||||
label: 'Replace ChatGPT Pro, Mermaid.live, and Lucid Chart with Mermaid Pro',
|
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=AIbundle_C',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Diagram live with teammates in Mermaid Pro',
|
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=teams_C',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Use the Visual Editor in Mermaid Pro to design and build diagrams',
|
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=visual_editor_C',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Explore the Mermaid Whiteboard from the creators of Mermaid',
|
|
||||||
url: 'https://www.mermaidchart.com/whiteboard?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=whiteboard_A',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
D: {
|
|
||||||
design: 2,
|
|
||||||
taglines: [
|
|
||||||
{
|
|
||||||
label: 'Replace ChatGPT Pro, Mermaid.live, and Lucid Chart with Mermaid Pro',
|
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=AIbundle_D',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Diagram live with teammates in Mermaid Pro',
|
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=teams_D',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Use the Visual Editor in Mermaid Pro to design and build diagrams',
|
|
||||||
url: 'https://www.mermaidchart.com/play?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=visual_editor_D',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Explore the Mermaid Whiteboard from the creators of Mermaid',
|
|
||||||
url: 'https://www.mermaidchart.com/whiteboard?utm_source=mermaid_js&utm_medium=banner_ad&utm_campaign=whiteboard_B',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
// Initialize with default values
|
|
||||||
const design: Ref<number> = ref(1);
|
|
||||||
const taglines: Ref<Taglines[]> = ref([]);
|
|
||||||
const index: Ref<number> = ref(0);
|
|
||||||
|
|
||||||
|
let index = ref(Math.floor(Math.random() * taglines.length));
|
||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
// Select a random variant on client side
|
|
||||||
const variant =
|
|
||||||
Object.values(allTaglines)[Math.floor(Math.random() * Object.values(allTaglines).length)];
|
|
||||||
design.value = variant.design;
|
|
||||||
taglines.value = variant.taglines;
|
|
||||||
index.value = Math.floor(Math.random() * taglines.value.length);
|
|
||||||
|
|
||||||
// Set up the interval for cycling through taglines
|
|
||||||
setInterval(() => {
|
setInterval(() => {
|
||||||
index.value = (index.value + 1) % taglines.value.length;
|
index.value = (index.value + 1) % taglines.length;
|
||||||
}, 5_000);
|
}, 5_000);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div
|
<div class="mb-4 w-full top-bar flex p-2 bg-[#E0095F]">
|
||||||
:class="[design === 1 ? 'bg-gradient-to-r from-[#bd34fe] to-[#ff3670] ' : 'bg-[#E0095F]']"
|
|
||||||
class="mb-4 w-full top-bar flex p-2"
|
|
||||||
>
|
|
||||||
<p class="w-full tracking-wide fade-text text-sm">
|
<p class="w-full tracking-wide fade-text text-sm">
|
||||||
<transition name="fade" mode="out-in">
|
<transition name="fade" mode="out-in">
|
||||||
<a
|
<a
|
||||||
v-if="taglines.length > 0 && taglines[index]"
|
|
||||||
:key="index"
|
:key="index"
|
||||||
:href="taglines[index].url"
|
:href="taglines[index].url"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
|
Reference in New Issue
Block a user