Files
mermaid/docs/config/setup/modules/mermaid.md
2024-07-06 16:24:08 -05:00

3.5 KiB

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in /packages/mermaid/src/docs/config/setup/modules/mermaid.md.

Module: mermaid

Classes

Interfaces

Type Aliases

IconLibrary

Ƭ IconLibrary: Record<string, IconResolver>

Defined in

packages/mermaid/src/rendering-util/svgRegister.ts:7


IconResolver

Ƭ IconResolver: (parent: Selection<SVGGElement, unknown, Element | null, unknown>, width?: number) => Selection<SVGGElement, unknown, Element | null, unknown>

Type declaration

▸ (parent, width?): Selection<SVGGElement, unknown, Element | null, unknown>

Parameters
Name Type
parent Selection<SVGGElement, unknown, Element | null, unknown>
width? number
Returns

Selection<SVGGElement, unknown, Element | null, unknown>

Defined in

packages/mermaid/src/rendering-util/svgRegister.ts:3


ParseErrorFunction

Ƭ ParseErrorFunction: (err: string | DetailedError | unknown, hash?: any) => void

Type declaration

▸ (err, hash?): void

Parameters
Name Type
err string | DetailedError | unknown
hash? any
Returns

void

Defined in

packages/mermaid/src/Diagram.ts:10

Variables

default

Const default: Mermaid

Defined in

packages/mermaid/src/mermaid.ts:436

Functions

createIcon

createIcon(icon, originalSize): IconResolver

Parameters

Name Type
icon string
originalSize number

Returns

IconResolver

Defined in

packages/mermaid/src/rendering-util/svgRegister.ts:9