Mermaid

Unofficial

Both Official Unofficial

Both Own Inherited

Mermaid library instance for rendering diagrams and charts.

Import:

import type { Mermaid } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface Mermaid

Properties

	Property	Type	Description
	startOnLoad	boolean	Whether to start rendering on page load.

Methods

	Method	Returns	Description
	contentLoaded()	void	Trigger content loaded event.
	detectType(text)	string	Detect the type of a Mermaid diagram from its text.
	initialize(config)	void	Initialize Mermaid with the given configuration.
	parse(text, parseOptions?)	Promise<false | ParseResult>	Parse a Mermaid diagram definition.
	parseError(err, hash)	void	Error handler for parse errors.
	registerExternalDiagrams(diagrams, opts?)	Promise<void>	Register external diagram definitions.
	registerIconPacks(iconLoaders)	void	Register icon packs.
	registerLayoutLoaders(loaders)	void	Register layout loaders.
	render(id, text, container?)	Promise<RenderResult>	Render a Mermaid diagram.
	run(options?)	Promise<void>	Run Mermaid rendering on DOM elements.
	setParseErrorHandler(parseErrorHandler)	void	Set a custom parse error handler.

---

Links to this page:

• mermaid
• Window