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
cedc1d4e281e09d668159aad5bd016fdccbdb6ff
mermaid/docs/config/setup/interfaces/mermaidAPI.RenderResult.md
Sidharth Vinod cedc1d4e28 Merge branch 'develop' into sidv/tinyMermaid 
* develop: (31 commits)
  make LLM integrations a new headline
  build docs
  ci(e2e): avoid commenting on PRs in CI
  chore: Remove unused imports in block
  Fix spelling
  Update docs
  Lychee ignore chrome webstore
  Update link
  chore(deps): update all patch dependencies
  build(docs): vendor CSS dependencies
  chore(deps): update all minor dependencies
  fix linting issues
  Ran lint:fix
  Fix chrome webstore url causing 404
  Add LLM integration section in productivity tools and add HueHive
  build(deps): update `langium` to `v3` and apply the required changes
  Remove dummy change from e2e.yml
  Remove dummy change
  Remove log
  Format message
  ...
2024-03-08 19:43:56 +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

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.

Type declaration

▸ (element): void

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