From 65673965936273b13057fa1eb13c6dd85864cc35 Mon Sep 17 00:00:00 2001 From: wangxingkang Date: Mon, 28 Apr 2025 10:38:36 +0800 Subject: [PATCH 1/2] docs: nameKey >> nodeKey --- docs/assets/examples/en/sankey-chart/nameKey-sankey.md | 4 ++-- docs/assets/examples/zh/sankey-chart/nameKey-sankey.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/assets/examples/en/sankey-chart/nameKey-sankey.md b/docs/assets/examples/en/sankey-chart/nameKey-sankey.md index 35f1f94e57..097a6151ea 100644 --- a/docs/assets/examples/en/sankey-chart/nameKey-sankey.md +++ b/docs/assets/examples/en/sankey-chart/nameKey-sankey.md @@ -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 diff --git a/docs/assets/examples/zh/sankey-chart/nameKey-sankey.md b/docs/assets/examples/zh/sankey-chart/nameKey-sankey.md index a2290dfb84..3e16a8e873 100644 --- a/docs/assets/examples/zh/sankey-chart/nameKey-sankey.md +++ b/docs/assets/examples/zh/sankey-chart/nameKey-sankey.md @@ -13,8 +13,8 @@ option: sankeyChart 桑基图的边具有起点节点（source）和终点节点（source），可以使用两种形式来表示节点： - 默认使用 nodes 的索引值。 -- 通过配置 nameKey 的回调函数，使用节点名称作为边的起点节点和终点节点。 - 这个例子就使用 nameKey 的回调函数作为边的节点配置的。 +- 通过配置 nodeKey 的回调函数，使用节点名称作为边的起点节点和终点节点。 + 这个例子就使用 nodeKey 的回调函数作为边的节点配置的。 ## 关键配置 From fc8b3cc20af195ff80446f9767e213ef235492c7 Mon Sep 17 00:00:00 2001 From: wangxingkang Date: Mon, 28 Apr 2025 10:39:14 +0800 Subject: [PATCH 2/2] feat(sankey): remove nameKey type --- packages/vchart-types/types/series/sankey/interface.d.ts | 1 - packages/vchart/src/series/sankey/interface.ts | 1 - 2 files changed, 2 deletions(-) diff --git a/packages/vchart-types/types/series/sankey/interface.d.ts b/packages/vchart-types/types/series/sankey/interface.d.ts index 1ff50cb203..a82b6925ca 100644 --- a/packages/vchart-types/types/series/sankey/interface.d.ts +++ b/packages/vchart-types/types/series/sankey/interface.d.ts @@ -15,7 +15,6 @@ export type ISankeyLabelSpec = ILabelSpec & { limit?: number; }; export interface ISankeySeriesSpec extends Omit, IAnimationSpec { - nameKey: any; type: 'sankey'; categoryField: string; valueField: string; diff --git a/packages/vchart/src/series/sankey/interface.ts b/packages/vchart/src/series/sankey/interface.ts index 6858325af0..2cac5d0210 100644 --- a/packages/vchart/src/series/sankey/interface.ts +++ b/packages/vchart/src/series/sankey/interface.ts @@ -24,7 +24,6 @@ export type ISankeyLabelSpec = ILabelSpec & { }; export interface ISankeySeriesSpec extends Omit, IAnimationSpec { - nameKey: any; type: 'sankey'; /**