Class FilterCriteriaBuilder

过滤条件构建器

如需向过滤条件添加条件，您必须执行以下操作：

  1. 使用 SpreadsheetApp.newFilterCriteria() 创建条件构建器。
  2. 使用此类中的方法向构建器添加设置。
  3. 使用 build() 将条件与您指定的设置组合起来。

常见用途

隐藏工作表中的值

以下示例会获取工作表的现有过滤条件，并添加用于隐藏包含“hello”或“world”的 C 列中的单元格的条件。此示例中的条件只能用于 Grid 工作表（默认的工作表类型）上的过滤条件。 
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setHiddenValues(['hello', 'world'])
                     .build();
filter.setColumnFilterCriteria(3, criteria);

仅显示非空单元格

以下示例向 DataSource 工作表（已连接到数据库）添加了过滤条件，过滤条件仅显示“类别”列中不为空的单元格。 
// Gets the sheet named "Connected sheet," which is connected to a database.
const sheet = SpreadsheetApp.getActiveSpreadsheet()
                  .getSheetByName('Connected sheet')
                  .asDataSourceSheet();
// Creates criteria that only shows non-empty cells.
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
// Applies the criteria to the column named "Category."
sheet.addFilter('Category', criteria);

方法

方法返回类型简介
build()FilterCriteria使用您添加到条件构建器中的设置组装过滤条件。
copy()FilterCriteriaBuilder复制此过滤条件，并创建一个可应用于其他过滤条件的条件构建器。
getCriteriaType()BooleanCriteria返回条件的布尔值类型，例如 CELL_EMPTY。
getCriteriaValues()Object[]返回布尔条件的参数数组。
getHiddenValues()String[]返回过滤器隐藏的值。
getVisibleBackgroundColor()Color返回用作过滤条件的背景颜色。
getVisibleForegroundColor()Color返回用作过滤条件的前景颜色。
getVisibleValues()String[]返回数据透视表过滤条件显示的值。
setHiddenValues(values)FilterCriteriaBuilder设置要隐藏的值。
setVisibleBackgroundColor(visibleBackgroundColor)FilterCriteriaBuilder设置用作过滤条件的背景颜色。
setVisibleForegroundColor(visibleForegroundColor)FilterCriteriaBuilder设置用作过滤条件的前景颜色。
setVisibleValues(values)FilterCriteriaBuilder设置要在数据透视表中显示的值。
whenCellEmpty()FilterCriteriaBuilder设置过滤条件以显示空白单元格。
whenCellNotEmpty()FilterCriteriaBuilder设置过滤条件以显示非空单元格。
whenDateAfter(date)FilterCriteriaBuilder设置过滤条件，以显示日期晚于指定日期的单元格。
whenDateAfter(date)FilterCriteriaBuilder设置过滤条件，以显示日期晚于指定相对日期的单元格。
whenDateBefore(date)FilterCriteriaBuilder设置过滤条件，以显示日期早于指定日期的单元格。
whenDateBefore(date)FilterCriteriaBuilder设置过滤条件，以显示日期早于指定相对日期的单元格。
whenDateEqualTo(date)FilterCriteriaBuilder设置过滤条件，以显示日期等于指定日期的单元格。
whenDateEqualTo(date)FilterCriteriaBuilder设置过滤条件，以显示日期等于指定相对日期的单元格。
whenDateEqualToAny(dates)FilterCriteriaBuilder设置过滤条件，以显示日期等于任何指定日期的单元格。
whenDateNotEqualTo(date)FilterCriteriaBuilder设置过滤条件，以显示不等于指定日期的单元格。
whenDateNotEqualToAny(dates)FilterCriteriaBuilder设置过滤条件，以显示日期不等于任何指定日期的单元格。
whenFormulaSatisfied(formula)FilterCriteriaBuilder设置过滤条件，以显示计算结果为 true 的指定公式（例如 =B:B<C:C）对应的单元格。
whenNumberBetween(start, end)FilterCriteriaBuilder设置过滤条件，以显示数字介于 2 个指定数字之间或等于其中一个数字的单元格。
whenNumberEqualTo(number)FilterCriteriaBuilder设置过滤条件，以显示数值等于指定数值的单元格。
whenNumberEqualToAny(numbers)FilterCriteriaBuilder设置过滤条件，以显示数字等于任何指定数字的单元格。
whenNumberGreaterThan(number)FilterCriteriaBuilder设置过滤条件，以显示数值大于指定数值的单元格
whenNumberGreaterThanOrEqualTo(number)FilterCriteriaBuilder设置过滤条件，以显示数值大于或等于指定数值的单元格。
whenNumberLessThan(number)FilterCriteriaBuilder设置过滤条件，以显示数字小于指定数字的单元格。
whenNumberLessThanOrEqualTo(number)FilterCriteriaBuilder设置过滤条件，以显示数值小于或等于指定数值的单元格。
whenNumberNotBetween(start, end)FilterCriteriaBuilder设置过滤条件，以显示数字不在 2 个指定数字之间，也不等于这 2 个数字的单元格。
whenNumberNotEqualTo(number)FilterCriteriaBuilder设置过滤条件，以显示数字不等于指定数字的单元格。
whenNumberNotEqualToAny(numbers)FilterCriteriaBuilder设置过滤条件，以显示数字不等于任何指定数字的单元格。
whenTextContains(text)FilterCriteriaBuilder设置过滤条件，以显示包含指定文本的文本单元格。
whenTextDoesNotContain(text)FilterCriteriaBuilder设置过滤条件，以显示文本不含指定文本的单元格。
whenTextEndsWith(text)FilterCriteriaBuilder设置过滤条件，以显示文本以指定文本结尾的单元格。
whenTextEqualTo(text)FilterCriteriaBuilder设置过滤条件，以显示文本等于指定文本的单元格。
whenTextEqualToAny(texts)FilterCriteriaBuilder设置过滤条件，以显示文本等于任何指定文本值的单元格。
whenTextNotEqualTo(text)FilterCriteriaBuilder设置过滤条件，以显示文本不等于指定文本的单元格。
whenTextNotEqualToAny(texts)FilterCriteriaBuilder设置过滤条件，以显示文本不等于任何指定值的单元格。
whenTextStartsWith(text)FilterCriteriaBuilder设置过滤条件，以显示文本以指定文本开头的单元格。
withCriteria(criteria, args)FilterCriteriaBuilder将过滤条件设置为由 BooleanCriteria 值（例如 CELL_EMPTY 或 NUMBER_GREATER_THAN）定义的布尔值条件。

