Skip to content

feat: add channel to tooltip item #7099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
moayuisuda wants to merge 3 commits into
base: v5
Choose a base branch
from
Open

feat: add channel to tooltip item #7099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
307ad09
feat: add channel to tooltip item
Aug 26, 2025
f3cc540
fix: add snapshot
Aug 28, 2025
a505915
Merge branch 'v5' into feat/channel-param-in-tooltip
moayuisuda Nov 12, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion __tests__/integration/api-chart-emit-tooltip-show.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ describe('chart.emit tooltip with line', () => {
container.querySelector('.tooltip-content');

expect(tooltipData?.innerText).toEqual(
`{"title":"1997","items":[{"value":7,"color":"#1783FF","name":"value"}],"data":{"x":"1997"}}`,
`{"title":"1997","items":[{"value":7,"color":"#1783FF","name":"value","channel":"value"}],"data":{"x":"1997"}}`,
);
});

Expand Down
1 change: 1 addition & 0 deletions src/interaction/tooltip.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,7 @@ function groupItems(
...item,
color,
name: name1 || title,
channel: name,
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

新属性 channel 的命名可以更具描述性。根据 PR 的描述，这个属性旨在保留 y 轴编码中的原始字段名，当使用 series 时，该字段名会丢失。

在 G2 中，channel 一词通常指代像 x、y 或 color 这样的视觉通道。这里存储的值是映射到某个通道的数据集中的字段（field）。因此，将此属性命名为 field 会更准确，对于自定义 tooltip 的用户来说也不会那么模棱两可。

我建议将 channel 重命名为 field。这将使该属性在 tooltip item 数据结构中的用途更加清晰。

Suggested change
channel: name,
field: name,
Copy link
Member

@lxfu1 lxfu1 Aug 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

感觉可以参考 code assist ，field 挺好的。
};
},
);
Expand Down
Loading