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

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:157

---

SVGGroup

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

Defined in

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

Variables

default

• Const default: Mermaid

Defined in

packages/mermaid/src/mermaid.ts:442

Functions

calcIntersections

▸ calcIntersections(startNodeId, endNodeId, startNodeSize, endNodeSize): IntersectionPoint[]

Parameters

Name	Type
startNodeId	string
endNodeId	undefined | string
startNodeSize	NodePosition
endNodeSize	Object
endNodeSize.height?	number
endNodeSize.width?	number
endNodeSize.x	number
endNodeSize.y	number

Returns

IntersectionPoint[]

Throws

If the start node doesn't exist in the nodeDB (e.g. render hasn't been called yet)

Defined in

packages/mermaid/src/rendering-util/layout-algorithms/fixed/index.js:106

---

calcNodeIntersections

▸ calcNodeIntersections(_node1, _node2): IntersectionPoint[] | Promise<IntersectionPoint[]>

Parameters

Name	Type
_node1	Pick<Node, "width" | "height" | "x" | "y" | "id" | "shape" | "intersect">
_node2	Pick<Node, "width" | "height" | "x" | "y" | "id" | "shape" | "intersect">

Returns

IntersectionPoint[] | Promise<IntersectionPoint[]>

Defined in

packages/mermaid/src/rendering-util/layout-algorithms/fixed/index.js:78