详细文档

build()

使用您添加到条件构建器中的设置组装过滤条件。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
const criteria = SpreadsheetApp
                     .newFilterCriteria()  // Creates a criteria builder.
                     .whenCellNotEmpty()   // Adds settings to the builder.
                     .build();             // Assembles the criteria.
filter.setColumnFilterCriteria(2, criteria);

返回

FilterCriteria - 过滤条件的表示法。

copy()

复制此过滤条件，并创建一个可应用于其他过滤条件的条件构建器。

您可以将此方法与任何类型的过滤器搭配使用。如果您使用的是工作表过滤条件，则可以将条件复制到另一个列。 

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
const criteria = filter.getColumnFilterCriteria(3).copy().build();
// Applies the copied criteria to column B. The copied criteria overwrites any
// existing criteria on column B.
filter.setColumnFilterCriteria(2, criteria);

返回

FilterCriteriaBuilder - 根据此过滤条件构建过滤条件。

getCriteriaType()

返回条件的布尔值类型，例如 CELL_EMPTY。如需了解布尔值条件的类型，请参阅 BooleanCriteria 枚举。

用户通常使用此方法向过滤条件添加布尔值条件，而不会替换现有条件。

您可以对任何类型的过滤器使用此方法。如果过滤条件不是布尔值条件，则返回 null。 

const ss = SpreadsheetApp.getActiveSheet();
// Gets the filter on the active sheet.
const filter = ss.getFilter();
// Gets the criteria type and returns a string representing the criteria type
// object.
const criteriaType =
    filter.getColumnFilterCriteria(2).getCriteriaType().toString();
// Logs the criteria type.
console.log(criteriaType);

返回

BooleanCriteria - 布尔条件的类型，如果条件不是布尔条件，则为 null。

getCriteriaValues()

