Skip to content

修复 sanKey 示例文档错误。并移除 nameKey 无用类型 #3933

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

Merged
xile611 merged 2 commits into from
Apr 28, 2025
+4 −6
Merged

修复 sanKey 示例文档错误。并移除 nameKey 无用类型 #3933

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6567396
docs: nameKey >> nodeKey
wangxingkang Apr 28, 2025
fc8b3cc
feat(sankey): remove nameKey type
wangxingkang Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/assets/examples/en/sankey-chart/nameKey-sankey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ option: sankeyChart
The links of a Sankey diagram have a source node and an end node (source), and nodes can be represented in two forms:

- By default, the index value of nodes is used.
- By configuring the callback function of nameKey, use the node name as the starting and ending nodes of the edge.
This example uses the callback function of nameKey as the node configuration of the edge.
- By configuring the callback function of nodeKey, use the node name as the starting and ending nodes of the edge.
This example uses the callback function of nodeKey as the node configuration of the edge.

## Key option

Expand Down
4 changes: 2 additions & 2 deletions docs/assets/examples/zh/sankey-chart/nameKey-sankey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ option: sankeyChart
桑基图的边具有起点节点（source）和终点节点（source），可以使用两种形式来表示节点：

- 默认使用 nodes 的索引值。
- 通过配置 nameKey 的回调函数，使用节点名称作为边的起点节点和终点节点。
这个例子就使用 nameKey 的回调函数作为边的节点配置的。
- 通过配置 nodeKey 的回调函数，使用节点名称作为边的起点节点和终点节点。
这个例子就使用 nodeKey 的回调函数作为边的节点配置的。

## 关键配置

Expand Down
1 change: 0 additions & 1 deletion packages/vchart-types/types/series/sankey/interface.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ export type ISankeyLabelSpec = ILabelSpec & {
limit?: number;
};
export interface ISankeySeriesSpec extends Omit<ISeriesSpec, 'data'>, IAnimationSpec<SankeyMark, SankeyAppearPreset> {
nameKey: any;
type: 'sankey';
categoryField: string;
valueField: string;
Expand Down
1 change: 0 additions & 1 deletion packages/vchart/src/series/sankey/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ export type ISankeyLabelSpec = ILabelSpec & {
};

export interface ISankeySeriesSpec extends Omit<ISeriesSpec, 'data'>, IAnimationSpec<SankeyMark, SankeyAppearPreset> {
nameKey: any;
type: 'sankey';

/**
Expand Down