mermaid/docs/config/setup/mermaid/interfaces/RenderResult.md

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.

mermaid

---

Interface: RenderResult

Defined in: packages/mermaid/src/types.ts:85

Properties

bindFunctions()?

optional bindFunctions: (element) => void

Defined in: packages/mermaid/src/types.ts:103

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.

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

The diagram type, e.g. 'flowchart', 'sequence', etc.

---

svg

svg: string

Defined in: packages/mermaid/src/types.ts:89

The svg code for the rendered graph.