排查获取Excel工作簿所有数据透视表数据源字符串的代码问题

存在的问题 #

• 错误加载方法作为属性：getDataSourceString是PivotTable的方法，不是属性，不能用load("getDataSourceString")来加载。load()方法仅用于加载对象的属性（如name、worksheet），方法无需提前加载。
• 透视表集合访问方式错误：wb.pivotTables是PivotTableCollection对象，需要通过items属性访问具体的透视表实例，而非直接用pts[i]。
• 冗余的getCount()调用：加载items属性后，直接通过pts.items.length就能获取透视表数量，无需额外调用getCount()，减少不必要的同步操作。
• 方法调用未正确处理异步结果：getDataSourceString()返回的是OfficeExtension.ClientResult<string>，需要通过context.sync()同步后才能读取其value属性，直接调用无法获取实际字符串。

修正后的代码 #

async function SearchInPivots(context, wb: Excel.Workbook) {
  let foundPivots = new foundCollection();
  // 加载透视表集合的items属性
  const pts = wb.pivotTables.load("items");
  await context.sync();

  const ptColl = [];
  // 遍历items数组获取每个透视表，加载必要属性（比如name用于标识）
  for (const pivotTable of pts.items) {
    // 加载透视表的name属性（可选，用于日志区分）
    const pt = pivotTable.load("name");
    ptColl.push(pt);
  }
  await context.sync();

  // 遍历获取每个透视表的数据源字符串
  for (const pt of ptColl) {
    // 调用getDataSourceString并获取结果
    const dataSourceResult = pt.getDataSourceString();
    await context.sync();
    console.log(`透视表 ${pt.name} 的数据源: ${dataSourceResult.value}`);
  }

  return foundPivots;
}

更优化的写法（减少同步次数） #

可以批量获取所有透视表的数据源结果，减少context.sync()的调用次数，提升性能：

async function SearchInPivots(context, wb: Excel.Workbook) {
  let foundPivots = new foundCollection();
  const pts = wb.pivotTables.load("items");
  await context.sync();

  // 收集所有数据源请求
  const dataSourceResults = [];
  const pivotNames = [];
  for (const pt of pts.items) {
    pivotNames.push(pt.name);
    dataSourceResults.push(pt.getDataSourceString());
  }
  // 一次同步获取所有结果
  await context.sync();

  // 输出结果
  dataSourceResults.forEach((result, index) => {
    console.log(`透视表 ${pivotNames[index]} 的数据源: ${result.value}`);
  });

  return foundPivots;
}

内容的提问来源于stack exchange，提问作者jkpieterse