返回布尔条件的参数数组。某些布尔条件类型没有参数，并返回空数组，例如 CELL_NOT_EMPTY。

用户通常使用此方法向过滤条件添加布尔值条件，而不会替换现有条件。

  • 如需获取布尔值条件类型，请使用 getCriteriaType()。
  • 如需使用条件类型和条件值创建或修改过滤条件，请参阅 withCriteria(criteria, args)。

    您可以对任何类型的过滤器使用此方法。 

    const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Gets the values of the boolean criteria and logs them. For example, if the
// boolean condition is whenNumberGreaterThan(10), then the logged value is 10.
const criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues();
console.log(criteriaValues);

    返回

    Object[] - 与布尔值条件类型相适应的参数数组。参数的数量及其类型与 FilterCriteriaBuilder 类的对应 when...() 方法匹配。

getHiddenValues()

返回过滤器隐藏的值。

将此条件与 Grid 工作表（默认工作表类型）上的过滤条件搭配使用。 如果您针对其他类型的过滤器调用此方法，则会返回 null。 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

返回

String[] - 过滤器隐藏的值数组。

getVisibleBackgroundColor()

返回用作过滤条件的背景颜色。采用此背景颜色的单元格会保持可见状态。

将此条件与 Grid 工作表（默认工作表类型）上的过滤条件搭配使用。 如果您针对其他类型的过滤器调用此方法，则会返回 null。 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the background color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleBackgroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

返回

Color - 用作过滤条件的背景颜色。

getVisibleForegroundColor()

返回用作过滤条件的前景颜色。采用此前景颜色的单元格将保持可见状态。

将此条件与 Grid 工作表（默认工作表类型）上的过滤条件搭配使用。 如果您针对其他类型的过滤器调用此方法，则会返回 null。 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the foreground color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleForegroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

返回

Color - 用作过滤条件的前景颜色。

getVisibleValues()

返回数据透视表过滤条件显示的值。

此条件仅适用于未与数据库关联的数据透视表的过滤条件。对于其他类型的过滤条件，返回空数组。 

const ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet, then gets the visible values of its
// first filter.
const pivotTable = ss.getPivotTables()[0];
const pivotFilterValues =
    pivotTable.getFilters()[0].getFilterCriteria().getVisibleValues();
// Logs the visible values.
console.log(pivotFilterValues);

返回

String[] - 数据透视表过滤条件显示的值数组。

setHiddenValues(values)

设置要隐藏的值。清除所有现有的可见或隐藏值。

您只能对 Grid 工作表（默认的工作表类型）使用此过滤条件。 

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Sets the values to hide and applies the criteria to column C.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setHiddenValues(['Hello', 'World'])
                     .build();
filter.setColumnFilterCriteria(3, criteria);

参数

名称类型说明
valuesString[]要隐藏的值的列表。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

抛出

Error - 如果任何值为 null。

setVisibleBackgroundColor(visibleBackgroundColor)

设置用作过滤条件的背景颜色。采用此背景颜色的单元格会保持可见状态。设置背景颜色过滤条件后，此构建器中的所有当前颜色过滤条件都会被移除。

您只能对 Grid 工作表（默认的工作表类型）使用此过滤条件。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that filters by background color and sets it to column B.
const color = SpreadsheetApp.newColor().setRgbColor('#185ABC').build();
const criteria =
    SpreadsheetApp.newFilterCriteria().setVisibleBackgroundColor(color).build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
visibleBackgroundColorColor要设置的背景颜色。颜色必须是 RGB 格式的颜色。此方法不支持主题颜色。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

setVisibleForegroundColor(visibleForegroundColor)

设置用作过滤条件的前景颜色。采用此前景颜色的单元格将保持可见状态。设置前景颜色过滤条件后，此构建器中的所有当前颜色过滤条件都会被移除。

您只能对 Grid 工作表（默认的工作表类型）使用此过滤条件。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that filters by foreground color and sets it to column B.
const color = SpreadsheetApp.newColor().setRgbColor('#185ABC').build();
const criteria =
    SpreadsheetApp.newFilterCriteria().setVisibleForegroundColor(color).build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
