mermaid/docs/config/setup/modules/mermaid.md

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

• UnknownDiagramError

Interfaces

• DetailedError
• ExternalDiagramDefinition
• LayoutData
• LayoutLoaderDefinition
• Mermaid
• MermaidConfig
• ParseOptions
• ParseResult
• RenderOptions
• RenderResult
• RunOptions

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

---

InternalHelpers

Ƭ InternalHelpers: typeof internalHelpers

Defined in

packages/mermaid/src/internals.ts:33

---

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

---

SVG

Ƭ SVG: d3.Selection<SVGSVGElement, unknown, Element | null, unknown>

Defined in

packages/mermaid/src/diagram-api/types.ts:130

---

SVGGroup

Ƭ SVGGroup: d3.Selection<SVGGElement, unknown, Element | null, unknown>

Defined in

packages/mermaid/src/diagram-api/types.ts:132

Variables

default

• Const default: Mermaid

Defined in

packages/mermaid/src/mermaid.ts:446

Functions

createIcon

▸ createIcon(icon, originalSize): IconResolver

Converts an SVG Icon passed as a string into a properly formatted IconResolver

Parameters

Name	Type	Description
icon	string	html code for the svg icon as a string (the SVG tag should not be included)
originalSize	number	the original size of the SVG Icon in pixels

Returns

IconResolver

IconResolver

Defined in

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