mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-18 14:59:53 +02:00
87b0025691
* develop: (189 commits)
Remove unnecessary tests
Remove optional chaining
chore: Update docs
refactor: Use `||` instead of `??`
Update flowchart.md (#4798)
Update flowchart.md (#4792)
core: Adapt changes from 3f7bafb2d7
Update cypress/helpers/util.js
chore: Update docs
chore: Add deprecation notices, improve types
chore: Cleanup gitGraph tests
chore: Fix unit tests
chore(deps): update all patch dependencies
chore: Update docs
Update docs
New Mermaid Live Editor for Confluence Cloud (#4814)
Update link to Discourse theme component (#4811)
Update flowchart.md (#4810)
chore: remove unneeded `CommomDB`
chore: Update docs
...
55 lines
1.3 KiB
Markdown
55 lines
1.3 KiB
Markdown
> **Warning**
|
|
>
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
>
|
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaidAPI.RenderResult.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaidAPI.RenderResult.md).
|
|
|
|
# Interface: RenderResult
|
|
|
|
[mermaidAPI](../modules/mermaidAPI.md).RenderResult
|
|
|
|
## Properties
|
|
|
|
### bindFunctions
|
|
|
|
• `Optional` **bindFunctions**: (`element`: `Element`) => `void`
|
|
|
|
#### Type declaration
|
|
|
|
▸ (`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 } = mermaidAPI.render('id1', 'graph TD;A-->B');
|
|
div.innerHTML = svg;
|
|
bindFunctions?.(div); // To call bindFunctions only if it's present.
|
|
```
|
|
|
|
##### Parameters
|
|
|
|
| Name | Type |
|
|
| :-------- | :-------- |
|
|
| `element` | `Element` |
|
|
|
|
##### Returns
|
|
|
|
`void`
|
|
|
|
#### Defined in
|
|
|
|
[mermaidAPI.ts:98](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L98)
|
|
|
|
---
|
|
|
|
### svg
|
|
|
|
• **svg**: `string`
|
|
|
|
The svg code for the rendered graph.
|
|
|
|
#### Defined in
|
|
|
|
[mermaidAPI.ts:88](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L88)
|