visibleForegroundColorColor要设置的前景颜色。颜色必须是 RGB 格式的颜色。此方法不支持主题颜色。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

setVisibleValues(values)

设置要在数据透视表中显示的值。清除所有现有的可见或隐藏值。

您只能对未连接到数据库的数据透视表使用此过滤条件。 

// Gets the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet and adds a filter to it that
// sets the visible values to "Northeast" and "Southwest."
const pivotTable = ss.getPivotTables()[0];
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setVisibleValues(['Northeast', 'Southwest'])
                     .build();
pivotTable.addFilter(2, criteria);

参数

名称类型说明
valuesString[]要显示的值列表。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

抛出

Error - 如果任何值为 null。

whenCellEmpty()

设置过滤条件以显示空白单元格。

您可以将此条件与任何类型的过滤条件搭配使用。 

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Sets criteria to column B that only shows empty cells.
const criteria = SpreadsheetApp.newFilterCriteria().whenCellEmpty().build();
filter.setColumnFilterCriteria(2, criteria);

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenCellNotEmpty()

设置过滤条件以显示非空单元格。

您可以将此条件与任何类型的过滤条件搭配使用。 

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Sets criteria to column B that only shows cells that aren't empty.
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
filter.setColumnFilterCriteria(2, criteria);

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenDateAfter(date)

设置过滤条件，以显示日期晚于指定日期的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为日期。如果数据未连接到数据库，您用于过滤的列的数据类型不必为日期，但如果不是，您可能会得到意外的结果。 

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates after June 1, 2022
// and sets it to column A.
const date = new Date('June 1, 2022');
const criteria = SpreadsheetApp.newFilterCriteria().whenDateAfter(date).build();
filter.setColumnFilterCriteria(1, criteria);

参数

名称类型说明
dateDate要隐藏的最新日期。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenDateAfter(date)

设置过滤条件，以显示日期晚于指定相对日期的单元格。如需查看相对日期选项，请参阅枚举 RelativeDate。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为日期。如果数据未连接到数据库，您用于过滤的列的数据类型不必为日期，但如果不是，您可能会得到意外的结果。 

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates after today's date
// and sets it to column A.

const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateAfter(SpreadsheetApp.RelativeDate.TODAY)
                     .build();
filter.setColumnFilterCriteria(1, criteria);

参数

名称类型说明
dateRelativeDate最新的相对日期。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenDateBefore(date)

设置过滤条件，以显示日期早于指定日期的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为日期。如果数据未连接到数据库，您用于过滤的列的数据类型不必为日期，但如果不是，您可能会得到意外的结果。 

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates before June 1, 2022
// and sets it to column A.
const date = new Date('June 1, 2022');
const criteria =
    SpreadsheetApp.newFilterCriteria().whenDateBefore(date).build();
filter.setColumnFilterCriteria(1, criteria);

参数

名称类型说明
dateDate要隐藏的最早日期。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenDateBefore(date)

设置过滤条件，以显示日期早于指定相对日期的单元格。如需查看相对日期选项，请参阅枚举 RelativeDate。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为日期。如果数据未连接到数据库，您用于过滤的列的数据类型不必为日期，但如果不是，您可能会得到意外的结果。 

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates before today's date
// and sets it to column A.

const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateBefore(SpreadsheetApp.RelativeDate.TODAY)
                     .build();
filter.setColumnFilterCriteria(1, criteria);

参数

名称类型说明
dateRelativeDate要隐藏的最早相对日期。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenDateEqualTo(date)

设置过滤条件，以显示日期等于指定日期的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为日期。如果数据未连接到数据库，您用于过滤的列的数据类型不必为日期，但如果不是，您可能会得到意外的结果。 

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates equal to June 1, 2022
// and sets it to column A.
const date = new Date('June 1, 2022');
const criteria =
    SpreadsheetApp.newFilterCriteria().whenDateEqualTo(date).build();
filter.setColumnFilterCriteria(1, criteria);

参数

名称类型说明
dateDate单元格值必须与之匹配的日期。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenDateEqualTo(date)

设置过滤条件，以显示日期等于指定相对日期的单元格。如需查看相对日期选项，请参阅枚举 RelativeDate。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为日期。如果数据未连接到数据库，您用于过滤的列的数据类型不必为日期，但如果不是，您可能会得到意外的结果。 

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates that fall within the past
// month and sets it to column A.

