AgGrid grid.api.getEditingCells()方法部分环境无法返回编辑单元格问题排查

可能的原因 #

• 版本不一致：不同环境使用的AgGrid版本存在差异，部分旧版本（如v27之前的部分分支）存在Tab切换编辑时getEditingCells()内部状态不同步的bug。
• 编辑配置不统一：各环境的Grid编辑相关配置（如editType、stopEditingWhenGridLosesFocus）不一致，导致编辑状态的跟踪逻辑出现偏差。
• 初始化时机问题：部分环境中Grid初始化时，编辑状态监听事件未正确挂载，导致getEditingCells()依赖的内部状态未被更新。
• 自定义编辑器干扰：如果使用了自定义单元格编辑器，部分环境下编辑器未正确同步编辑状态到Grid API，比如未在激活时调用状态更新方法。

解决办法 #

1. 统一AgGrid版本
   升级到v27及以上的稳定版本，官方在后续版本中修复了Tab切换编辑时的状态同步问题，确保getEditingCells()行为一致。

2. 对齐全局编辑配置
   确保所有环境的Grid配置完全一致，示例配置如下：

   const gridOptions = {
     editType: 'cell', // 或'fullRow'，根据业务需求统一设置
     enterMoveDown: true,
     stopEditingWhenGridLosesFocus: false, // 保持各环境配置相同
     suppressClickEdit: false
   };
   

3. 强制状态同步
   在cellEditingStarted事件中调用api.flush()强制Grid同步内部状态，确保getEditingCells()能获取到最新编辑单元格：

   gridOptions.onCellEditingStarted = (params) => {
     params.api.flush();
     const editingCells = params.api.getEditingCells();
     // 此时editingCells应包含当前编辑单元格
   };
   

4. 修复自定义编辑器
   如果使用自定义编辑器，在编辑器激活时手动同步编辑状态到Grid API：

   // 自定义编辑器的afterGuiAttached方法中
   afterGuiAttached() {
     this.params.api.setEditingCells([{
       rowIndex: this.params.rowIndex,
       colKey: this.params.column.colId
     }]);
   }
   

临时兼容方案 #

由于editingCell属性在所有环境中均正常工作，可以封装一个兼容方法替代getEditingCells()，保证输出格式一致：

function getCurrentEditingCells(gridApi) {
  return gridApi.editingCell ? [gridApi.editingCell] : [];
}

内容的提问来源于stack exchange，提问作者sai shashank Rayaprolu