Files
mermaid/docs/config/setup/interfaces/mermaidAPI.RenderResult.md
Sidharth Vinod ea56c64c7b Merge branch 'develop' into alana
* develop: (355 commits)
  Create FUNDING.json
  Update pnpm to v9
  Tiny improvements to Diagram Syntax sidebar
  chore(deps): update all patch dependencies
  chore: address @Yokozuna59's code reviews
  refactor: remove non-null assertion operator
  chore: remove unrefSubSchemas
  chore: Build config types before building types
  chore: Ignore `vite.config.ts.timestamp-`
  chore(deps): update all patch dependencies
  Update docs
  chore: Update ordering
  Added to "others" section on integration with Astro
  feat: use standard edge id function for class,flow,state diagram
  feat(utils): create a standard edge id function
  chore: update browsers list
  chore: rm autocompleted import
  trigger e2e again
  feat(state): add from, to in edge
  fix: classrenderer v2 using in op
  ...
2024-05-24 16:33:41 +05:30

1.5 KiB

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


diagramType

diagramType: string

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

Defined in

mermaidAPI.ts:84


svg

svg: string

The svg code for the rendered graph.

Defined in

mermaidAPI.ts:80