fix(sankey): 修复桑基图 rawFields 在 label & tooltip 处不生效

__tests__/bugs/issue-2755-spec.ts

@@ -0,0 +1,52 @@
+import { Sankey } from '../../src';
+import { createDiv, removeDom } from '../utils/dom';
+import { PARALLEL_SET } from '../data/parallel-set';
+
+describe('sankey', () => {
+  const data = [];
+  const keys = ['Survived', 'Sex', 'Age', 'Class'];
+  PARALLEL_SET.forEach((d) => {
+    keys.reduce((a, b) => {
+      if (a && b) {
+        data.push({
+          source: d[a],
+          target: d[b],
+          value: d.value,
+          path: `${d[keys[0]]} -> ${d[keys[1]]} -> ${d[keys[2]]} -> ${d[keys[3]]}`,
+        });
+      }
+      return b;
+    });
+  });
+
+  const dom = createDiv();
+  const sankey = new Sankey(dom, {
+    data: data.map((d) => ({ ...d, append: 'hello' })),
+    sourceField: 'source',
+    targetField: 'target',
+    weightField: 'value',
+    rawFields: ['append'],
+    nodeWidthRatio: 0.01,
+    nodePaddingRatio: 0.03,
+    nodeDraggable: true,
+  });
+
+  sankey.render();
+
+  it('label', () => {
+    sankey.update({ label: { formatter: () => 'HELLO' } });
+    expect(sankey.chart.views[1].geometries[0].labelsContainer.getChildByIndex(0).cfg.children[0].attr('text')).toBe(
+      'HELLO'
+    );
+    // with rawFields
+    sankey.update({ label: { formatter: ({ append }) => append } });
+    expect(sankey.chart.views[1].geometries[0].labelsContainer.getChildByIndex(0).cfg.children[0].attr('text')).toBe(
+      'hello'
+    );
+  });
+
+  afterAll(() => {
+    sankey.destroy();
+    removeDom(dom);
+  });
+});

src/plots/sankey/adaptor.ts

@@ -1,10 +1,35 @@
+import { uniq } from '@antv/util';
 import { interaction, theme } from '../../adaptor/common';
 import { Params } from '../../core/adaptor';
-import { flow } from '../../utils';
+import { deepAssign, flow } from '../../utils';
 import { polygon, edge } from '../../adaptor/geometries';
+import { transformToViewsData } from './helper';
 import { SankeyOptions } from './types';
 import { X_FIELD, Y_FIELD, COLOR_FIELD, EDGES_VIEW_ID, NODES_VIEW_ID } from './constant';
-import { transformToViewsData } from './helper';
+
+/**
+ * 默认配置项 处理
+ * @param params
+ */
+function defaultOptions(params: Params<SankeyOptions>): Params<SankeyOptions> {
+  const { options } = params;
+  const { rawFields = [] } = options;
+
+  return deepAssign(
+    {},
+    {
+      options: {
+        tooltip: {
+          fields: uniq(['name', 'source', 'target', 'value', 'isNode', ...rawFields]),
+        },
+        label: {
+          fields: uniq(['x', 'name', ...rawFields]),
+        },
+      },
+    },
+    params
+  );
+}
 
 /**
  * geometry 处理
@@ -135,6 +160,7 @@ export function nodeDraggable(params: Params<SankeyOptions>): Params<SankeyOptio
 export function adaptor(params: Params<SankeyOptions>) {
   // flow 的方式处理所有的配置到 G2 API
   return flow(
+    defaultOptions,
     geometry,
     interaction,
     nodeDraggable,

src/plots/sankey/index.ts

@@ -33,16 +33,15 @@ export class Sankey extends Plot<SankeyOptions> {
         lineWidth: 0,
       },
       label: {
-        fields: ['x', 'name'],
-        callback: (x: number[], name: string) => {
+        formatter: ({ name }) => name,
+        callback: (x: number[]) => {
           const isLast = x[1] === 1; // 最后一列靠边的节点
           return {
             style: {
               fill: '#545454',
               textAlign: isLast ? 'end' : 'start',
             },
             offsetX: isLast ? -8 : 8,
-            content: name,
           };
         },
         layout: [
@@ -55,7 +54,6 @@ export class Sankey extends Plot<SankeyOptions> {
         showTitle: false,
         showMarkers: false,
         shared: false,
-        fields: ['name', 'source', 'target', 'value', 'isNode'],
         // 内置：node 不显示 tooltip，edge 显示 tooltip
         showContent: (items) => {
           return !get(items, [0, 'data', 'isNode']);