feat: expr by yvonneyx · Pull Request #285 · antvis/layout

yvonneyx · 2026-01-09T08:37:23Z

当传入的参数是回调形式时，启动 worker 会有问题，回调无法序列化，这里引用 @antv/expr

gemini-code-assist · 2026-01-09T08:39:03Z

Summary of Changes

Hello @yvonneyx, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

本次拉取请求的核心目标是增强布局配置的灵活性和兼容性。通过引入表达式解析能力，解决了 Web Worker 环境下回调函数序列化受限的问题，并统一了节点尺寸和间距的处理逻辑，使得布局算法能够更强大、更易用。这些改进为用户提供了更精细的控制，并确保了不同运行环境下的稳定性。

Highlights

引入表达式支持: 引入了 @antv/expr 库，使得布局配置项（如节点大小、间距、排序依据等）现在可以接受字符串表达式。这解决了在 Web Worker 环境下回调函数无法序列化的问题，并提供了更灵活的动态配置能力。
统一节点尺寸和间距处理: 将 nodeSize 和 nodeSpacing 属性从各个具体布局算法的配置中移除，并统一到 BaseLayoutOptions 中。同时，formatNodeSizeFn 现在返回 STDSize 数组，并能正确处理节点尺寸和间距的宽度和高度分量。
更新布局算法以支持表达式: 多个布局算法（包括 dagre, d3-force, fruchterman, concentric, combo-combined, radial, grid）的实现和类型定义已更新，以充分利用新的表达式功能，允许用户通过字符串定义复杂的行为。
新增和更新测试快照: 新增了多个 d3-force 布局相关的 SVG 快照文件，并更新了 fruchterman 示例，以验证和展示新功能带来的视觉效果和正确性。

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

这个 PR 引入了 @antv/expr 来支持将字符串表达式作为布局参数，解决了回调函数无法序列化导致 worker 失效的问题，这是一个很棒的改进。同时，将 nodeSize 和 nodeSpacing 等通用配置提升到 BaseLayoutOptions 中，使得 API 更加统一和清晰。整体代码风格良好，改动清晰。

src/algorithm/dagre/index.ts

codecov-commenter · 2026-01-12T09:20:10Z

Codecov Report

❌ Patch coverage is 96.15385% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.12%. Comparing base (59c85b8) to head (8aa1ad2).
⚠️ Report is 3 commits behind head on v5.

Files with missing lines	Patch %	Lines
src/algorithm/force/index.ts	90.90%	3 Missing ⚠️
src/algorithm/fruchterman/index.ts	75.00%	1 Missing ⚠️
src/algorithm/grid/index.ts	93.75%	1 Missing ⚠️
src/util/format.ts	97.43%	1 Missing ⚠️
src/util/size.ts	80.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##               v5     #285      +/-   ##
==========================================
+ Coverage   85.44%   86.12%   +0.68%     
==========================================
  Files          76       77       +1     
  Lines        5887     5938      +51     
  Branches     1411     1440      +29     
==========================================
+ Hits         5030     5114      +84     
+ Misses        856      823      -33     
  Partials        1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

__tests__/snapshots/dagre/edge-labels.svg

Aarebecca · 2026-01-12T09:24:40Z

__tests__/unit/force.test.ts

+      nodeStrength: 'node.data.ns',
+      edgeStrength: 'edge.data.es',
+      linkDistance: 'edge.data.len',
+      clusterNodeStrength: 'node.data.cs',


这个是 @antv/expr 支持的还是 layout 自己实现的

antv/expr 支持

Aarebecca · 2026-01-12T09:25:53Z

__tests__/unit/util/format.test.ts

    test('should return node size plus spacing', () => {
      const result = formatNodeSizeFn(20, 5, 10);
-      expect(result()).toBe(25);
+      expect(result()).toEqual([25, 25, 25]);


这三个值分别是啥意思

【长、宽、高】

Aarebecca · 2026-01-12T09:28:41Z

src/algorithm/antv-dagre/types.ts

   * @param d - <zh/> 节点实例 | <en/> Node instance
   */
-  nodesepFunc?: (d?: NodeData) => number;
+  nodesepFunc?: Expr | ((node: NodeData) => number);


直接写出 string | ((node: NodeData) => number ?

这里区分一下是 string 或者 type Expr=string

Aarebecca · 2026-01-12T09:30:46Z

src/algorithm/concentric/types.ts

-   * <en/> Minimum spacing between rings, used to adjust the radius
-   * @defaultValue 10
-   */
-  nodeSpacing?: number | ((d?: NodeData) => number);


这个参数删掉有影响吗

提到通用配置里了

Aarebecca

文档里面可以要补充一下，一个是 Expr 的写法，还有就是可以访问的局部变量

gemini-code-assist bot reviewed Jan 9, 2026

View reviewed changes

src/algorithm/dagre/index.ts Show resolved Hide resolved

yvonneyx added 3 commits January 12, 2026 15:59

feat: expr

7bb73c9

test: update tests

a15926e

fix: d3force id

a5f5486

yvonneyx force-pushed the structured-clone branch from 555946d to a5f5486 Compare January 12, 2026 09:15

Aarebecca reviewed Jan 12, 2026

View reviewed changes

Aarebecca approved these changes Jan 12, 2026

View reviewed changes

yvonneyx added 3 commits January 12, 2026 17:44

docs: update docs

e7ccfd8

fix: 修复边标签位置函数的类型判断

2a730f3

docs: add webworker docs

cf9dda2

yvonneyx force-pushed the structured-clone branch from 11d117f to cf9dda2 Compare January 12, 2026 10:00

fix: 更新边标签位置的 SVG 路径和坐标

985cae2

yvonneyx added the publish label Jan 13, 2026

fix: 更新版本号至 2.0.0-beta.1

8aa1ad2

yvonneyx merged commit 6cec35f into v5 Jan 13, 2026
2 checks passed

yvonneyx deleted the structured-clone branch January 13, 2026 02:32

Conversation

yvonneyx commented Jan 9, 2026

Uh oh!

gemini-code-assist bot commented Jan 9, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

codecov-commenter commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aarebecca left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov-commenter commented Jan 12, 2026 •

edited

Loading