mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-10-31 02:44:17 +01:00
67 lines
1.5 KiB
Markdown
67 lines
1.5 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:94](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L94)
|
|
|
|
---
|
|
|
|
### diagramType
|
|
|
|
• **diagramType**: `string`
|
|
|
|
The diagram type, e.g. 'flowchart', 'sequence', etc.
|
|
|
|
#### Defined in
|
|
|
|
[mermaidAPI.ts:84](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L84)
|
|
|
|
---
|
|
|
|
### svg
|
|
|
|
• **svg**: `string`
|
|
|
|
The svg code for the rendered graph.
|
|
|
|
#### Defined in
|
|
|
|
[mermaidAPI.ts:80](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L80)
|