mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-15 05:19:58 +02:00
61 lines
1.5 KiB
Markdown
61 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/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:98](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L98)
|
|
|
|
## Properties
|
|
|
|
### bindFunctions()?
|
|
|
|
> `optional` **bindFunctions**: (`element`) => `void`
|
|
|
|
Defined in: [packages/mermaid/src/types.ts:116](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L116)
|
|
|
|
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:106](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L106)
|
|
|
|
The diagram type, e.g. 'flowchart', 'sequence', etc.
|
|
|
|
---
|
|
|
|
### svg
|
|
|
|
> **svg**: `string`
|
|
|
|
Defined in: [packages/mermaid/src/types.ts:102](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L102)
|
|
|
|
The svg code for the rendered graph.
|