mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-24 01:39:53 +02:00
bed6c5dd0c
We are planning to release an icons library separately. Till we figure out the APIs for those, all external surface for icons are removed, to avoid making a breaking change when the new library comes.
91 lines
2.8 KiB
Markdown
91 lines
2.8 KiB
Markdown
> **Warning**
|
|
>
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
>
|
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/modules/mermaid.md](../../../../packages/mermaid/src/docs/config/setup/modules/mermaid.md).
|
|
|
|
# Module: mermaid
|
|
|
|
## Classes
|
|
|
|
- [UnknownDiagramError](../classes/mermaid.UnknownDiagramError.md)
|
|
|
|
## Interfaces
|
|
|
|
- [DetailedError](../interfaces/mermaid.DetailedError.md)
|
|
- [ExternalDiagramDefinition](../interfaces/mermaid.ExternalDiagramDefinition.md)
|
|
- [LayoutData](../interfaces/mermaid.LayoutData.md)
|
|
- [LayoutLoaderDefinition](../interfaces/mermaid.LayoutLoaderDefinition.md)
|
|
- [Mermaid](../interfaces/mermaid.Mermaid.md)
|
|
- [MermaidConfig](../interfaces/mermaid.MermaidConfig.md)
|
|
- [ParseOptions](../interfaces/mermaid.ParseOptions.md)
|
|
- [ParseResult](../interfaces/mermaid.ParseResult.md)
|
|
- [RenderOptions](../interfaces/mermaid.RenderOptions.md)
|
|
- [RenderResult](../interfaces/mermaid.RenderResult.md)
|
|
- [RunOptions](../interfaces/mermaid.RunOptions.md)
|
|
|
|
## Type Aliases
|
|
|
|
### InternalHelpers
|
|
|
|
Ƭ **InternalHelpers**: typeof `internalHelpers`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/internals.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/internals.ts#L33)
|
|
|
|
---
|
|
|
|
### ParseErrorFunction
|
|
|
|
Ƭ **ParseErrorFunction**: (`err`: `string` | [`DetailedError`](../interfaces/mermaid.DetailedError.md) | `unknown`, `hash?`: `any`) => `void`
|
|
|
|
#### Type declaration
|
|
|
|
▸ (`err`, `hash?`): `void`
|
|
|
|
##### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :--------------------------------------------------------------------------------- |
|
|
| `err` | `string` \| [`DetailedError`](../interfaces/mermaid.DetailedError.md) \| `unknown` |
|
|
| `hash?` | `any` |
|
|
|
|
##### Returns
|
|
|
|
`void`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/Diagram.ts:10](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/Diagram.ts#L10)
|
|
|
|
---
|
|
|
|
### SVG
|
|
|
|
Ƭ **SVG**: `d3.Selection`<`SVGSVGElement`, `unknown`, `Element` | `null`, `unknown`>
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/diagram-api/types.ts:130](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L130)
|
|
|
|
---
|
|
|
|
### SVGGroup
|
|
|
|
Ƭ **SVGGroup**: `d3.Selection`<`SVGGElement`, `unknown`, `Element` | `null`, `unknown`>
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/diagram-api/types.ts:132](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L132)
|
|
|
|
## Variables
|
|
|
|
### default
|
|
|
|
• `Const` **default**: [`Mermaid`](../interfaces/mermaid.Mermaid.md)
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/mermaid.ts:440](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L440)
|