mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-11-03 04:14:15 +01:00
151 lines
4.8 KiB
Markdown
151 lines
4.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
|
|
|
|
### IconLibrary
|
|
|
|
Ƭ **IconLibrary**: `Record`<`string`, [`IconResolver`](mermaid.md#iconresolver)>
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/rendering-util/svgRegister.ts:7](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/svgRegister.ts#L7)
|
|
|
|
---
|
|
|
|
### 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](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/svgRegister.ts#L3)
|
|
|
|
---
|
|
|
|
### 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:446](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L446)
|
|
|
|
## Functions
|
|
|
|
### createIcon
|
|
|
|
▸ **createIcon**(`icon`, `originalSize`): [`IconResolver`](mermaid.md#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`](mermaid.md#iconresolver)
|
|
|
|
IconResolver
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/rendering-util/svgRegister.ts:15](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/svgRegister.ts#L15)
|