feat: customMergeCell support array config #3202

common/changes/@visactor/vtable/feat-custom-merge-config_2024-12-30-11-28.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@visactor/vtable",
+      "comment": "feat: customMergeCell support array config #3202",
+      "type": "none"
+    }
+  ],
+  "packageName": "@visactor/vtable"
+}

packages/vtable/src/core/BaseTable.ts

@@ -151,6 +151,7 @@ import type { ITableAnimationOption } from '../ts-types/animation/appear';
 import { checkCellInSelect } from '../state/common/check-in-select';
 import type { CustomCellStylePlugin, ICustomCellStylePlugin } from '../plugins/custom-cell-style';
 import { isCellDisableSelect } from '../state/select/is-cell-select-highlight';
+import { getCustomMergeCellFunc } from './utils/get-custom-merge-cell-func';
 
 const { toBoxArray } = utilStyle;
 const { isTouchEvent } = event;
@@ -498,7 +499,7 @@ export abstract class BaseTable extends EventTarget implements BaseTableAPI {
 
     internalProps.stick = { changedCells: new Map() };
 
-    internalProps.customMergeCell = options.customMergeCell;
+    internalProps.customMergeCell = getCustomMergeCellFunc(options.customMergeCell);
 
     const CustomCellStylePlugin = Factory.getComponent('customCellStylePlugin') as ICustomCellStylePlugin;
     if (CustomCellStylePlugin) {
@@ -2427,7 +2428,7 @@ export abstract class BaseTable extends EventTarget implements BaseTableAPI {
     this.clearColWidthCache();
     this.clearRowHeightCache();
 
-    internalProps.customMergeCell = options.customMergeCell;
+    internalProps.customMergeCell = getCustomMergeCellFunc(options.customMergeCell);
 
     this.customCellStylePlugin?.updateCustomCell(
       options.customCellStyle ?? [],

packages/vtable/src/core/utils/get-custom-merge-cell-func.ts

@@ -0,0 +1,21 @@
+import { isArray, isFunction } from '@visactor/vutils';
+import type { CustomMergeCell } from '../../ts-types';
+
+export function getCustomMergeCellFunc(customMergeCell?: CustomMergeCell) {
+  if (isFunction(customMergeCell)) {
+    return customMergeCell;
+  }
+  if (isArray(customMergeCell)) {
+    return (col: number, row: number) => {
+      return customMergeCell.find(item => {
+        return (
+          item.range.start.col <= col &&
+          item.range.end.col >= col &&
+          item.range.start.row <= row &&
+          item.range.end.row >= row
+        );
+      });
+    };
+  }
+  return undefined;
+}

packages/vtable/src/ts-types/base-table.ts

@@ -72,7 +72,8 @@ import type {
   ColumnInfo,
   RowInfo,
   CellAddressWithBound,
-  Placement
+  Placement,
+  CustomMergeCellFunc
 } from '.';
 import type { TooltipOptions } from './tooltip';
 import type { IWrapTextGraphicAttribute } from '../scenegraph/graphic/text';
@@ -259,7 +260,7 @@ export interface IBaseTableProtected {
 
   stick: { changedCells: Map<string, StickCell> };
 
-  customMergeCell?: CustomMergeCell;
+  customMergeCell?: CustomMergeCellFunc;
   /**
    * 'auto':和浏览器滚动行为一致 表格滚动到顶部/底部时 触发浏览器默认行为;
    *  设置为 'none' 时, 表格滚动到顶部/底部时, 不再触发父容器滚动

packages/vtable/src/ts-types/table-engine.ts

@@ -591,7 +591,10 @@ export interface IExtensionRowDefine {
 
 export type StickCell = { col: number; row: number; dx: number; dy: number };
 
-export type CustomMergeCell = (col: number, row: number, table: BaseTableAPI) => undefined | CustomMerge;
+export type CustomMergeCell = CustomMergeCellFunc | CustomMergeCellArray;
+
+export type CustomMergeCellFunc = (col: number, row: number, table: BaseTableAPI) => undefined | CustomMerge;
+export type CustomMergeCellArray = CustomMerge[];
 export type CustomMerge = {
   range: CellRange;
   text?: string;