Class FilterCriteria

篩選條件

使用這個類別可取得現有篩選器的條件資訊，或複製這些條件。

常見的使用方式

複製條件

下列範例會取得套用至 A1:C20 範圍的篩選器，取得套用至 C 欄的條件，並將條件複製到 B 欄。
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Copies the filter criteria applied to column C.
const filter = range.getFilter();
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);

取得篩選器隱藏的值

以下範例會取得套用至指定範圍的篩選器，並記錄篩選器隱藏的 B 欄值。
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);

方法

方法傳回類型簡短說明
copy()FilterCriteriaBuilder複製這個篩選條件，並建立可套用至其他篩選器的條件建構工具。
getCriteriaType()BooleanCriteria|null傳回條件的布林值類型，例如 CELL_EMPTY。
getCriteriaValues()Object[]傳回布林條件的引數陣列。
getHiddenValues()String[]傳回篩選器隱藏的值。
getVisibleBackgroundColor()Color|null傳回用做篩選條件的背景顏色。
getVisibleForegroundColor()Color|null傳回做為篩選條件的前景色。
getVisibleValues()String[]傳回資料透視表篩選器顯示的值。

內容詳盡的說明文件

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：布林條件類型，或 null (如果條件不是布林條件)。

getCriteriaValues()

傳回布林條件的引數陣列。部分布林值條件類型沒有引數，且會傳回空白陣列，例如 CELL_NOT_EMPTY。

使用者通常會採用這種方法，在篩選器中新增布林條件，而不取代現有條件。

  • 如要取得布林條件類型，請使用 getCriteriaType()。
  • 如要使用條件類型和條件值建立或修改篩選條件，請參閱FilterCriteriaBuilder.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|null：用做篩選條件的背景顏色。

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|null：做為篩選條件的前景色。

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[]：資料透視表篩選器顯示的值陣列。