mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-19 23:39:50 +02:00
144 lines
4.8 KiB
Markdown
144 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
|
|
|
|
### 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:157](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L157)
|
|
|
|
---
|
|
|
|
### SVGGroup
|
|
|
|
Ƭ **SVGGroup**: `d3.Selection`<`SVGGElement`, `unknown`, `Element` | `null`, `unknown`>
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/diagram-api/types.ts:159](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L159)
|
|
|
|
## Variables
|
|
|
|
### default
|
|
|
|
• `Const` **default**: [`Mermaid`](../interfaces/mermaid.Mermaid.md)
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/mermaid.ts:442](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L442)
|
|
|
|
## 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:115](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/layout-algorithms/fixed/index.js#L115)
|
|
|
|
---
|
|
|
|
### calcNodeIntersections
|
|
|
|
▸ **calcNodeIntersections**(`targetNodeId`, `_node1`, `_node2`): `IntersectionPoint`\[] | `Promise`<`IntersectionPoint`\[]>
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------------- | :------------------------------------------------------------------------------------------------ |
|
|
| `targetNodeId` | `any` |
|
|
| `_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](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/layout-algorithms/fixed/index.js#L78)
|