const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateEqualTo(SpreadsheetApp.RelativeDate.PAST_MONTH)
                     .build();
filter.setColumnFilterCriteria(1, criteria);

参数

名称类型说明
dateRelativeDate单元格值必须与之匹配的相对日期。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenDateEqualToAny(dates)

设置过滤条件，以显示日期等于任何指定日期的单元格。

您只能对与数据库关联的数据使用此条件。例如，您可以将此条件与 DataSource 工作表、连接到数据库的工作表或 DataSourcePivotTable（基于 DataSource 工作表创建的数据透视表）上的过滤条件搭配使用。 

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that shows cells with any of the below
// dates.
const date1 = new Date('June 1, 2022');
const date2 = new Date('June 2, 2022');
const date3 = new Date('June 3, 2022');
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateEqualToAny([date1, date2, date3])
                     .build();
dataSheet.addFilter('date', criteria);

参数

名称类型说明
datesDate[]要显示的日期。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenDateNotEqualTo(date)

设置过滤条件，以显示不等于指定日期的单元格。

您只能对与数据库关联的数据使用此条件。例如，您可以将此条件与 DataSource 工作表、连接到数据库的工作表或 DataSourcePivotTable（基于 DataSource 工作表创建的数据透视表）上的过滤条件搭配使用。

您要按其过滤的列的数据类型必须为日期。 

// Gets a pivot table that's connected to a database.
const ss =
    SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Pivot Table Sheet');
const dataPivotTable = ss.getDataSourcePivotTables()[0];
// Creates criteria that only shows cells that don't equal June 16, 2022
// and sets it to the "date" column.
const date = new Date('June 16, 2022');
const criteria =
    SpreadsheetApp.newFilterCriteria().whenDateNotEqualTo(date).build();
dataPivotTable.addFilter('date', criteria);

参数

名称类型说明
dateDate要隐藏的日期。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenDateNotEqualToAny(dates)

设置过滤条件，以显示日期不等于任何指定日期的单元格。

您只能对与数据库关联的数据使用此条件。例如，您可以将此条件与 DataSource 工作表、连接到数据库的工作表或 DataSourcePivotTable（基于 DataSource 工作表创建的数据透视表）上的过滤条件搭配使用。 

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that hides cells with any of the below
// dates.
const date1 = new Date('June 1, 2022');
const date2 = new Date('June 2, 2022');
const date3 = new Date('June 3, 2022');
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateNotEqualToAny([date1, date2, date3])
                     .build();
dataSheet.addFilter('date', criteria);

参数

名称类型说明
datesDate[]要隐藏的日期。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenFormulaSatisfied(formula)

设置过滤条件，以显示计算结果为 true 的指定公式（例如 =B:B<C:C）对应的单元格。

您只能使用此条件过滤未与数据库关联的数据。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows the rows where the value in column B is less than
// the value in column C and sets it to column A.
const formula = '=B:B<C:C';
const criteria =
    SpreadsheetApp.newFilterCriteria().whenFormulaSatisfied(formula).build();
filter.setColumnFilterCriteria(1, criteria);

参数

名称类型说明
formulaString一个自定义公式，如果输入有效，则计算结果为 true。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberBetween(start, end)

设置过滤条件，以显示数字介于 2 个指定数字之间或等于其中一个数字的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为数字。如果数据未连接到数据库，则您要按其过滤的列的数据类型不必为数字，但如果不是，您可能会得到意外结果。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that only shows cells with numbers that fall between 1-25,
// inclusively, and sets it to column A.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberBetween(1, 25).build();
filter.setColumnFilterCriteria(1, criteria);

参数

名称类型说明
startNumber要显示的最低数字。
endNumber要显示的最高数字。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberEqualTo(number)

设置过滤条件，以显示数值等于指定数值的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为数字。如果数据未连接到数据库，则您要按其过滤的列的数据类型不必为数字，但如果不是，您可能会得到意外结果。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that only shows cells that are equal to 25 and sets it to
// column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberEqualTo(25).build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
numberNumber要显示的号码。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberEqualToAny(numbers)

