marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-17 06:20:07 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
4ad85974c6f8e4c8728529be173f49664b48fdbf
mermaid/docs/config/setup/interfaces/mermaid.RenderResult.md
Alois Klink 93239b5f34 Merge commit 'f8746bee0454b01378726d04f9c65bbc3974eb3a' into merge-refactor/improving-rendering-shape-types 
See https://github.com/mermaid-js/mermaid/pull/5974

Conflicts:
	docs/config/setup/interfaces/mermaid.RenderResult.md
	packages/mermaid/src/rendering-util/rendering-elements/shapes/util.ts
2024-10-28 21:03:19 +09:00

1.5 KiB
Raw Blame History

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in /packages/mermaid/src/docs/config/setup/interfaces/mermaid.RenderResult.md.

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.

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
Name Type
element Element
Returns

void

Defined in

packages/mermaid/src/types.ts:105

diagramType

• diagramType: string

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

Defined in

packages/mermaid/src/types.ts:95

svg

• svg: string

The svg code for the rendered graph.

Defined in

packages/mermaid/src/types.ts:91