marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-15 05:19:58 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
c1d31476cdcf99fdd9e9956a9b31c334c121faf2
mermaid/docs/config/setup/interfaces/mermaidAPI.RenderResult.md
Sidharth Vinod bd1789c54b Merge branch 'next' into sidv/tinyMermaid 
* next: (562 commits)
  Lint
  Remove echo
  RefTest
  Echo event
  Update cypress
  Fix applitools
  Fix applitools
  docs: fix lint
  docs: move community to Discord
  Swap condition blocks to avoid using negation
  Reposition const declaration to ideal place
  Change repetitive values into consts
  docs: fix swimm link
  Fix Update Browserslist
  Use pnpm/action-setup@v2
  Fix lint
  Cleanup e2e.yml
  Ignore push events on merge queue
  Remove ::
  Remove ::
  ...
2024-01-24 09:25:52 +05:30

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/mermaidAPI.RenderResult.md.

Interface: RenderResult

mermaidAPI.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.

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:96

diagramType

• diagramType: string

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

Defined in

mermaidAPI.ts:86

svg

• svg: string

The svg code for the rendered graph.

Defined in

mermaidAPI.ts:82