--- title: ForceLayoutOptions --- > 📋 中文文档还在翻译中... 欢迎 PR [Overview - v5.0.0-beta.2](../../README.zh.md) / [Modules](../../modules.zh.md) / [layout](../../modules/layout.zh.md) / ForceLayoutOptions [layout](../../modules/layout.zh.md).ForceLayoutOptions ## Hierarchy - `CommonForceLayoutOptions` ↳ **`ForceLayoutOptions`** ## 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 --- ### centripetalOptions • `Optional` **centripetalOptions**: `CentripetalOptions` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:278 --- ### clusterNodeStrength • `Optional` **clusterNodeStrength**: `number` \| (`node`: `Node`) => `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:282 --- ### 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:280 --- ### collideStrength • `Optional` **collideStrength**: `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:283 --- ### coulombDisScale • `Optional` **coulombDisScale**: `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:274 --- ### damping • `Optional` **damping**: `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:272 --- ### 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 --- ### edgeStrength • `Optional` **edgeStrength**: `number` \| (`d?`: `Edge`) => `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:268 --- ### factor • `Optional` **factor**: `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:276 --- ### getCenter • `Optional` **getCenter**: (`node?`: `Node`, `degree?`: `number`) => `number`[] #### Type declaration ▸ (`node?`, `degree?`): `number`[] ##### Parameters | Name | Type | | :-------- | :------- | | `node?` | `Node` | | `degree?` | `number` | ##### Returns `number`[] #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:286 --- ### getMass • `Optional` **getMass**: (`node?`: `Node`) => `number` #### Type declaration ▸ (`node?`): `number` ##### Parameters | Name | Type | | :------ | :----- | | `node?` | `Node` | ##### Returns `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:285 --- ### 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:275 --- ### 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:265 --- ### interval • `Optional` **interval**: `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:277 --- ### leafCluster • `Optional` **leafCluster**: `boolean` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:279 --- ### linkDistance • `Optional` **linkDistance**: `number` \| (`edge?`: `Edge`, `source?`: `any`, `target?`: `any`) => `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:266 --- ### 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 --- ### maxSpeed • `Optional` **maxSpeed**: `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:273 --- ### 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 --- ### monitor • `Optional` **monitor**: (`params`: { `edges`: `Edge`[] ; `energy`: `number` ; `iterations`: `number` ; `nodes`: `Node`[] }) => `void` #### Type declaration ▸ (`params`): `void` ##### Parameters | Name | Type | | :------------------ | :------- | | `params` | `Object` | | `params.edges` | `Edge`[] | | `params.energy` | `number` | | `params.iterations` | `number` | | `params.nodes` | `Node`[] | ##### 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:287 --- ### 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:281 --- ### nodeSize • `Optional` **nodeSize**: `number` \| `number`[] \| (`d?`: `Node`) => `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:270 --- ### nodeSpacing • `Optional` **nodeSpacing**: `number` \| (`d?`: `Node`) => `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:271 --- ### nodeStrength • `Optional` **nodeStrength**: `number` \| (`d?`: `Node`) => `number` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:267 --- ### 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:284 --- ### preventOverlap • `Optional` **preventOverlap**: `boolean` #### Defined in node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:269 --- ### 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:264