设置过滤条件，以显示数字等于任何指定数字的单元格。

您只能对与数据库关联的数据使用此条件。例如，您可以将此条件与 DataSource 工作表、连接到数据库的工作表或 DataSourcePivotTable（基于 DataSource 工作表创建的数据透视表）上的过滤条件搭配使用。 

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that only shows cells with the number
// 10, 20, or 30.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenNumberEqualToAny([10, 20, 30])
                     .build();
dataSheet.addFilter('amount', criteria);

参数

名称类型说明
numbersNumber[]要显示的数字。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberGreaterThan(number)

设置过滤条件，以显示数值大于指定数值的单元格

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为数字。如果数据未连接到数据库，则您要按其过滤的列的数据类型不必为数字，但如果不是，您可能会得到意外结果。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells greater than 10 and sets it to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberGreaterThan(10).build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
numberNumber要隐藏的最高编号。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberGreaterThanOrEqualTo(number)

设置过滤条件，以显示数值大于或等于指定数值的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为数字。如果数据未连接到数据库，则您要按其过滤的列的数据类型不必为数字，但如果不是，您可能会得到意外结果。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells greater than or equal to 10 and sets it to
// column B.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenNumberGreaterThanOrEqualTo(10)
                     .build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
numberNumber要显示的最低数字。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberLessThan(number)

设置过滤条件，以显示数字小于指定数字的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为数字。如果数据未连接到数据库，则您要按其过滤的列的数据类型不必为数字，但如果不是，您可能会得到意外结果。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells less than 10 and sets it to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberLessThan(10).build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
numberNumber要隐藏的最低编号。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberLessThanOrEqualTo(number)

设置过滤条件，以显示数值小于或等于指定数值的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为数字。如果数据未连接到数据库，则您要按其过滤的列的数据类型不必为数字，但如果不是，您可能会得到意外结果。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells less than or equal to 10 and sets it to
// column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberLessThanOrEqualTo(10).build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
numberNumber要显示的最高数字。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberNotBetween(start, end)

设置过滤条件，以显示数字不在 2 个指定数字之间，也不等于这 2 个数字的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为数字。如果数据未连接到数据库，则您要按其过滤的列的数据类型不必为数字，但如果不是，您可能会得到意外结果。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that hides cells with numbers that fall between 1-25,
// inclusively, and sets it to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberNotBetween(1, 25).build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
startNumber最低的数字会隐藏。
endNumber要隐藏的最高编号。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberNotEqualTo(number)

设置过滤条件，以显示数字不等于指定数字的单元格。

您可以将此条件与任何类型的过滤条件搭配使用。如果您将此条件与连接到数据库的数据搭配使用，则您要按条件过滤的列的数据类型必须为数字。如果数据未连接到数据库，则您要按其过滤的列的数据类型不必为数字，但如果不是，您可能会得到意外结果。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that hides cells that are equal to 25 and sets it to column
// B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberNotEqualTo(25).build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
numberNumber要隐藏的号码。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenNumberNotEqualToAny(numbers)

设置过滤条件，以显示数字不等于任何指定数字的单元格。

您只能对与数据库关联的数据使用此条件。例如，您可以将此条件与 DataSource 工作表、连接到数据库的工作表或 DataSourcePivotTable（基于 DataSource 工作表创建的数据透视表）上的过滤条件搭配使用。 

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that hides cells with the number 10, 20,
// or 30.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenNumberNotEqualToAny([10, 20, 30])
                     .build();
dataSheet.addFilter('amount', criteria);

参数

名称类型说明
numbersNumber[]要隐藏的数字。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenTextContains(text)

设置过滤条件，以显示包含指定文本的文本单元格。文本不区分大小写。

您可以将此条件与任何类型的过滤条件搭配使用。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells that contain "Northwest" and sets it to
// column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextContains('Northwest').build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
textString单元格必须包含的文本。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenTextDoesNotContain(text)

设置过滤条件，以显示文本不包含指定文本的单元格。文本不区分大小写。

您可以将此条件与任何类型的过滤条件搭配使用。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that hides cells that contain "Northwest" and sets it to
// column B.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenTextDoesNotContain('Northwest')
                     .build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
