docs: 更新布局文档#7654
Open
yvonneyx wants to merge 10 commits into
Open
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the G6 layout documentation for version 5.1 to align with the @antv/layout package, introducing common configuration fields across various layout types and adding migration guides for upgrading from version 5.0. Notable changes include the simplification of ComboCombined layout options and the addition of shortcut fields for D3Force. Feedback points out Markdown formatting issues in the ConcentricLayout property table and recommends consistent use of the @antv/layout package name throughout the documentation.
| | startAngle | The angle (in radians) to start laying out nodes | number | 3 / 2 \* Math.PI | | | ||
| | sweep | The angle difference between the first and last node in the same layer. If undefined, set to 2 _Math.PI_ (1 - 1 / level.nodes ) | number | undefined | | | ||
| | Property | Description | Type | Default | Required | | ||
| | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------- | -------- | --------- | --- | |
Contributor
There was a problem hiding this comment.
表格分隔行（separator line）的列数（7列）与表头（5列）不匹配，这会导致 Markdown 表格无法正确渲染。建议删除多余的列以保持一致。
Suggested change
| | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------- | -------- | --------- | --- | | |
| | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------- | -------- | |
| | nodeSpacing | Minimum spacing between rings, used to adjust the radius | number \| number[] \| ((node?: Node) => number) | 10 | | | ||
| | preventOverlap | Whether to prevent overlap. Must be used with nodeSize or data.size. Only works if node size is set in data or in this layout config. | boolean | false | | | ||
| | startAngle | The angle (in radians) to start laying out nodes | number | 3 / 2 \* Math.PI | | | ||
| | sweep | The angle difference between the first and last node in the same layer. If undefined, it is set to `2 _ Math.PI _ (1 - 1 / | level.nodes | )`, where `level.nodes` is the set of nodes in that layer | number | undefined | | |
Contributor
There was a problem hiding this comment.
sweep 这一行的格式错误，包含了多余的竖线（|），导致表格布局混乱。建议将公式部分合并到描述列中，并修正列数。
Suggested change
| | sweep | The angle difference between the first and last node in the same layer. If undefined, it is set to `2 _ Math.PI _ (1 - 1 / | level.nodes | )`, where `level.nodes` is the set of nodes in that layer | number | undefined | | | |
| | sweep | The angle difference between the first and last node in the same layer. If undefined, it is set to `2 * Math.PI * (1 - 1 / level.nodes)`, where `level.nodes` is the set of nodes in that layer | number | undefined | | |
|
|
||
| Additional notes: | ||
|
|
||
| - `width` / `height` / `center` are common layout fields uniformly supported by `@antvis/layout`. |
Contributor
There was a problem hiding this comment.
这里提到的包名 @antvis/layout 与 overview.en.md 中使用的 @antv/layout 不一致。考虑到 npm 上的正式包名通常是 @antv/layout，建议统一使用 @antv/layout。
Suggested change
| - `width` / `height` / `center` are common layout fields uniformly supported by `@antvis/layout`. | |
| - `width` / `height` / `center` are common layout fields uniformly supported by `@antv/layout`. |
|
|
||
| 补充说明： | ||
|
|
||
| - `width` / `height` / `center` 是 `@antvis/layout` 统一支持的通用布局字段。 |
Contributor
There was a problem hiding this comment.
这里提到的包名 @antvis/layout 与 overview.zh.md 中使用的 @antv/layout 不一致。建议统一使用 @antv/layout。
Suggested change
| - `width` / `height` / `center` 是 `@antvis/layout` 统一支持的通用布局字段。 | |
| - `width` / `height` / `center` 是 `@antv/layout` 统一支持的通用布局字段。 |
|
|
||
| 也可在图实例化之后使用 `graph.setLayout` 来更新布局配置。 | ||
|
|
||
| 5.1 开始，布局文档中的通用字段已与 `@antvis/layout` 对齐。除了各布局自己的算法参数外，也建议同时关注 `width`、`height`、`center`、`enableWorker`、`node`、`edge` 等公共配置。 |
Contributor
There was a problem hiding this comment.
建议将 @antvis/layout 统一为 @antv/layout，以保持与英文文档及实际包名的一致性。
Suggested change
| 5.1 开始，布局文档中的通用字段已与 `@antvis/layout` 对齐。除了各布局自己的算法参数外，也建议同时关注 `width`、`height`、`center`、`enableWorker`、`node`、`edge` 等公共配置。 | |
| 5.1 开始，布局文档中的通用字段已与 `@antv/layout` 对齐。除了各布局自己的算法参数外，也建议同时关注 `width`、`height`、`center`、`enableWorker`、`node`、`edge` 等公共配置。 |
hustcc
approved these changes
May 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.