mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-16 22:09:57 +02:00
7f2902594c
* develop: (59 commits) docs: Update mermaid.init remove date docs: Remove incorrect = chore: Prettier format chore: Update config.type.ts chore Add vitest.workspace.js chore: Stricter TS version chore: Remove MermaidAPI from docs doc: Update deprecation message doc: Update deprecation message fix: prevent escaping label styles chore: update browsers list chore(deps): update all patch dependencies docs: Added demo diagram of bidirectional arrows for sequence diagrams fix(deps): update all patch dependencies chore: Update drupal regex chore: Update pnpm chore: Update docs to remove html tag like text rebuild chore: Use string templates chore: Update docs ...
72 lines
1.6 KiB
Markdown
72 lines
1.6 KiB
Markdown
> **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
|
|
|
|
## 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:43](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L43)
|
|
|
|
---
|
|
|
|
### 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:47](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L47)
|
|
|
|
---
|
|
|
|
### querySelector
|
|
|
|
• `Optional` **querySelector**: `string`
|
|
|
|
The query selector to use when finding elements to render. Default: `".mermaid"`.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/mermaid.ts:39](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L39)
|
|
|
|
---
|
|
|
|
### 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:51](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L51)
|