chore: update nodeDepth

Author: hustcc

__tests__/bugs/issue-2353-spec.ts

@@ -21,6 +21,7 @@ describe('#2353', () => {
   ];
 
   it('sankey depth config', () => {
+    let maxDepth;
     const sankey = new Sankey(createDiv(), {
       data: DATA,
       padding: 0,
@@ -31,7 +32,8 @@ describe('#2353', () => {
       sourceField: 'source',
       targetField: 'target',
       weightField: 'weight',
-      nodeDepth: (node: Datum) => {
+      nodeDepth: (node: Datum, n) => {
+        maxDepth = n;
         const { name } = node;
         return {
           n1: 0,
@@ -49,6 +51,8 @@ describe('#2353', () => {
     // 指定了 depth，所以 n4 节点的 x 是画布中间
     expect(sankey.chart.views[1].geometries[0].elements[3].shape.getBBox().x).toBe(247.5);
 
+    expect(maxDepth).toBe(3);
+
     sankey.destroy();
   });
 });

docs/api/plots/sankey.en.md

@@ -71,11 +71,11 @@ The sankey diagram node layout direction, the default is `the justify`, can choo
 
 <description>**optional** _Function_</description>
 
-The sankey diagram node `depth` configure, use function to return the depth value, started from zero.
+The sankey diagram node `depth` configure, use function to return the depth value, started from zero, and we need to ensure contains node in every depth level.
 
 ```ts
 {
-  nodeDepth: (datum) => {
+  nodeDepth: (datum, maxDepth) => {
     const { name } = datum;
     if (name === 'node1') {
       return 0;

docs/api/plots/sankey.zh.md

@@ -71,11 +71,11 @@ order: 27
 
 <description>**optional** _Function_</description>
 
-桑基图节点的深度配置，使用回调进行自定义，返回 depth 数值，从 0 开始。
+桑基图节点的深度配置，使用回调进行自定义，返回 depth 数值，从 0 开始，并且返回值需要保证所有的层级都有节点。
 
 ```ts
 {
-  nodeDepth: (datum) => {
+  nodeDepth: (datum, maxDepth) => {
     const { name } = datum;
     if (name === 'node1') {
       return 0;

src/plots/sankey/types.ts

@@ -44,7 +44,7 @@ export interface SankeyOptions extends Omit<Options, 'xField' | 'yField' | 'xAxi
    */
   readonly nodeSort?: (a: Datum, b: Datum) => number;
   /**
-   * 节点排放分层的顺序，从 0 开始
+   * 节点排放分层的顺序，从 0 开始，并且返回值需要保证所有的层级都有节点
    */
   readonly nodeDepth?: NodeDepth;
   /**

src/utils/transform/sankey.ts

@@ -69,7 +69,7 @@ export type NodeAlign = keyof typeof ALIGN_METHOD;
 /**
  * 节点的 depth 自定义
  */
-export type NodeDepth = (datum: Datum) => number;
+export type NodeDepth = (datum: Datum, maxDepth: number) => number;
 
 /**
  * 布局参数的定义
@@ -107,7 +107,7 @@ const DEFAULT_OPTIONS: Partial<SankeyLayoutOptions> = {
  */
 export function getNodeAlignFunction(nodeAlign: NodeAlign, nodeDepth: SankeyOptions['nodeDepth']) {
   if (nodeDepth) {
-    return (node) => nodeDepth(pick(node, ['name']) as any);
+    return (node, maxDepth) => nodeDepth(node, maxDepth);
   }
 
   const func = isString(nodeAlign) ? ALIGN_METHOD[nodeAlign] : isFunction(nodeAlign) ? nodeAlign : null;