有没有办法使用Apps脚本检查Google Sheets中的筛选器视图是否隐藏了一行?

人气:568 发布:2022-10-16 标签: google-apps-script google-sheets google-sheets-api

问题描述

我的目标是确定行是否被筛选器视图隐藏。

据我所知和发布这个问题,目前有两种方法来检查行是否隐藏:isRowHiddenByFilter(rowPosition)isRowHiddenByUser(rowPosition)

isRowHiddenByFilter(rowPosition)无法工作,因为

返回给定行是否被筛选器(而非筛选器)隐藏 查看)。&q;--Method description in Google Apps Script Docs

有没有办法甚至是变通办法来实现我的目标?

推荐答案

我相信您的目标如下。

您希望使用Google Apps脚本通过筛选器视图检索隐藏的行号。

问题和解决方法:

遗憾的是,在当前阶段,还没有通过电子表格服务中的筛选器视图直接检索隐藏行和显示行的方法(SpreadsheetApp)。并且,不能将类工作表的";isRowHiddenByFilter";方法用于筛选器视图。

但幸运的是,当使用Sheets API时,可以检索和创建筛选器视图。在这个答案中,作为一种变通办法,我建议使用Sheets API来实现您的目标。此解决方法的流程如下。

检索要使用的筛选器视图(filterViews)的设置。 在这种情况下,可以使用";spadsheets.get";方法。 使用筛选器视图的检索设置为要使用的工作表创建新的基本筛选器。 在这种情况下,可以使用";spadsheets.BatchUpdate";方法。 在基本过滤的情况下,可以检索过滤后的行。此解决方法使用此情况。 检索工作表的rowMetadata的值。 在这种情况下,可以使用";spadsheets.get";方法。 值为rowMetadata时,筛选的行属性为"hiddenByFilter": true,。使用此选项,您可以检索隐藏行和/或显示行。 删除创建的基本筛选器。

重要信息:在此流程中,当在工作表中使用基本筛选器时,清除基本筛选器。请小心这个。测试此脚本时,请使用示例电子表格。

示例脚本:

在使用此脚本之前,please enable Sheets API at Advanced Google services。并且,请手动设置过滤器视图并设置过滤器视图名称。此脚本使用此筛选器视图。

function myFunction() {
  const spreadsheetId = "###"; // Please set the Spreadsheet ID.
  const sheetName = "Sheet1"; // Please set the sheet name.
  const filterViewName = "sampleFilter1"; // Please set the filter view name.

  // 1. Retrieve the settings of the filter view (`filterViews`) you want to use.
  const res1 = Sheets.Spreadsheets.get(spreadsheetId, { ranges: [sheetName] });
  const sheetId = res1.sheets[0].properties.sheetId;
  const filterViews = res1.sheets[0].filterViews.filter(
    (e) => e.title == filterViewName
  );
  if (filterViews.length == 0) {
    throw new Error("Filter view cannot be found.");
  }

  // 2. Create new basic filter to the sheet you want to use using the retrieved settings of the filter view.
  const obj = filterViews[0];
  obj.range.sheetId = sheetId;
  const reqs = [
    { clearBasicFilter: { sheetId: sheetId } },
    {
      setBasicFilter: {
        filter: {
          criteria: obj.criteria,
          filterSpecs: obj.filterSpecs,
          range: obj.range,
          sortSpecs: obj.sortSpecs,
        },
      },
    },
  ];
  Sheets.Spreadsheets.batchUpdate({ requests: reqs }, spreadsheetId);

  // 3. Retrieve the values of `rowMetadata` of the sheet.
  const res2 = Sheets.Spreadsheets.get(spreadsheetId, {
    ranges: [sheetName],
    fields: "sheets",
  });
  const values = res2.sheets[0].data[0].rowMetadata.reduce(
    (o, r, i) => {
      if (r.hiddenByFilter && r.hiddenByFilter === true) {
        o.hiddenRows.push(i + 1);
      } else {
        o.showingRows.push(i + 1);
      }
      return o;
    },
    { hiddenRows: [], showingRows: [] }
  );

  // 4. Delete the created basic filter.
  Sheets.Spreadsheets.batchUpdate(
    { requests: [{ clearBasicFilter: { sheetId: sheetId } }] },
    spreadsheetId
  );

  console.log(values);
}

结果

将上述脚本用于以下示例电子表格时,

未设置筛选器视图之前。

设置筛选器视图之后。

结果值

从上面的电子表格中,可以获得以下结果。

{
  "hiddenRows": [2, 3, 5, 6, 8, 9],
  "showingRows": [1, 4, 7, 10, 11, 12, 13, 14, 15]
}
hiddenRows是隐藏的行号。 showingRows是showingRow行号。

注意:

这是一个使用简单脚本的变通方法。因此,请根据您的实际情况修改以上脚本。

引用

Method: spreadsheets.get Method: spreadsheets.batchUpdate

259