Skip to content

Interface: RenderResult

mermaid.RenderResult

Properties

bindFunctions

Optional bindFunctions: (element: 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 } = await mermaid.render('id1', 'graph TD;A-->B');
div.innerHTML = svg;
bindFunctions?.(div); // To call bindFunctions only if it's present.

Type declaration

▸ (element): void

Parameters
NameType
elementElement
Returns

void

Defined in

packages/mermaid/src/types.ts:98


diagramType

diagramType: string

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

Defined in

packages/mermaid/src/types.ts:88


svg

svg: string

The svg code for the rendered graph.

Defined in

packages/mermaid/src/types.ts:84