2023-08-30 19:46:37 +08:00
|
|
|
---
|
|
|
|
|
title: DagreLayoutOptions
|
|
|
|
|
---
|
|
|
|
|
|
2023-08-31 22:06:26 +08:00
|
|
|
[Overview - v5.0.0-beta.1](../../README.en.md) / [Modules](../../modules.en.md) / [layout](../../modules/layout.en.md) / DagreLayoutOptions
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
[layout](../../modules/layout.en.md).DagreLayoutOptions
|
|
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
|
|
|
|
|
### align
|
|
|
|
|
|
|
|
|
|
• `Optional` **align**: `DagreAlign`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:187
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### begin
|
|
|
|
|
|
|
|
|
|
• `Optional` **begin**: `PointTuple`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:188
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### controlPoints
|
|
|
|
|
|
|
|
|
|
• `Optional` **controlPoints**: `boolean`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:192
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### edgeLabelSpace
|
|
|
|
|
|
|
|
|
|
• `Optional` **edgeLabelSpace**: `boolean`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:194
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### focusNode
|
|
|
|
|
|
|
|
|
|
• `Optional` **focusNode**: `ID` \| `Node`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:197
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### nodeOrder
|
|
|
|
|
|
|
|
|
|
• `Optional` **nodeOrder**: `string`[]
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:195
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### nodeSize
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
• `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `Node`) => `number`
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:189
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### nodesep
|
|
|
|
|
|
|
|
|
|
• `Optional` **nodesep**: `number`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:190
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### nodesepFunc
|
|
|
|
|
|
|
|
|
|
• `Optional` **nodesepFunc**: (`d?`: `Node`) => `number`
|
|
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
|
|
▸ (`d?`): `number`
|
|
|
|
|
|
|
|
|
|
##### Parameters
|
|
|
|
|
|
|
|
|
|
| Name | Type |
|
|
|
|
|
| :------ | :------ |
|
|
|
|
|
| `d?` | `Node` |
|
|
|
|
|
|
|
|
|
|
##### Returns
|
|
|
|
|
|
|
|
|
|
`number`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:202
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### preset
|
|
|
|
|
|
|
|
|
|
• `Optional` **preset**: `Object`
|
|
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
|
|
| Name | Type |
|
|
|
|
|
| :------ | :------ |
|
|
|
|
|
| `edges` | `Edge`[] |
|
|
|
|
|
| `nodes` | `OutNode`[] |
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:198
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### radial
|
|
|
|
|
|
|
|
|
|
• `Optional` **radial**: `boolean`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:196
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### rankdir
|
|
|
|
|
|
|
|
|
|
• `Optional` **rankdir**: `DagreRankdir`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:186
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### ranksep
|
|
|
|
|
|
|
|
|
|
• `Optional` **ranksep**: `number`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:191
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### ranksepFunc
|
|
|
|
|
|
|
|
|
|
• `Optional` **ranksepFunc**: (`d?`: `Node`) => `number`
|
|
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
|
|
▸ (`d?`): `number`
|
|
|
|
|
|
|
|
|
|
##### Parameters
|
|
|
|
|
|
|
|
|
|
| Name | Type |
|
|
|
|
|
| :------ | :------ |
|
|
|
|
|
| `d?` | `Node` |
|
|
|
|
|
|
|
|
|
|
##### Returns
|
|
|
|
|
|
|
|
|
|
`number`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:203
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
|
|
### sortByCombo
|
|
|
|
|
|
|
|
|
|
• `Optional` **sortByCombo**: `boolean`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:193
|
