diff --git a/packages/g6/src/runtime/controller/item.ts b/packages/g6/src/runtime/controller/item.ts index 7273379ccdb..89233d7acb7 100644 --- a/packages/g6/src/runtime/controller/item.ts +++ b/packages/g6/src/runtime/controller/item.ts @@ -529,15 +529,21 @@ export class ItemController { const { dataTypeField: nodeDataTypeField } = nodeTheme; const edgeIdsToUpdate: Set = new Set(); const comboIdsToUpdate: Set = new Set(); - const updateRelates = (edgeIds?: Set) => { - const ids = edgeIds - ? [...edgeIds] - : [...comboIdsToUpdate, ...edgeIdsToUpdate]; - ids.forEach((nid) => { + const updateRelates = (param: { edgeIds?: Set; callback?: any }) => { + const { edgeIds, callback } = param; + edgeIds.forEach((nid) => { const item = itemMap.get(nid) as Edge | Combo; if (item && !item.destroyed) item.forceUpdate(); }); + callback?.(); }; + const updateAllRelates = () => { + [...comboIdsToUpdate, ...edgeIdsToUpdate].forEach((nid) => { + const item = itemMap.get(nid) as Edge | Combo; + if (item && !item.destroyed) item.forceUpdate(); + }); + }; + const debounceUpdateAllRelates = debounce(updateAllRelates, 16, false); const debounceUpdateRelates = debounce(updateRelates, 16, false); Object.values(nodeComboUpdate).forEach((updateObj: any) => { @@ -638,7 +644,7 @@ export class ItemController { nodeRelatedIdsToUpdate.add(edge.id); }); - item.onframe = () => updateRelates(nodeRelatedIdsToUpdate); + item.onframe = () => updateRelates({ edgeIds: nodeRelatedIdsToUpdate }); let statesCache; if ( innerModel.data._isCombo && @@ -656,15 +662,17 @@ export class ItemController { animate, // call after updating finished (_, canceled) => { - // @ts-ignore - debounceUpdateRelates(nodeRelatedIdsToUpdate); item.onframe = undefined; if (statesCache) { statesCache.forEach((state) => this.graph.setItemState(id, state, true), ); } - callback(innerModel, canceled); + // @ts-ignore + debounceUpdateRelates({ + edgeIds: nodeRelatedIdsToUpdate, + callback: () => callback(innerModel, canceled), + }); }, ); @@ -675,7 +683,7 @@ export class ItemController { }); } }); - debounceUpdateRelates(); + debounceUpdateAllRelates(); } // === 6. update edges' data === if (groupedChanges.EdgeDataUpdated.length) { diff --git a/packages/g6/src/stdlib/theme/light.ts b/packages/g6/src/stdlib/theme/light.ts index 15b74597049..98f745ace5a 100644 --- a/packages/g6/src/stdlib/theme/light.ts +++ b/packages/g6/src/stdlib/theme/light.ts @@ -101,6 +101,7 @@ export const LightTheme = { }, labelShape: { fontWeight: 700, + fontSize: 14, }, haloShape: { opacity: 0.25, @@ -231,6 +232,7 @@ export const LightTheme = { }, labelShape: { fontWeight: 700, + fontSize: 14, }, haloShape: { opacity: 0.25, @@ -323,6 +325,7 @@ export const LightTheme = { }, labelShape: { fontWeight: 700, + fontSize: 14, }, haloShape: { opacity: 0.25, diff --git a/packages/site/docs/apis/layout/CircularLayoutOptions.en.md b/packages/site/docs/apis/layout/CircularLayoutOptions.en.md new file mode 100644 index 00000000000..1bccbb35e85 --- /dev/null +++ b/packages/site/docs/apis/layout/CircularLayoutOptions.en.md @@ -0,0 +1,4 @@ +--- +title: CircularLayoutOptions +order: 3 +--- diff --git a/packages/site/docs/apis/layout/CircularLayoutOptions.zh.md b/packages/site/docs/apis/layout/CircularLayoutOptions.zh.md new file mode 100644 index 00000000000..85fb9361ec9 --- /dev/null +++ b/packages/site/docs/apis/layout/CircularLayoutOptions.zh.md @@ -0,0 +1,111 @@ +--- +title: CircularLayoutOptions +order: 3 +--- + +本文展示所有圆形布局配置项。[圆形布局 DEMO](/zh/examples/net/circular/#circularConfigurationTranslate)。 + + + + +## radius + +**类型**：`number` + +**默认值**： 默认从节点大小与间距形成的周长计算而得 + +**是否必须**：false + +**说明**：圆形布局的半径。若设置了 `radius`，则 `startRadius` 与 `endRadius` 不生效 + +## center + +**类型**：`[number, number]` + +**默认值**：当前容器的中心位置 + +**是否必须**：false + +**说明**：圆形布局的中心位置 + +## clockwise + +**类型**：`boolean` + +**默认值**：`true` + +**是否必须**：false + +**说明**：是否为顺时针布局 + +## divisions + +**类型**：`number` + +**默认值**：`1` + +**是否必须**：false + +**说明**：节点在环上的分段数（几个段将均匀分布），在 endRadius - startRadius != 0 时生效 + +## ordering + +**类型**：`'topology'` \| `'degree'` \| `null` + +**默认值**：`null` + +**是否必须**：false + +**说明**：节点在环上排序的依据。默认 null 代表直接使用数据中的顺序。'topology' 按照拓扑排序。'degree' 按照度数大小排序 + +## angleRatio + +**类型**：`number` + +**默认值**：`1` + +**是否必须**：false + +**说明**：从第一个节点到最后节点之间相隔多少个 2\*PI + +## startRadius + +**类型**：`number` \| `null` + +**默认值**：`null` + +**是否必须**：false + +**说明**：螺旋状布局的起始半径 + +## endRadius + +**类型**：`number` \| `null` + +**默认值**：`null` + +**是否必须**：false + +**说明**：螺旋状布局的结束半径 + +## nodeSize + +**类型**：`number` \| `number`[] \| (`nodeData`: `Node`) => `number` + +**默认值**：读取节点数据中的 data.size，若无则默认值为 `10` + +**是否必须**：false + +**说明**： 节点占据的大小，在未指定 `radius` 时用于计算周长以得到圆形布局的半径 + +## workerEnabled + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**： 是否启用 web-worker 以防布局计算时间过长阻塞页面交互 + +⚠️ 注意: `workerEnabled: true` 时，不支持所有函数类型的参数。 diff --git a/packages/site/docs/apis/layout/ComboCombinedLayoutOptions.en.md b/packages/site/docs/apis/layout/ComboCombinedLayoutOptions.en.md new file mode 100644 index 00000000000..bd169d1b1ec --- /dev/null +++ b/packages/site/docs/apis/layout/ComboCombinedLayoutOptions.en.md @@ -0,0 +1,4 @@ +--- +title: ComboCombinedLayoutOptions +order: 2 +--- diff --git a/packages/site/docs/apis/layout/ComboCombinedLayoutOptions.zh.md b/packages/site/docs/apis/layout/ComboCombinedLayoutOptions.zh.md new file mode 100644 index 00000000000..95c24152804 --- /dev/null +++ b/packages/site/docs/apis/layout/ComboCombinedLayoutOptions.zh.md @@ -0,0 +1,120 @@ +--- +title: ComboCombinedLayoutOptions +order: 2 +--- + +本文展示所有 Combo 复合布局的配置项。[ComboCombined 布局 DEMO](/zh/examples/net/comboLayout/#comboCombined)。 + + + +## center + +**类型**：`[number, number]` + +**默认值**：画布中心 + +**是否必须**：false + +**说明**：布局的中心 + +## outerLayout + +**类型**：`LayoutInstance` + +**默认值**：Force 布局 + +**是否必须**：false + +**说明**：最外层的布局算法，默认为 `force`。具体参数详见被使用布局的文档。默认情况下 `force` 布局将使用以下参数： + +```javascript +outerLayout: new G6.Extensions.ForceLayout({ + gravity: 1, + factor: 2, + linkDistance: (edge: EdgeInnerModel, source: NodeInnerModel, target: NodeInnerModel) => { + const nodeSize = ((source.data.size?.[0] || 30) + (target.data.size?.[0] || 30)) / 2; + return Math.min(nodeSize * 1.5, 700); + }, +}); +``` + +## innerLayout + +**类型**：`LayoutInstance` + +**默认值**：Concentric 布局 + +**是否必须**：false + +**说明**：combo 内部的布局算法，需要使用同步的布局算法，默认为 `concentric`。具体参数详见被使用布局的文档。 +默认情况下 `concentric` 布局将使用以下参数： + +```javascript +innerLayout: new G6.Extensions.ConcentricLayout({ + sortBy: 'id', +}); +``` + +## comboPadding + +**类型**：`number` \| (`comboModel`: `ComboInnerModel`) => `number` + +**默认值**：`10` + +**是否必须**：false + +**说明**：Combo 内部的 padding 值，不用于渲染，仅用于计算力。推荐设置为与视图上 Combo 内部 padding 值相同的值 + +```javascript +(comboModel) => { + // d is a combo inner model + if (d.id === 'combo1') { + return 100; + } + return 10; +}; +``` + +## nodeSize + +**类型**：`number` \| `number`[] \| (`nodeModel`: `NodeInnerModel`) => `number` + +**默认值**：`10` + +**是否必须**：false + +**说明**：节点大小（直径）。用于碰撞检测。若不指定，则根据传入的节点数据的 `data.size` 属性计算。若即不指定，节点中也没有 `data.size`，则默认大小为 `10` + +## spacing + +**类型**：`number` \| `number`[] \| (`nodeModel`: `NodeInnerModel`) => `number` + +**默认值**：`0` + +**是否必须**：false + +**说明**：`preventNodeOverlap` 或 `preventOverlap` 为 `true` 时生效, 防止重叠时节点/ combo 边缘间距的最小值。可以是回调函数, 为不同节点设置不同的最小间距, 如示例 + +**示例**： + +```typescript +(nodeModel: NodeInnerModel) => { + // d is a node's inner model + if (nodeModel.id === 'node1') { + return 100; + } + return 10; +}; +``` + +## workerEnabled + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：是否启用 web-worker 以防布局计算时间过长阻塞页面交互。 + +⚠️ 注意: `workerEnabled: true` 时，不支持所有函数类型的参数。 diff --git a/packages/site/docs/apis/layout/DagreLayoutOptions.en.md b/packages/site/docs/apis/layout/DagreLayoutOptions.en.md new file mode 100644 index 00000000000..5512fcb975b --- /dev/null +++ b/packages/site/docs/apis/layout/DagreLayoutOptions.en.md @@ -0,0 +1,4 @@ +--- +title: DagreLayoutOptions +order: 1 +--- diff --git a/packages/site/docs/apis/layout/DagreLayoutOptions.zh.md b/packages/site/docs/apis/layout/DagreLayoutOptions.zh.md new file mode 100644 index 00000000000..b7ec605dcd7 --- /dev/null +++ b/packages/site/docs/apis/layout/DagreLayoutOptions.zh.md @@ -0,0 +1,187 @@ +--- +title: DagreLayoutOptions +order: 1 +--- + +本文展示所有分层/流程图布局的配置项。[Dagre 分层/流程图布局 DEMO](/zh/examples/net/dagreFlow/#dagre)。 + + + + +## 指定节点层级 + +在节点数据中配置 `data.layer` 字段（从 `0` 开始计数），可以为节点指定层级。注意，`layer` 的指定不能违背图结构与层次布局原则，即每一条边的起点的 `layer` 一定小于终点的 `layer` 值。若违背该规则，则可能导致布局失败。 + +## begin + +**类型**：`[number, number]` + +**默认值**：`undefined` + +**是否必须**：false + +**说明**：布局的左上角对齐位置 + +## rankdir + +**类型**：`'TB'` | `'BT'` | `'LR'` | `'RL'` + +**默认值**：`'TB'` + +**是否必须**：false + +**说明**：布局的方向。T：top（上）；B：bottom（下）；L：left（左）；R：right（右）。 + +- `'TB'`：从上至下布局； +- `'BT'`：从下至上布局； +- `'LR'`：从左至右布局； +- `'RL'`：从右至左布局。 + +## align + +**类型**：`'UL'` | `'UR'` | `'DL'` | `'DR'` | undefined + +**默认值**：`'UL'` + +**是否必须**：false + +**说明**：节点对齐方式。U：upper（上）；D：down（下）；L：left（左）；R：right（右） + +- 'UL'：对齐到左上角； +- 'UR'：对齐到右上角； +- 'DL'：对齐到左下角； +- 'DR'：对齐到右下角； +- undefined：默认，中间对齐。 + +## nodeSize + +**类型**：`number` \| `number`[] \| (`nodeModel`: `NodeInnerModel`) => `number` + +**默认值**：默认取节点中的 `data.size` 值，若无此值则使用 `10` + +**是否必须**：false + +**说明**：每个节点的大小，用于计算每个节点占据的空间 + +## nodesep + +**类型**：`number` + +**默认值**：`50` + +**是否必须**：false + +**说明**：节点间距（px）。在 `rankdir` 为 `'TB'` 或 `'BT'` 时是节点的水平间距；在 `rankdir` 为 `'LR'` 或 `'RL'` 时代表节点的竖直方向间距。`nodesepFunc` 拥有更高的优先级 + +## nodesepFunc + +**类型**：(`nodeModel`: `NodeInnerModel`) => `number` + +**默认值**：undefined + +**是否必须**：false + +**说明**：节点间距（px）的回调函数，通过该参数可以对不同节点设置不同的节点间距。在 `rankdir` 为 `'TB'` 或 `'BT'` 时是节点的水平间距；在 `rankdir` 为 `'LR'` 或 `'RL'` 时代表节点的竖直方向间距。优先级高于 `nodesep`，即若设置了 `nodesepFunc`，则 `nodesep` 不生效 + +**示例**： + +```javascript +(nodeModel) => { + // d 是一个节点的内部流转数据 + if (nodeModel.id === 'testId') return 100; + return 10; +}; +``` + +## ranksep + +**类型**：`number` + +**默认值**：`50` + +**是否必须**：false + +**说明**：层间距（px）。在 `rankdir` 为 `'TB'` 或 `'BT'` 时是竖直方向相邻层间距；在 `rankdir` 为 `'LR'` 或 `'RL'` 时代表水平方向相邻层间距。`ranksepFunc` 拥有更高的优先级 + +## ranksepFunc + +**类型**：(`nodeModel`: `NodeInnerModel`) => `number` + +**默认值**：`undefined` + +**是否必须**：false + +**说明**：层间距（px）。在 `rankdir` 为 `'TB'` 或 `'BT'` 时是竖直方向相邻层间距；在 `rankdir` 为 `'LR'` 或 `'RL'` 时代表水平方向相邻层间距。优先级高于 `nodesep`，即若设置了 `nodesepFunc`，则 `nodesep` 不生效 + +**示例**： + +```javascript +(nodeModel) => { + // d 是一个节点的内部流转数据 + if (nodeModel.id === 'testId') return 100; + return 10; +}; +``` + +## controlPoints + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：是否同时计算边上的的控制点位置，仅在边配置中使用了内置折线（`type: 'polyline-edge'`） 时，或任何将自定义消费了 `data.controlPoints` 字段作为控制点位置的边时生效。本质上就是给边数据增加了 `data.controlPoints` + +## preset + +**类型**： + +```typescript +{ + nodes: { + x: number, // 位置 + y: number, // 位置 + layer?: number, // 指定层级 + _order?: number // 若为上一次 dagre 布局的输出，则有该字段，代表同层节点的顺序 + }[] +} +``` + +**默认值**：undefined + +**是否必须**：false + +**说明**：布局计算时参考的节点位置，一般用于切换数据时保证重新布局的连续性。在 G6 中，若是更新数据，则将自动使用已存在的布局结果数据作为输入。 + +## nodeOrder + +**类型**：`string`[] + +**默认值**：`false` + +**是否必须**：false + +**说明**：同层节点顺序的参考数组，存放节点 id 值。若未指定，则将按照 dagre 本身机制排列同层节点顺序。 + +## sortByCombo + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：建议在有 Combo 的情况下配置，同一层节点是否根据每个节点数据中的 `parentId` 进行排序，以防止 Combo 重叠 + +## workerEnabled + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：是否启用 web-worker 以防布局计算时间过长阻塞页面交互。 + +⚠️ 注意: `workerEnabled: true` 时，不支持所有函数类型的参数。 diff --git a/packages/site/docs/apis/layout/ForceLayoutOptions.en.md b/packages/site/docs/apis/layout/ForceLayoutOptions.en.md new file mode 100644 index 00000000000..2524a972657 --- /dev/null +++ b/packages/site/docs/apis/layout/ForceLayoutOptions.en.md @@ -0,0 +1,4 @@ +--- +title: ForceLayoutOptions +order: 0 +--- diff --git a/packages/site/docs/apis/layout/ForceLayoutOptions.zh.md b/packages/site/docs/apis/layout/ForceLayoutOptions.zh.md new file mode 100644 index 00000000000..eeda74c183c --- /dev/null +++ b/packages/site/docs/apis/layout/ForceLayoutOptions.zh.md @@ -0,0 +1,319 @@ +--- +title: ForceLayoutOptions +order: 0 +--- + +本文展示所有力导布局配置项。[力导布局 DEMO](/zh/examples/net/forceDirected/#basicForce)。当你希望固定某个节点的位置，不受力的影响时，可以在该节点数据中配置 fx 与 fy 作为固定的坐标。 + + + + +## presetLayout + +**类型**：`LayoutOptions` + +**默认值**：`{ type: 'grid' }` + +**是否必须**：false + +**说明**：力导向布局的初始化布局，将先执行 `presetLayout` 指定的布局，再进行力导向计算。由于力导向布局的结果非常依赖节点的初始位置，配置 `presetLayout` 的可以给力导向布局一个好的初始化，让力导向算法更快收敛、效果更好。默认情况下，力导向的初始化为格子布局（grid）的结果 + +## animated + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：是否启用迭代的动画，清注意力导布局的迭代模拟的是力相互作用的过程，此参数开启后可以看到力作用碰撞过程。而节点配置中的 animates 是插值动画，即从初始位置均匀插值到布局后的位置。这两种布局不应同时配 + +## gravity + +**类型**：`number` + +**默认值**：`10` + +**是否必须**：false + +**说明**：中心力大小，指所有节点被吸引到 `center` 的力。数字越大，布局越紧凑 + +## center + +**类型**：`[number, number]` + +**默认值**：当前容器的中心位置 + +**是否必须**：false + +**说明**：圆形布局的中心位置 + +## getCenter + +**类型**：(`model`: `NodeInnerModel`) => `number` + +**默认值**：`undefined` + +**是否必须**：false + +**说明**：每个节点中心力的 x、y、强度的回调函数，若不指定，则没有额外中心力 + +**示例**： + +```javascript +(d, degree) => { + // d is a node, degree is the degree of the node + if (d.clusterId === 'c1') return [100, 100, 10]; // x, y, strength + if (degree === 0) return [250, 250, 15]; // x, y, strength + return [180, 180, 5]; // x, y, strength +}; +``` + +## preventOverlap + +**类型**：`boolean` + +**默认值**：`true` + +**是否必须**：false + +**说明**：是否防止重叠，必须配合下面属性 `nodeSize` 或节点数据中的 `data.size` 属性，只有在数据中设置了 `data.size` 或在该布局中配置了与当前图节点大小相同的 `nodeSize` 值，才能够进行有效的节点重叠的碰撞检 + +## nodeSize + +**类型**：`number` \| `number`[] \| (`model`: `NodeInnerModel`) => `number` + +**默认值**：读取节点数据中的 `data.size`，若无则默认值为 `10` + +**是否必须**：false + +**说明**：节点大小（直径）。用于碰撞检测 + +## nodeSpacing + +**类型**：`number` \| `number`[] \| (`model`: `NodeInnerModel`) => `number` + +**默认值**：`10` + +**是否必须**：false + +**说明**：`preventOverlap` 为 `true` 时生效, 防止重叠时节点边缘间距的最小值。可以是回调函数, 为不同节点设置不同的最小间距 + +## linkDistance + +**类型**：`number` \| (`model`: `EdgeInnerModel`) => `number` + +**默认值**：`200` + +**是否必须**：false + +**说明**：边的理想长度，可以理解为边作为弹簧在不受力下的长度 + +## nodeStrength + +**类型**：`number` \| (`model`: `NodeInnerModel`) => `number` + +**默认值**：`1000` + +**是否必须**：false + +**说明**：节点之间的作用力，正数代表节点之间的斥力作用，负数代表节点之间的引力作用 + +## edgeStrength + +**类型**：`number` \| (`model`: `EdgeInnerModel`) => `number` + +**默认值**：`200` + +**是否必须**：false + +**说明**：边的作用力（引力）大小 + +## maxSpeed + +**类型**：`number` + +**默认值**：`1000` + +**是否必须**：false + +**说明**：一次迭代的最大移动长度 + +## factor + +**类型**：`number` + +**默认值**：`1` + +**是否必须**：false + +**说明**：斥力系数，数值越大，斥力越大 + +## coulombDisScale + +**类型**：`number` + +**默认值**：`0.05` + +**是否必须**：false + +**说明**：库伦系数，斥力的一个系数，数字越大，节点之间的斥力越大 + +## getMass + +**类型**：(`model`: `NodeInnerModel`) => `number` + +**默认值**：在 G6 中使用，增量布局时已存在的节点质量将被加大，以保持已有内容的稳定。其他情况下节点质量为 `1` + +**是否必须**：false + +**说明**：每个节点质量的回调函数，如参为节点内部流转数据，返回值为质量大小 + +## minMovement + +**类型**：`number` + +**默认值**：`0.4` + +**是否必须**：false + +**说明**：当一次迭代的平均/最大/最小（根据`distanceThresholdMode`决定）移动长度小于该值时停止迭代。数字越小，布局越收敛，所用时间将越长 + +## distanceThresholdMode + +**类型**：`'mean'`\|`'max'`\｜`'min'` + +**默认值**：`'mean'` + +**是否必须**：false + +**说明**：`minMovement` 的使用条件，`'mean'` 代表平均移动距离小于 `minMovement` 时停止迭代，`'max'`/`'min'` 代表最大/最小移动距离小于时 `minMovement` 时停时迭于该值时停止迭代。数字越小，布局越收敛，所用时间将越长 + +## maxIteration + +**类型**：`number` + +**默认值**：`1000` + +**是否必须**：false + +**说明**：最大迭代次数。当迭代次数超过该值，但平均移动长度仍然没有达到 minMovement，也将强制停止迭 + +## damping + +**类型**：`number` + +**默认值**：`0.9` + +**是否必须**：false + +**说明**：阻尼系数，取值范围 [0, 1]。数字越大，速度降低得越慢 + +## interval + +**类型**：`number` + +**默认值**：`0.02` + +**是否必须**：false + +**说明**：控制每个迭代节点的移动速度 + +## centripetalOptions + +**类型**：`CentripetalOptions` 见下表 + +**默认值**：见下表 + +**是否必须**：false + +**说明**：向心力配置，包括叶子节点、离散点、其他节点的向心中心及向心力大小 + +| Parameter | Type | Example | Default | Description | +| --------- | -------------------------------------------------------- | ------------------------------------------ | ------------------- | ---------------------------------------------------------------------------------- | +| single | `number` \｜ (`model`: `NodeInnerModel`) => `number` | 2 | 2, | the center force strength for discrete nodes (with 0 degree) | +| leaf | `number` \｜ (`model`: `NodeInnerModel`) => `number` | 2 | 2 | the center force strength for leaf nodes (with 1 degree) | +| others | `number` \｜ (`model`: `NodeInnerModel`) => `number` | 1 | 1 | the center force strength for other nodes beside leaf and discrete nodes | +| center | (`model`: `NodeInnerModel`) => `{ x: number; y: number}` | (node, nodes, edges) => ({ x: 10, y: 10 }) | center of the graph | the center force's coordinate. You can return different values for different nodes | + +## leafCluster + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：是否需要叶子结点聚类，若为 `true`，则 `centripetalOptions.single` 将为 `100`；`centripetalOptions.leaf` 将使用 `getClusterNodeStrength` 返回值；`getClusterNodeStrength.center` 将为叶子节点返回当前所有叶子节点的平均中心 + +## clustering + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：是否需要全部节点聚类，若为 `true`，将使用 `nodeClusterBy` 配置的节点数据中的字段作为聚类依据。 `centripetalOptions.single`、`centripetalOptions.leaf`、`centripetalOptions.others` 将使用 `getClusterNodeStrength` 返回值；`leaf`、`centripetalOptions.center` 将使用当前节点所属聚类中所有节点的平均中心 + +## nodeClusterBy + +**类型**：`string` + +**默认值**：`undefined` + +**是否必须**：false + +**说明**：指定节点数据中的字段名称作为节点聚类的依据，`clustering` 为 `true` 时生效，自动生成 `centripetalOptions`，可配合 `clusterNodeStrength` 使用 + +## clusterNodeStrength + +**类型**：`number` \| (`model`: `NodeInnerModel`) => `number` + +**默认值**：`20` + +**是否必须**：false + +**说明**：配合 `clustering` 和 `nodeClusterBy` 使用，指定聚类向心力的大小 + +## onTick + +**类型**：`Function` + +**默认值**：在 G6 中使用，若 `animated: true` 则在每次迭代的回调中调用更新画布上节点渲染位置的逻辑 + +**是否必须**：false + +**说明**：每一次迭代的回调函数 + +## onLayoutEnd + +**类型**：`Function` + +**默认值**：在 G6 中使用，完成后更新画布上节点渲染位置，并触发图的布局完成时机事件 `afterlayout` + +**是否必须**：false + +**说明**：布局完成后的回调函数 + +## monitor + +**类型**：`(params:{ energy: number, nodes: NodeData[], edges: EdgeData[], iterations: number }) => void` + +**默认值**：`undefined` + +**是否必须**：false + +**说明**：每个迭代的监控信息回调，`energy` 表示布局的收敛能量。若配置可能带来额外的计算能量性能消耗，不配置则不计算 + +## workerEnabled + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：是否启用 web-worker 以防布局计算时间过长阻塞页面交互。 + +⚠️ 注意: `workerEnabled: true` 时，不支持所有函数类型的参数。 diff --git a/packages/site/docs/apis/layout/GridLayoutOptions.en.md b/packages/site/docs/apis/layout/GridLayoutOptions.en.md new file mode 100644 index 00000000000..994263d2882 --- /dev/null +++ b/packages/site/docs/apis/layout/GridLayoutOptions.en.md @@ -0,0 +1,3 @@ +--- +title: GridLayoutOptions +--- diff --git a/packages/site/docs/apis/layout/GridLayoutOptions.zh.md b/packages/site/docs/apis/layout/GridLayoutOptions.zh.md new file mode 100644 index 00000000000..114b05e3249 --- /dev/null +++ b/packages/site/docs/apis/layout/GridLayoutOptions.zh.md @@ -0,0 +1,117 @@ +--- +title: GridLayoutOptions +--- + +本文展示所有网格布局配置项。[格子布局 DEMO](/zh/examples/net/gridLayout/#grid)。 + + + +## begin + +**类型**：`[number, number]` + +**默认值**：`[0, 0]` + +**是否必须**：false + +**说明**：网格开始位置（左上角） + +## width + +**类型**：`number` + +**默认值**：在 G6 中使用当前容器的宽度作为 `grid` 布局 `width` 的默认值。单独使用此布局时默认值为 `300` + +**是否必须**：false + +**说明**：网格布局的总宽度 + +## height + +**类型**：`number` + +**默认值**：在 G6 中使用当前容器的高度作为 `grid` 布局 `height` 的默认值。单独使用此布局时默认值为 `300` + +**是否必须**：false + +**说明**：网格布局的总高度 + +## rows + +**类型**：`number` + +**默认值**：`10` + +**是否必须**：false + +**说明**：网格的行数，为 `undefined` 时算法根据节点数量、布局空间、`cols`（若指定）自动计算 + +## cols + +**类型**：`number` + +**默认值**：`undefined` + +**是否必须**：false + +**说明**：网格的列数，为 `undefined` 时算法根据节点数量、布局空间、`rows`（若指定）自动计算 + +## preventOverlap + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：是否防止重叠，必须配合下面属性 `nodeSize`，只有设置了与当前图节点大小相同的 `nodeSize` 值，才能够有效进行节点重叠的碰撞检测 + +## nodeSize + +**类型**：`number` \| `number`[] \| (`model`: `NodeInnerModel`) => `number` + +**默认值**：读取节点数据中的 `data.size`，若无则默认值为 `10` + +**是否必须**：false + +**说明**：节点大小（直径）。用于碰撞检测 + +## preventOverlapPadding + +**类型**：`number` + +**默认值**：`10` + +**是否必须**：false + +**说明**：避免重叠时节点的间距 `padding`。`preventOverlap` 为 `true` 时生效 + +## condense + +**类型**：`boolean` + +**默认值**：`false` + +**是否必须**：false + +**说明**：为 `false` 时表示利用所有可用画布空间，为 `true` 时表示利用最小的画布空间 + +## condense + +**类型**： (`node?`: `NodeInnerModel`) => { `row?`: `number`; `col?`: `number`; } + +**默认值**：`undefined` + +**是否必须**：false + +**说明**：指定每个节点所在的行和列 + +## sortBy + +**类型**：`string` + +**默认值**：`undefined` + +**是否必须**：false + +**说明**：指定排序的依据（节点属性名），数值越高则该节点被放置得越中心。若为 undefined，则会计算节点的度数，度数越高，节点将被放置得越中心 diff --git a/packages/site/docs/apis/layout/WIP-CircularLayoutOptions.en.md b/packages/site/docs/apis/layout/WIP-CircularLayoutOptions.en.md deleted file mode 100644 index 901405a2494..00000000000 --- a/packages/site/docs/apis/layout/WIP-CircularLayoutOptions.en.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: CircularLayoutOptions ---- - -[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [layout](../../modules/layout.en.md) / CircularLayoutOptions - -[layout](../../modules/layout.en.md).CircularLayoutOptions - -## Properties - -### angleRatio - -• `Optional` **angleRatio**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:121 - ---- - -### center - -• `Optional` **center**: `PointTuple` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:112 - ---- - -### clockwise - -• `Optional` **clockwise**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:118 - ---- - -### divisions - -• `Optional` **divisions**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:119 - ---- - -### endAngle - -• `Optional` **endAngle**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:123 - ---- - -### endRadius - -• `Optional` **endRadius**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:117 - ---- - -### 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:114 - ---- - -### nodeSize - -• `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `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:125 - ---- - -### nodeSpacing - -• `Optional` **nodeSpacing**: `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:124 - ---- - -### ordering - -• `Optional` **ordering**: `"topology"` \| `"topology-directed"` \| `"degree"` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:120 - ---- - -### radius - -• `Optional` **radius**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:115 - ---- - -### startAngle - -• `Optional` **startAngle**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:122 - ---- - -### startRadius - -• `Optional` **startRadius**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:116 - ---- - -### 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:113 diff --git a/packages/site/docs/apis/layout/WIP-CircularLayoutOptions.zh.md b/packages/site/docs/apis/layout/WIP-CircularLayoutOptions.zh.md deleted file mode 100644 index 30dfc7ef547..00000000000 --- a/packages/site/docs/apis/layout/WIP-CircularLayoutOptions.zh.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: CircularLayoutOptions ---- - -| Name | Type | Default | Description | -| :------- | :------- | :----------------------------- | :------------- | -| `radius` | `number` | 画布宽度与高度较小者的二分之一 | 圆形布局的半径 | - -> 📋 中文文档还在翻译中... 欢迎 PR - -[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [layout](../../modules/layout.zh.md) / CircularLayoutOptions - -[layout](../../modules/layout.zh.md).CircularLayoutOptions - -## Properties - -### angleRatio - -• `Optional` **angleRatio**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:121 - ---- - -### center - -• `Optional` **center**: `PointTuple` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:112 - ---- - -### clockwise - -• `Optional` **clockwise**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:118 - ---- - -### divisions - -• `Optional` **divisions**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:119 - ---- - -### endAngle - -• `Optional` **endAngle**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:123 - ---- - -### endRadius - -• `Optional` **endRadius**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:117 - ---- - -### 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:114 - ---- - -### nodeSize - -• `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `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:125 - ---- - -### nodeSpacing - -• `Optional` **nodeSpacing**: `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:124 - ---- - -### ordering - -• `Optional` **ordering**: `"topology"` \| `"topology-directed"` \| `"degree"` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:120 - ---- - -### radius - -• `Optional` **radius**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:115 - ---- - -### startAngle - -• `Optional` **startAngle**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:122 - ---- - -### startRadius - -• `Optional` **startRadius**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:116 - ---- - -### 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:113 diff --git a/packages/site/docs/apis/layout/WIP-ComboCombinedLayoutOptions.en.md b/packages/site/docs/apis/layout/WIP-ComboCombinedLayoutOptions.en.md deleted file mode 100644 index 52ae2adb277..00000000000 --- a/packages/site/docs/apis/layout/WIP-ComboCombinedLayoutOptions.en.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: ComboCombinedLayoutOptions ---- - -[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [layout](../../modules/layout.en.md) / ComboCombinedLayoutOptions - -[layout](../../modules/layout.en.md).ComboCombinedLayoutOptions - -## Properties - -### center - -• `Optional` **center**: `PointTuple` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:242 - ---- - -### comboPadding - -• `Optional` **comboPadding**: `number` \| `number`[] \| (`d?`: `unknown`) => `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:247 - ---- - -### innerLayout - -• `Optional` **innerLayout**: `Layout`<`any`\> - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:246 - ---- - -### 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:243 - ---- - -### outerLayout - -• `Optional` **outerLayout**: `Layout`<`any`\> - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:245 - ---- - -### spacing - -• `Optional` **spacing**: `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:244 - ---- - -### treeKey - -• `Optional` **treeKey**: `string` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:248 diff --git a/packages/site/docs/apis/layout/WIP-ComboCombinedLayoutOptions.zh.md b/packages/site/docs/apis/layout/WIP-ComboCombinedLayoutOptions.zh.md deleted file mode 100644 index dd23734f1be..00000000000 --- a/packages/site/docs/apis/layout/WIP-ComboCombinedLayoutOptions.zh.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: ComboCombinedLayoutOptions ---- - -> 📋 中文文档还在翻译中... 欢迎 PR - -[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [layout](../../modules/layout.zh.md) / ComboCombinedLayoutOptions - -[layout](../../modules/layout.zh.md).ComboCombinedLayoutOptions - -## Properties - -### center - -• `Optional` **center**: `PointTuple` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:242 - ---- - -### comboPadding - -• `Optional` **comboPadding**: `number` \| `number`[] \| (`d?`: `unknown`) => `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:247 - ---- - -### innerLayout - -• `Optional` **innerLayout**: `Layout`<`any`\> - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:246 - ---- - -### 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:243 - ---- - -### outerLayout - -• `Optional` **outerLayout**: `Layout`<`any`\> - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:245 - ---- - -### spacing - -• `Optional` **spacing**: `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:244 - ---- - -### treeKey - -• `Optional` **treeKey**: `string` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:248 diff --git a/packages/site/docs/apis/layout/WIP-DagreLayoutOptions.en.md b/packages/site/docs/apis/layout/WIP-DagreLayoutOptions.en.md deleted file mode 100644 index 19d36006c9a..00000000000 --- a/packages/site/docs/apis/layout/WIP-DagreLayoutOptions.en.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -title: DagreLayoutOptions ---- - -[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [layout](../../modules/layout.en.md) / DagreLayoutOptions - -[layout](../../modules/layout.en.md).DagreLayoutOptions - -## Properties - -### align - -• `Optional` **align**: `DagreAlign` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:187 - ---- - -### begin - -• `Optional` **begin**: `PointTuple` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:188 - ---- - -### controlPoints - -• `Optional` **controlPoints**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:192 - ---- - -### edgeLabelSpace - -• `Optional` **edgeLabelSpace**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:194 - ---- - -### focusNode - -• `Optional` **focusNode**: `ID` \| `Node` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:197 - ---- - -### nodeOrder - -• `Optional` **nodeOrder**: `string`[] - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:195 - ---- - -### nodeSize - -• `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `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:189 - ---- - -### nodesep - -• `Optional` **nodesep**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:190 - ---- - -### nodesepFunc - -• `Optional` **nodesepFunc**: (`d?`: `Node`) => `number` - -#### Type declaration - -▸ (`d?`): `number` - -##### Parameters - -| Name | Type | -| :--- | :----- | -| `d?` | `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:202 - ---- - -### preset - -• `Optional` **preset**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :---------- | -| `edges` | `Edge`[] | -| `nodes` | `OutNode`[] | - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:198 - ---- - -### radial - -• `Optional` **radial**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:196 - ---- - -### rankdir - -• `Optional` **rankdir**: `DagreRankdir` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:186 - ---- - -### ranksep - -• `Optional` **ranksep**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:191 - ---- - -### ranksepFunc - -• `Optional` **ranksepFunc**: (`d?`: `Node`) => `number` - -#### Type declaration - -▸ (`d?`): `number` - -##### Parameters - -| Name | Type | -| :--- | :----- | -| `d?` | `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:203 - ---- - -### sortByCombo - -• `Optional` **sortByCombo**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:193 diff --git a/packages/site/docs/apis/layout/WIP-DagreLayoutOptions.zh.md b/packages/site/docs/apis/layout/WIP-DagreLayoutOptions.zh.md deleted file mode 100644 index 87bd4658f9c..00000000000 --- a/packages/site/docs/apis/layout/WIP-DagreLayoutOptions.zh.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -title: DagreLayoutOptions ---- - -> 📋 中文文档还在翻译中... 欢迎 PR - -[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [layout](../../modules/layout.zh.md) / DagreLayoutOptions - -[layout](../../modules/layout.zh.md).DagreLayoutOptions - -## Properties - -### align - -• `Optional` **align**: `DagreAlign` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:187 - ---- - -### begin - -• `Optional` **begin**: `PointTuple` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:188 - ---- - -### controlPoints - -• `Optional` **controlPoints**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:192 - ---- - -### edgeLabelSpace - -• `Optional` **edgeLabelSpace**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:194 - ---- - -### focusNode - -• `Optional` **focusNode**: `ID` \| `Node` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:197 - ---- - -### nodeOrder - -• `Optional` **nodeOrder**: `string`[] - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:195 - ---- - -### nodeSize - -• `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `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:189 - ---- - -### nodesep - -• `Optional` **nodesep**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:190 - ---- - -### nodesepFunc - -• `Optional` **nodesepFunc**: (`d?`: `Node`) => `number` - -#### Type declaration - -▸ (`d?`): `number` - -##### Parameters - -| Name | Type | -| :--- | :----- | -| `d?` | `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:202 - ---- - -### preset - -• `Optional` **preset**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :---------- | -| `edges` | `Edge`[] | -| `nodes` | `OutNode`[] | - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:198 - ---- - -### radial - -• `Optional` **radial**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:196 - ---- - -### rankdir - -• `Optional` **rankdir**: `DagreRankdir` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:186 - ---- - -### ranksep - -• `Optional` **ranksep**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:191 - ---- - -### ranksepFunc - -• `Optional` **ranksepFunc**: (`d?`: `Node`) => `number` - -#### Type declaration - -▸ (`d?`): `number` - -##### Parameters - -| Name | Type | -| :--- | :----- | -| `d?` | `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:203 - ---- - -### sortByCombo - -• `Optional` **sortByCombo**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:193 diff --git a/packages/site/docs/apis/layout/WIP-ForceLayoutOptions.en.md b/packages/site/docs/apis/layout/WIP-ForceLayoutOptions.en.md deleted file mode 100644 index 00a7e5394fc..00000000000 --- a/packages/site/docs/apis/layout/WIP-ForceLayoutOptions.en.md +++ /dev/null @@ -1,402 +0,0 @@ ---- -title: ForceLayoutOptions ---- - -[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [layout](../../modules/layout.en.md) / ForceLayoutOptions - -[layout](../../modules/layout.en.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 diff --git a/packages/site/docs/apis/layout/WIP-ForceLayoutOptions.zh.md b/packages/site/docs/apis/layout/WIP-ForceLayoutOptions.zh.md deleted file mode 100644 index 81c1fe5b5ef..00000000000 --- a/packages/site/docs/apis/layout/WIP-ForceLayoutOptions.zh.md +++ /dev/null @@ -1,404 +0,0 @@ ---- -title: ForceLayoutOptions ---- - -> 📋 中文文档还在翻译中... 欢迎 PR - -[Overview - v5.0.0-beta.21](../../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 diff --git a/packages/site/docs/apis/layout/WIP-GridLayoutOptions.en.md b/packages/site/docs/apis/layout/WIP-GridLayoutOptions.en.md deleted file mode 100644 index 5f6465a0f68..00000000000 --- a/packages/site/docs/apis/layout/WIP-GridLayoutOptions.en.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: GridLayoutOptions ---- - -[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [layout](../../modules/layout.en.md) / GridLayoutOptions - -[layout](../../modules/layout.en.md).GridLayoutOptions - -## Properties - -### begin - -• `Optional` **begin**: `PointTuple` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:130 - ---- - -### cols - -• `Optional` **cols**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:136 - ---- - -### condense - -• `Optional` **condense**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:134 - ---- - -### 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:129 - ---- - -### nodeSize - -• `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `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:132 - ---- - -### nodeSpacing - -• `Optional` **nodeSpacing**: `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:142 - ---- - -### position - -• `Optional` **position**: (`node?`: `Node`) => { `col?`: `number` ; `row?`: `number` } - -#### Type declaration - -▸ (`node?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :----- | -| `node?` | `Node` | - -##### Returns - -`Object` - -| Name | Type | -| :----- | :------- | -| `col?` | `number` | -| `row?` | `number` | - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:138 - ---- - -### 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:131 - ---- - -### preventOverlapPadding - -• `Optional` **preventOverlapPadding**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:133 - ---- - -### rows - -• `Optional` **rows**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:135 - ---- - -### sortBy - -• `Optional` **sortBy**: `string` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:137 - ---- - -### 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:128 diff --git a/packages/site/docs/apis/layout/WIP-GridLayoutOptions.zh.md b/packages/site/docs/apis/layout/WIP-GridLayoutOptions.zh.md deleted file mode 100644 index 4d1ea74cbb6..00000000000 --- a/packages/site/docs/apis/layout/WIP-GridLayoutOptions.zh.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: GridLayoutOptions ---- - -> 📋 中文文档还在翻译中... 欢迎 PR - -[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [layout](../../modules/layout.zh.md) / GridLayoutOptions - -[layout](../../modules/layout.zh.md).GridLayoutOptions - -## Properties - -### begin - -• `Optional` **begin**: `PointTuple` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:130 - ---- - -### cols - -• `Optional` **cols**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:136 - ---- - -### condense - -• `Optional` **condense**: `boolean` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:134 - ---- - -### 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:129 - ---- - -### nodeSize - -• `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `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:132 - ---- - -### nodeSpacing - -• `Optional` **nodeSpacing**: `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:142 - ---- - -### position - -• `Optional` **position**: (`node?`: `Node`) => { `col?`: `number` ; `row?`: `number` } - -#### Type declaration - -▸ (`node?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :----- | -| `node?` | `Node` | - -##### Returns - -`Object` - -| Name | Type | -| :----- | :------- | -| `col?` | `number` | -| `row?` | `number` | - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:138 - ---- - -### 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:131 - ---- - -### preventOverlapPadding - -• `Optional` **preventOverlapPadding**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:133 - ---- - -### rows - -• `Optional` **rows**: `number` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:135 - ---- - -### sortBy - -• `Optional` **sortBy**: `string` - -#### Defined in - -node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:137 - ---- - -### 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:128