Class MermaidManager

A mermaid diagram manager with cache.

Implements

IMermaidManager

Index

Constructors

Properties

_diagrams _themes

Methods

getCachedFigure getMermaid getMermaidVersion initialize makeMermaidCode makeMermaidError makeMermaidFigure renderFigure renderSvg cleanMermaidSvg

Constructors

constructor

new MermaidManager(options?: MermaidManager.IOptions): MermaidManager
Parameters
- options: MermaidManager.IOptions = {}
Returns MermaidManager
- Defined in packages/mermaid/src/manager.ts:32

Properties

`Protected`_diagrams

_diagrams: LruCache<string, HTMLElement>

`Protected`_themes

_themes: null | IThemeManager

Methods

getCachedFigure

getCachedFigure(text: string): null | HTMLElement
Get a pre-cached mermaid figure.

This primarily exists for the needs of marked, which supports async node visitors, but not async rendering.
Parameters
- text: string
Returns null | HTMLElement
Implementation of IMermaidManager.getCachedFigure
- Defined in packages/mermaid/src/manager.ts:78

getMermaid

getMermaid(): Promise<Mermaid>
Get the underlying, potentially un-initialized mermaid module.

Returns Promise<Mermaid>
Implementation of IMermaidManager.getMermaid
- Defined in packages/mermaid/src/manager.ts:61

getMermaidVersion

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

Returns null | string
Implementation of IMermaidManager.getMermaidVersion
- Defined in packages/mermaid/src/manager.ts:68

initialize

initialize(): void
Handle (re)-initializing mermaid based on external values.

Returns void
- Defined in packages/mermaid/src/manager.ts:53

makeMermaidCode

makeMermaidCode(text: string): HTMLElement
Provide a code block with the mermaid source.
Parameters
- text: string
Returns HTMLElement
- Defined in packages/mermaid/src/manager.ts:163

makeMermaidError

makeMermaidError(text: string): Promise<HTMLElement>
Get the parser message element from a failed parse.

This doesn't do much of anything if the text is successfully parsed.
Parameters
- text: string
Returns Promise<HTMLElement>
- Defined in packages/mermaid/src/manager.ts:179

makeMermaidFigure

makeMermaidFigure(info: IRenderInfo): HTMLElement
Extract extra attributes to add to a generated figure.
Parameters
- info: IRenderInfo
Returns HTMLElement
- Defined in packages/mermaid/src/manager.ts:204

renderFigure

renderFigure(text: string): Promise<HTMLElement>
Provide and cache a fully-rendered element, checking the cache first.
Parameters
- text: string
Returns Promise<HTMLElement>
Implementation of IMermaidManager.renderFigure
- Defined in packages/mermaid/src/manager.ts:122

renderSvg

renderSvg(text: string): Promise<IRenderInfo>
Attempt a raw rendering of mermaid to an SVG string, extracting some metadata.
Parameters
- text: string
Returns Promise<IRenderInfo>
Implementation of IMermaidManager.renderSvg
- Defined in packages/mermaid/src/manager.ts:85

`Static`cleanMermaidSvg

cleanMermaidSvg(svg: string): string
Post-process to ensure mermaid diagrams contain only valid SVG and XHTML.
Parameters
- svg: string
Returns string
- Defined in packages/mermaid/src/manager.ts:45