Interface IMermaidManager

A namespace for public mermaid interfaces.

interface IMermaidManager {
    getCachedFigure(text: string): null | HTMLElement;
    getMermaid(): Promise<Mermaid>;
    getMermaidVersion(): null | string;
    renderFigure(text: string): Promise<HTMLElement>;
    renderSvg(text: string): Promise<IRenderInfo>;
}

Implemented by

MermaidManager

Index

Methods

getCachedFigure getMermaid getMermaidVersion renderFigure renderSvg

Methods

getCachedFigure

getCachedFigure(text: string): null | HTMLElement
Get the pre-cached element for a mermaid string, if available.
Parameters
- text: string
Returns null | HTMLElement
- Defined in packages/mermaid/src/tokens.ts:62

getMermaid

getMermaid(): Promise<Mermaid>
Get the (potentially uninitialized) mermaid module.

Returns Promise<Mermaid>
- Defined in packages/mermaid/src/tokens.ts:42

getMermaidVersion

getMermaidVersion(): null | string
Get the version of the currently-loaded mermaid module

Returns null | string
- Defined in packages/mermaid/src/tokens.ts:47

renderFigure

renderFigure(text: string): Promise<HTMLElement>
Render and cache mermaid source as a figure of an image, or a unsuccessful parser message.
Parameters
- text: string
Returns Promise<HTMLElement>
- Defined in packages/mermaid/src/tokens.ts:57

renderSvg

renderSvg(text: string): Promise<IRenderInfo>
Render mermaid source to an SVG string with extracted metadata.
Parameters
- text: string
Returns Promise<IRenderInfo>
- Defined in packages/mermaid/src/tokens.ts:52