Merge pull request #4944 from newstart0514/feat/cancelEdit

feat: add cancelEditCell method to ListTable and PivotTable APIs

Author: fangsmile

common/changes/@visactor/vtable/feat-cancelEdit_2026-01-21-00-59.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "feat: add cancelEditCell method to ListTable and PivotTable APIs\n\n",
+      "type": "none",
+      "packageName": "@visactor/vtable"
+    }
+  ],
+  "packageName": "@visactor/vtable",
+  "email": "1418591636@qq.com"
+}

docs/assets/api/en/methods.md

@@ -1757,6 +1757,15 @@ End editing
   completeEditCell: () => void;
 ```
 
+## cancelEditCell(Function)
+
+Cancel editing without saving any changes
+
+```
+  /** Cancel editing */
+  cancelEditCell: () => void;
+```
+
 ## records
 
 Get all data of the current table

docs/assets/api/zh/methods.md

@@ -1759,6 +1759,15 @@ const rowImage = tableInstance.exportCellRangeImg(rowRange);
   completeEditCell: () => void;
 ```
 
+## cancelEditCell(Function)
+
+取消编辑，不保存任何更改
+
+```
+  /** 取消编辑 */
+  cancelEditCell: () => void;
+```
+
 ## records
 
 获取当前表格的全部数据

docs/assets/guide/en/edit/edit_cell.md

@@ -317,6 +317,8 @@ interface ListTableAPI {
   startEditCell: (col?: number, row?: number, value?: string | number) => void;
   /** End editing */
   completeEditCell: () => void;
+  /** Cancel editing */
+  cancelEditCell: () => void;
   // ...
 }
 ```

docs/assets/guide/zh/edit/edit_cell.md

@@ -318,6 +318,8 @@ interface ListTableAPI {
   startEditCell: (col?: number, row?: number, value?: string | number) => void;
   /** 结束编辑 */
   completeEditCell: () => void;
+  /** 取消编辑 */
+  cancelEditCell: () => void;
   // ...
 }
 ```

packages/vtable/src/ListTable.ts

@@ -1530,6 +1530,10 @@ export class ListTable extends BaseTable implements ListTableAPI {
   completeEditCell() {
     this.editorManager.completeEdit();
   }
+  /** 取消编辑 */
+  cancelEditCell() {
+    this.editorManager.cancelEdit();
+  }
   /** 获取单元格对应的编辑器 */
   getEditor(col: number, row: number) {
     const lastSelectedCellEditor = this.editorManager.cacheLastSelectedCellEditor[`${col}-${row}`];

packages/vtable/src/PivotTable.ts

@@ -1753,6 +1753,10 @@ export class PivotTable extends BaseTable implements PivotTableAPI {
   completeEditCell() {
     this.editorManager.completeEdit();
   }
+  /** 取消编辑 */
+  cancelEditCell() {
+    this.editorManager.cancelEdit();
+  }
   /** 获取单元格对应的编辑器 */
   getEditor(col: number, row: number) {
     const lastSelectedCellEditor = this.editorManager.cacheLastSelectedCellEditor[`${col}-${row}`];

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

@@ -387,6 +387,8 @@ export interface ListTableAPI extends BaseTableAPI {
   startEditCell: (col?: number, row?: number, value?: string | number) => void;
   /** 结束编辑 */
   completeEditCell: () => void;
+  /** 取消编辑 */
+  cancelEditCell: () => void;
   //#endregion
   addRecord: (record: any, recordIndex?: number) => void;
   addRecords: (records: any[], recordIndex?: number) => void;