mirror of
https://gitee.com/antv/g6.git
synced 2024-12-16 02:21:25 +08:00
198 lines
3.8 KiB
Markdown
198 lines
3.8 KiB
Markdown
---
|
|
title: FruchtermanLayoutOptions
|
|
---
|
|
|
|
> 📋 中文文档还在翻译中... 欢迎PR
|
|
|
|
[Overview - v5.0.0-beta.1](../../README.zh.md) / [Modules](../../modules.zh.md) / [layout](../../modules/layout.zh.md) / FruchtermanLayoutOptions
|
|
|
|
[layout](../../modules/layout.zh.md).FruchtermanLayoutOptions
|
|
|
|
## Hierarchy
|
|
|
|
- `CommonForceLayoutOptions`
|
|
|
|
↳ **`FruchtermanLayoutOptions`**
|
|
|
|
## Properties
|
|
|
|
### center
|
|
|
|
• `Optional` **center**: `PointTuple`
|
|
|
|
#### Inherited from
|
|
|
|
CommonForceLayoutOptions.center
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252
|
|
|
|
___
|
|
|
|
### clusterGravity
|
|
|
|
• `Optional` **clusterGravity**: `number`
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:316
|
|
|
|
___
|
|
|
|
### clustering
|
|
|
|
• `Optional` **clustering**: `boolean`
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:315
|
|
|
|
___
|
|
|
|
### dimensions
|
|
|
|
• `Optional` **dimensions**: `number`
|
|
|
|
#### Inherited from
|
|
|
|
CommonForceLayoutOptions.dimensions
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251
|
|
|
|
___
|
|
|
|
### distanceThresholdMode
|
|
|
|
• `Optional` **distanceThresholdMode**: ``"min"`` \| ``"max"`` \| ``"mean"``
|
|
|
|
#### Inherited from
|
|
|
|
CommonForceLayoutOptions.distanceThresholdMode
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255
|
|
|
|
___
|
|
|
|
### gravity
|
|
|
|
• `Optional` **gravity**: `number`
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:313
|
|
|
|
___
|
|
|
|
### height
|
|
|
|
• `Optional` **height**: `number`
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:312
|
|
|
|
___
|
|
|
|
### maxDistance
|
|
|
|
• `Optional` **maxDistance**: `number`
|
|
|
|
If distance is specified, sets the maximum distance between nodes over which this force is considered.
|
|
If distance is not specified, returns the current maximum distance, which defaults to infinity.
|
|
Specifying a finite maximum distance improves performance and produces a more localized layout.
|
|
|
|
#### Inherited from
|
|
|
|
CommonForceLayoutOptions.maxDistance
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261
|
|
|
|
___
|
|
|
|
### maxIteration
|
|
|
|
• `Optional` **maxIteration**: `number`
|
|
|
|
#### Inherited from
|
|
|
|
CommonForceLayoutOptions.maxIteration
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254
|
|
|
|
___
|
|
|
|
### minMovement
|
|
|
|
• `Optional` **minMovement**: `number`
|
|
|
|
#### Inherited from
|
|
|
|
CommonForceLayoutOptions.minMovement
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253
|
|
|
|
___
|
|
|
|
### nodeClusterBy
|
|
|
|
• `Optional` **nodeClusterBy**: `string`
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:317
|
|
|
|
___
|
|
|
|
### onTick
|
|
|
|
• `Optional` **onTick**: (`data`: `LayoutMapping`) => `void`
|
|
|
|
#### Type declaration
|
|
|
|
▸ (`data`): `void`
|
|
|
|
##### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `data` | `LayoutMapping` |
|
|
|
|
##### Returns
|
|
|
|
`void`
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:318
|
|
|
|
___
|
|
|
|
### speed
|
|
|
|
• `Optional` **speed**: `number`
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:314
|
|
|
|
___
|
|
|
|
### width
|
|
|
|
• `Optional` **width**: `number`
|
|
|
|
#### Defined in
|
|
|
|
node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:311
|