textString单元格不得包含的文本。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenTextEndsWith(text)

设置过滤条件，以显示以指定文本结尾的文本所对应的单元格。文本不区分大小写。

您可以将此条件与任何类型的过滤条件搭配使用。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells with text that ends with "est" and sets it
// to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextEndsWith('est').build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
textString单元格文本末尾必须包含的文本。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenTextEqualTo(text)

设置过滤条件，以显示文本等于指定文本的单元格。文本不区分大小写。

您可以将此条件与任何类型的过滤条件搭配使用。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells with text that equals "hello" and sets it
// to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextEqualTo('hello').build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
textString单元格的文本必须等于的文本。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenTextEqualToAny(texts)

设置过滤条件，以显示文本等于任何指定文本值的单元格。文本不区分大小写。

您只能对与数据库关联的数据使用此条件。例如，您可以将此条件与 DataSource 工作表、连接到数据库的工作表或 DataSourcePivotTable（基于 DataSource 工作表创建的数据透视表）上的过滤条件搭配使用。 

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that shows cells with the text "tech"
// or "business."
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenTextEqualToAny(['tech', 'business'])
                     .build();
dataSheet.addFilter('category', criteria);

参数

名称类型说明
textsString[]单元格必须等于的文本值。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenTextNotEqualTo(text)

设置过滤条件，以显示文本不等于指定文本的单元格。文本不区分大小写。

您只能对与数据库关联的数据使用此条件。例如，您可以将此条件与 DataSource 工作表、连接到数据库的工作表或 DataSourcePivotTable（基于 DataSource 工作表创建的数据透视表）上的过滤条件搭配使用。 

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with text equal to
// "tech."
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextNotEqualTo('tech').build();
dataSheet.addFilter('category', criteria);

参数

名称类型说明
textString单元格的文本不得等于的文字。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenTextNotEqualToAny(texts)

设置过滤条件，以显示文本不等于任何指定值的单元格。文本不区分大小写。

您只能对与数据库关联的数据使用此条件。例如，您可以将此条件与 DataSource 工作表、连接到数据库的工作表或 DataSourcePivotTable（基于 DataSource 工作表创建的数据透视表）上的过滤条件搭配使用。 

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with the text "tech"
// or "business."
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenTextNotEqualToAny(['tech', 'business'])
                     .build();
dataSheet.addFilter('category', criteria);

参数

名称类型说明
textsString[]单元格不能等于的文本值。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

whenTextStartsWith(text)

设置过滤条件，以显示文本以指定文本开头的单元格。文本不区分大小写。

您可以将此条件与任何类型的过滤条件搭配使用。 

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells with text that starts with "pre" and sets
// it to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextStartsWith('pre').build();
filter.setColumnFilterCriteria(2, criteria);

参数

名称类型说明
textString单元格文本开头必须包含的文本。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。

withCriteria(criteria, args)

将过滤条件设置为由 BooleanCriteria 值（例如 CELL_EMPTY 或 NUMBER_GREATER_THAN）定义的布尔条件。如需从现有条件复制布尔值条件，请对现有条件使用 getCriteriaType() 和 getCriteriaValues() 定义此方法的参数。

您可以将此条件与任何类型的过滤条件搭配使用，但某些 BooleanCriteria 不适用于所有过滤条件。 

// Builds a filter criteria that is based on existing boolean conditions from
// another criteria. Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Gets the existing boolean conditions applied to Column B and adds criteria to
// column C that has the same boolean conditions and additional criteria that
// hides the value, "Northwest."
const filterCriteria = filter.getColumnFilterCriteria(2);
const criteria = SpreadsheetApp.newFilterCriteria()
                     .withCriteria(
                         filterCriteria.getCriteriaType(),
                         filterCriteria.getCriteriaValues(),
                         )
                     .setHiddenValues(['Northwest'])
                     .build();
filter.setColumnFilterCriteria(3, criteria);

参数

名称类型说明
criteriaBooleanCriteria布尔值条件的类型。
argsObject[]与条件类型相适应的参数数组；参数数量和类型与上述相应的 when...() 方法一致。

返回

FilterCriteriaBuilder - 此构建器，用于链式调用。