如要在篩選器中加入條件，您必須執行下列操作：
- 使用
SpreadsheetApp.newFilterCriteria()建立條件建構工具。 - 使用這個類別的方法，將設定新增至建構工具。
- 使用
build()以指定的設定組合條件。
常見的應用方式
隱藏工作表中的值
以下範例會取得工作表現有的篩選器，並新增條件來隱藏 C 欄中包含「hello」或「world」的儲存格。此範例中的條件只能與Grid 工作表 (預設工作表類型) 中的篩選器搭配使用。
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
let criteria = SpreadsheetApp.newFilterCriteria()
.setHiddenValues(["hello", "world"])
.build();
filter.setColumnFilterCriteria(3, criteria);
只顯示非空白儲存格
以下範例會在DataSource 工作表 (連結至資料庫的工作表) 中新增篩選器，並設定只顯示「Category」欄中的儲存格非空白的儲存格。// Gets the sheet named "Connected sheet," which is connected to a database.
let sheet = SpreadsheetApp.getActiveSpreadsheet()
.getSheetByName("Connected sheet")
.asDataSourceSheet();
// Creates criteria that only shows non-empty cells.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenCellNotEmpty()
.build();
// Applies the criteria to the column named "Category."
sheet.addFilter("Category", criteria);
方法
內容詳盡的說明文件
build()
運用您新增至條件建構工具的設定，組合篩選條件。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
let criteria = SpreadsheetApp.newFilterCriteria() // Creates a criteria builder.
.whenCellNotEmpty() // Adds settings to the builder.
.build(); // Assembles the criteria.
filter.setColumnFilterCriteria(2, criteria);
回攻員
FilterCriteria：代表篩選條件。
copy()
複製這個篩選條件，並建立可以套用到另一個篩選器的條件建構工具。
這個方法可搭配任何類型的篩選器使用。如果您使用工作表篩選器，可以將條件複製到其他資料欄。
let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); // Makes a copy of the filter criteria applied to column C. let 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 列舉。
使用者通常使用這個方法在篩選器中加入布林條件條件，而不取代現有條件。
- 如要取得條件的引數，請使用
getCriteriaValues()。 - 如要使用條件類型和條件值建立或修改篩選條件，請參閱
withCriteria(criteria, args)。
此方法適用於任何類型的篩選器。如果篩選條件並非布林值條件，就會傳回 null。
let ss = SpreadsheetApp.getActiveSheet();
// Gets the filter on the active sheet.
let filter = ss.getFilter();
// Gets the criteria type and returns a string representing the criteria type object.
let criteriaType = filter.getColumnFilterCriteria(2)
.getCriteriaType()
.toString();
// Logs the criteria type.
console.log(criteriaType);
回攻員
BooleanCriteria：布林值條件的類型；如果條件不是布林條件，則顯示 null。
getCriteriaValues()
傳回布林條件的引數陣列。部分佈林條件類型沒有引數，且會傳回空白陣列，例如 CELL_NOT_EMPTY。
使用者通常使用這個方法在篩選器中加入布林條件條件，而不取代現有條件。
- 如要取得布林值條件類型，請使用
getCriteriaType()。 - 如要使用條件類型和條件值建立或修改篩選條件，請參閱
withCriteria(criteria, args)。這個方法可用於任何類型的篩選器。
let ss = SpreadsheetApp.getActiveSheet(); let 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. let criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues(); console.log(criteriaValues);
回攻員
Object[]：適用於布林值條件類型的引數陣列。引數數量及其類型與FilterCriteriaBuilder類別對應的when...()方法相符。
getHiddenValues()
傳回篩選器隱藏的值。
您可以利用這項條件與 Grid 工作表 (預設工作表類型) 的篩選器搭配使用。
如果您針對其他類型的篩選器呼叫此方法，系統會傳回 null。
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);
回攻員
String[]：篩選器隱藏的值陣列。
getVisibleBackgroundColor()
傳回做為篩選條件使用的背景顏色。具有這種背景顏色的儲存格會保持顯示狀態。
您可以利用這項條件與 Grid 工作表 (預設工作表類型) 的篩選器搭配使用。
如果您針對其他類型的篩選器呼叫此方法，系統會傳回 null。
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Logs the background color that column B is filtered by as a hexadecimal string.
let filter = range.getFilter();
let color = filter.getColumnFilterCriteria(2)
.getVisibleBackgroundColor()
.asRgbColor()
.asHexString();
console.log(color);
回攻員
Color：做為篩選條件使用的背景顏色。
getVisibleForegroundColor()
傳回用做篩選條件的前景顏色。具有此前景顏色的儲存格會保持顯示。
您可以利用這項條件與 Grid 工作表 (預設工作表類型) 的篩選器搭配使用。
如果您針對其他類型的篩選器呼叫此方法，系統會傳回 null。
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Logs the foreground color that column B is filtered by as a hexadecimal string.
let filter = range.getFilter();
let color = filter.getColumnFilterCriteria(2)
.getVisibleForegroundColor()
.asRgbColor()
.asHexString();
console.log(color);
回攻員
Color：用做篩選條件的前景顏色。
getVisibleValues()
傳回資料透視表篩選器顯示的值。
這項條件僅適用於篩選未連結至資料庫的資料透視表。 針對其他類型的篩選器傳回空白陣列。
let ss = SpreadsheetApp.getActiveSheet(); // Gets the first pivot table on the sheet, then gets the visible values of its first filter. pivotTable = ss.getPivotTables()[0]; 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();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Sets the values to hide and applies the criteria to column C.
let criteria = SpreadsheetApp.newFilterCriteria()
.setHiddenValues(["Hello", "World"])
.build();
filter.setColumnFilterCriteria(3, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
values | String[] | 要隱藏的值清單。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
setVisibleBackgroundColor(visibleBackgroundColor)
設定做為篩選條件的背景顏色。具有這種背景顏色的儲存格會保持顯示狀態。設定背景顏色篩選條件，會從這個建構工具移除目前所有的顏色篩選條件。
這項條件只能用於 Grid 工作表 (預設工作表類型) 的篩選器。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that filters by background color and sets it to column B.
let color = SpreadsheetApp.newColor().setRgbColor("#185ABC").build();
let criteria = SpreadsheetApp.newFilterCriteria()
.setVisibleBackgroundColor(color)
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
visibleBackgroundColor | Color | 要設定的背景顏色。顏色必須是 RGB 樣式。這個方法不支援主題顏色。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
setVisibleForegroundColor(visibleForegroundColor)
設定做為篩選條件使用的前景顏色。具有此前景顏色的儲存格會保持顯示。設定前景顏色篩選條件，會從此建構工具移除目前所有的顏色篩選條件。
這項條件只能用於 Grid 工作表 (預設工作表類型) 的篩選器。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that filters by foreground color and sets it to column B.
let color = SpreadsheetApp.newColor().setRgbColor("#185ABC").build();
let criteria = SpreadsheetApp.newFilterCriteria()
.setVisibleForegroundColor(color)
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
visibleForegroundColor | Color | 要設定的前景顏色。顏色必須是 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."
let pivotTable = ss.getPivotTables()[0];
let criteria = SpreadsheetApp.newFilterCriteria()
.setVisibleValues(["Northeast", "Southwest"])
.build();
pivotTable.addFilter(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
values | String[] | 要顯示的值清單。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenCellEmpty()
設定篩選條件顯示空白儲存格。
這項條件可搭配任何類型的篩選器使用。
// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Sets criteria to column B that only shows empty cells.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenCellEmpty()
.build();
filter.setColumnFilterCriteria(2, criteria);
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenCellNotEmpty()
設定篩選條件，顯示非空白的儲存格。
這項條件可搭配任何類型的篩選器使用。
// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Sets criteria to column B that only shows cells that aren't empty.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenCellNotEmpty()
.build();
filter.setColumnFilterCriteria(2, criteria);
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenDateAfter(date)
設定篩選條件，顯示日期晚於指定日期的儲存格。
這項條件可以與任何類型的篩選器搭配使用。如果您搭配這個條件使用與資料庫相連結的資料，則篩選的資料欄資料類型必須是日期。如果資料未連線至資料庫，則篩選的資料欄資料類型不一定要是日期，但如果非日期，可能會收到非預期的結果。
// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates after June 1, 2022
// and sets it to column A.
let date = new Date("June 1, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
.whenDateAfter(date)
.build();
filter.setColumnFilterCriteria(1, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | Date | 要隱藏的最新日期。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenDateAfter(date)
設定篩選條件，顯示日期在指定相對日期之後的儲存格。如要查看相對日期選項，請參閱列舉 RelativeDate。
這項條件可以與任何類型的篩選器搭配使用。如果您搭配這個條件使用與資料庫相連結的資料，則篩選的資料欄資料類型必須是日期。如果資料未連線至資料庫，則篩選的資料欄資料類型不一定要是日期，但如果非日期，可能會收到非預期的結果。
// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates after today's date
// and sets it to column A.
let date = SpreadsheetApp.RelativeDate.TODAY;
let criteria = SpreadsheetApp.newFilterCriteria()
.whenDateAfter(date)
.build();
filter.setColumnFilterCriteria(1, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | RelativeDate | 最新的相對日期。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenDateBefore(date)
設定篩選條件，顯示日期早於指定日期的儲存格。
這項條件可以與任何類型的篩選器搭配使用。如果您搭配這個條件使用與資料庫相連結的資料，則篩選的資料欄資料類型必須是日期。如果資料未連線至資料庫，則篩選的資料欄資料類型不一定要是日期，但如果非日期，可能會收到非預期的結果。
// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates before June 1, 2022
// and sets it to column A.
let date = new Date("June 1, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
.whenDateBefore(date)
.build();
filter.setColumnFilterCriteria(1, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | Date | 要隱藏的最早日期。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenDateBefore(date)
設定篩選條件，顯示日期在指定相對日期之前的儲存格。如要查看相對日期選項，請參閱列舉 RelativeDate。
這項條件可以與任何類型的篩選器搭配使用。如果您搭配這個條件使用與資料庫相連結的資料，則篩選的資料欄資料類型必須是日期。如果資料未連線至資料庫，則篩選的資料欄資料類型不一定要是日期，但如果非日期，可能會收到非預期的結果。
// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates before today's date
// and sets it to column A.
let date = SpreadsheetApp.RelativeDate.TODAY;
let criteria = SpreadsheetApp.newFilterCriteria()
.whenDateBefore(date)
.build();
filter.setColumnFilterCriteria(1, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | RelativeDate | 要隱藏的最早相對日期。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenDateEqualTo(date)
設定篩選條件，顯示日期等於指定日期的儲存格。
這項條件可以與任何類型的篩選器搭配使用。如果您搭配這個條件使用與資料庫相連結的資料，則篩選的資料欄資料類型必須是日期。如果資料未連線至資料庫，則篩選的資料欄資料類型不一定要是日期，但如果非日期，可能會收到非預期的結果。
// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates equal to June 1, 2022
// and sets it to column A.
let date = new Date("June 1, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
.whenDateEqualTo(date)
.build();
filter.setColumnFilterCriteria(1, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | Date | 儲存格值必須相符的日期。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenDateEqualTo(date)
設定篩選條件，顯示日期等於指定相對日期的儲存格。如要查看相對日期選項，請參閱列舉 RelativeDate。
這項條件可以與任何類型的篩選器搭配使用。如果您搭配這個條件使用與資料庫相連結的資料，則篩選的資料欄資料類型必須是日期。如果資料未連線至資料庫，則篩選的資料欄資料類型不一定要是日期，但如果非日期，可能會收到非預期的結果。
// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates that fall within the past month
// and sets it to column A.
let date = SpreadsheetApp.RelativeDate.PAST_MONTH;
let criteria = SpreadsheetApp.newFilterCriteria()
.whenDateEqualTo(date)
.build();
filter.setColumnFilterCriteria(1, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | RelativeDate | 儲存格值必須符合的相對日期。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenDateEqualToAny(dates)
設定篩選條件，顯示日期等於任何指定日期的儲存格。
這項條件只能搭配資料庫連線至的資料使用。例如，您可以使用這個條件搭配 DataSource 工作表、連結至資料庫的工作表，或是 DataSourcePivotTable (透過 DataSource 工作表建立的資料透視表) 套用篩選器。
// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that shows cells with any of the below dates.
let date1 = new Date("June 1, 2022");
let date2 = new Date("June 2, 2022");
let date3 = new Date("June 3, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
.whenDateEqualToAny([date1, date2, date3])
.build();
dataSheet.addFilter("date", criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
dates | Date[] | 要顯示的日期。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenDateNotEqualTo(date)
設定篩選條件，顯示不等於指定日期的儲存格。
這項條件只能搭配資料庫連線至的資料使用。例如，您可以使用這個條件搭配 DataSource 工作表、連結至資料庫的工作表，或是 DataSourcePivotTable (透過 DataSource 工作表建立的資料透視表) 套用篩選器。
您要篩選的資料欄資料類型必須是日期。
// Gets a pivot table that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Pivot Table Sheet");
let dataPivotTable = ss.getDataSourcePivotTables()[0];
// Creates criteria that only shows cells that don't equal June 16, 2022
// and sets it to the "date" column.
let date = new Date("June 16, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
.whenDateNotEqualTo(date)
.build();
dataPivotTable.addFilter("date", criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | Date | 要隱藏的日期。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenDateNotEqualToAny(dates)
設定篩選條件，顯示日期不得等於任何指定日期的儲存格。
這項條件只能搭配資料庫連線至的資料使用。例如，您可以使用這個條件搭配 DataSource 工作表、連結至資料庫的工作表，或是 DataSourcePivotTable (透過 DataSource 工作表建立的資料透視表) 套用篩選器。
// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that hides cells with any of the below dates.
let date1 = new Date("June 1, 2022");
let date2 = new Date("June 2, 2022");
let date3 = new Date("June 3, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
.whenDateNotEqualToAny([date1, date2, date3])
.build();
dataSheet.addFilter("date", criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
dates | Date[] | 要隱藏的日期。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenFormulaSatisfied(formula)
設定篩選條件，顯示內含指定公式 (例如 =B:B<C:C) 且評估為 true 的儲存格。
這項條件只能用來篩選未連結至資料庫的資料。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let 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.
let formula = "=B:B<C:C";
let criteria = SpreadsheetApp.newFilterCriteria()
.whenFormulaSatisfied(formula)
.build();
filter.setColumnFilterCriteria(1, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
formula | String | 在輸入有效時計算為 true 的自訂公式。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberBetween(start, end)
設定篩選條件，顯示含有介於 2 指定數字之間或為其中任一數字的儲存格。
這項條件可以與任何類型的篩選器搭配使用。如果您要搭配使用這項條件與連結至資料庫的資料，則篩選的資料欄資料類型必須是數字。如果資料未連結至資料庫，篩選的資料欄資料類型就不需要為數字，但如果非數字，可能會收到非預期的結果。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that only shows cells with numbers that fall between 1-25, inclusively,
// and sets it to column A.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberBetween(1, 25)
.build();
filter.setColumnFilterCriteria(1, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
start | Number | 可顯示的最低數字。 |
end | Number | 可顯示的最大數量。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberEqualTo(number)
設定篩選條件，顯示含有等於指定數字的儲存格。
這項條件可以與任何類型的篩選器搭配使用。如果您要搭配使用這項條件與連結至資料庫的資料，則篩選的資料欄資料類型必須是數字。如果資料未連結至資料庫，篩選的資料欄資料類型就不需要為數字，但如果非數字，可能會收到非預期的結果。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that only shows cells that are equal to 25 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberEqualTo(25)
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 要顯示的數字， |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberEqualToAny(numbers)
設定篩選條件，顯示含有等於任何指定數字的儲存格。
這項條件只能搭配資料庫連線至的資料使用。例如，您可以使用這個條件搭配 DataSource 工作表、連結至資料庫的工作表，或是 DataSourcePivotTable (透過 DataSource 工作表建立的資料透視表) 套用篩選器。
// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that only shows cells with the number 10, 20, or 30.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberEqualToAny([10,20,30])
.build();
dataSheet.addFilter("amount", criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
numbers | Number[] | 要顯示的數字。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberGreaterThan(number)
設定篩選條件，顯示數字大於指定數字的儲存格
這項條件可以與任何類型的篩選器搭配使用。如果您要搭配使用這項條件與連結至資料庫的資料，則篩選的資料欄資料類型必須是數字。如果資料未連結至資料庫，篩選的資料欄資料類型就不需要為數字，但如果非數字，可能會收到非預期的結果。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells greater than 10 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberGreaterThan(10)
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 要隱藏的最大數量。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberGreaterThanOrEqualTo(number)
設定篩選條件，顯示大於或等於指定數字的儲存格。
這項條件可以與任何類型的篩選器搭配使用。如果您要搭配使用這項條件與連結至資料庫的資料，則篩選的資料欄資料類型必須是數字。如果資料未連結至資料庫，篩選的資料欄資料類型就不需要為數字，但如果非數字，可能會收到非預期的結果。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells greater than or equal to 10 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberGreaterThanOrEqualTo(10)
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 可顯示的最低數字。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberLessThan(number)
設定篩選條件，顯示含有小於指定數字的儲存格。
這項條件可以與任何類型的篩選器搭配使用。如果您要搭配使用這項條件與連結至資料庫的資料，則篩選的資料欄資料類型必須是數字。如果資料未連結至資料庫，篩選的資料欄資料類型就不需要為數字，但如果非數字，可能會收到非預期的結果。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells less than 10 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberLessThan(10)
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 要隱藏的最低數字。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberLessThanOrEqualTo(number)
設定篩選條件，顯示小於或等於指定數字的儲存格。
這項條件可以與任何類型的篩選器搭配使用。如果您要搭配使用這項條件與連結至資料庫的資料，則篩選的資料欄資料類型必須是數字。如果資料未連結至資料庫，篩選的資料欄資料類型就不需要為數字，但如果非數字，可能會收到非預期的結果。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells less than or equal to 10 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberLessThanOrEqualTo(10)
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 可顯示的最大數量。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberNotBetween(start, end)
設定篩選條件，顯示含有數字的儲存格不在指定值範圍內，且並非 2 指定數字。
這項條件可以與任何類型的篩選器搭配使用。如果您要搭配使用這項條件與連結至資料庫的資料，則篩選的資料欄資料類型必須是數字。如果資料未連結至資料庫，篩選的資料欄資料類型就不需要為數字，但如果非數字，可能會收到非預期的結果。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that hides cells with numbers that fall between 1-25, inclusively,
// and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberNotBetween(1, 25)
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
start | Number | 隱藏人數下限。 |
end | Number | 要隱藏的最大數量。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberNotEqualTo(number)
設定篩選條件，顯示含有不等於指定數字的儲存格。
這項條件可以與任何類型的篩選器搭配使用。如果您要搭配使用這項條件與連結至資料庫的資料，則篩選的資料欄資料類型必須是數字。如果資料未連結至資料庫，篩選的資料欄資料類型就不需要為數字，但如果非數字，可能會收到非預期的結果。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that hides cells that are equal to 25 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberNotEqualTo(25)
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 要隱藏的數字。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenNumberNotEqualToAny(numbers)
設定篩選條件，顯示含有不等於任何指定數字的儲存格。
這項條件只能搭配資料庫連線至的資料使用。例如，您可以使用這個條件搭配 DataSource 工作表、連結至資料庫的工作表，或是 DataSourcePivotTable (透過 DataSource 工作表建立的資料透視表) 套用篩選器。
// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that hides cells with the number 10, 20, or 30.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenNumberNotEqualToAny([10,20,30])
.build();
dataSheet.addFilter("amount", criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
numbers | Number[] | 要隱藏的數字。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenTextContains(text)
設定篩選條件，顯示含有指定文字的儲存格。文字不區分大小寫。
這項條件可搭配任何類型的篩選器使用。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells that contain "Northwest" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenTextContains("Northwest")
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
text | String | 儲存格必須包含的文字。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenTextDoesNotContain(text)
設定篩選條件，顯示含有不含指定文字的儲存格。文字不區分大小寫。
這項條件可搭配任何類型的篩選器使用。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that hides cells that contain "Northwest" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenTextDoesNotContain("Northwest")
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
text | String | 儲存格不能包含的文字。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenTextEndsWith(text)
設定篩選條件，顯示含有指定文字結尾的儲存格。文字不區分大小寫。
這項條件可搭配任何類型的篩選器使用。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells with text that ends with "est" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenTextEndsWith("est")
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
text | String | 儲存格文字結尾必須包含的文字。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenTextEqualTo(text)
設定篩選條件，在儲存格中顯示與指定文字相同的文字。文字不區分大小寫。
這項條件可搭配任何類型的篩選器使用。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells with text that equals "hello" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenTextEqualTo("hello")
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
text | String | 儲存格文字必須相等的文字。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenTextEqualToAny(texts)
設定篩選條件，顯示內含文字等於任何指定文字值的儲存格。文字不區分大小寫。
這項條件只能搭配資料庫連線至的資料使用。例如，您可以使用這個條件搭配 DataSource 工作表、連結至資料庫的工作表，或是 DataSourcePivotTable (透過 DataSource 工作表建立的資料透視表) 套用篩選器。
// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that shows cells with the text "tech" or "business."
let criteria = SpreadsheetApp.newFilterCriteria()
.whenTextEqualToAny(["tech","business"])
.build();
dataSheet.addFilter("category", criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
texts | String[] | 儲存格必須相等的文字值。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenTextNotEqualTo(text)
設定篩選條件，顯示含有非指定文字的儲存格。文字不區分大小寫。
這項條件只能搭配資料庫連線至的資料使用。例如，您可以使用這個條件搭配 DataSource 工作表、連結至資料庫的工作表，或是 DataSourcePivotTable (透過 DataSource 工作表建立的資料透視表) 套用篩選器。
// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with text equal to "tech."
let criteria = SpreadsheetApp.newFilterCriteria()
.whenTextNotEqualTo("tech")
.build();
dataSheet.addFilter("category", criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
text | String | 儲存格的文字不得相等。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenTextNotEqualToAny(texts)
設定篩選條件，顯示含有不等於任何指定值的文字的儲存格。文字不區分大小寫。
這項條件只能搭配資料庫連線至的資料使用。例如，您可以使用這個條件搭配 DataSource 工作表、連結至資料庫的工作表，或是 DataSourcePivotTable (透過 DataSource 工作表建立的資料透視表) 套用篩選器。
// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with the text "tech" or "business."
let criteria = SpreadsheetApp.newFilterCriteria()
.whenTextNotEqualToAny(["tech","business"])
.build();
dataSheet.addFilter("category", criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
texts | String[] | 儲存格不相等的文字值。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。
whenTextStartsWith(text)
設定篩選條件，顯示含有指定文字開頭文字的儲存格。文字不區分大小寫。
這項條件可搭配任何類型的篩選器使用。
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells with text that starts with "pre" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
.whenTextStartsWith("pre")
.build();
filter.setColumnFilterCriteria(2, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
text | String | 儲存格文字開頭必須包含的文字。 |
回攻員
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();
let 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."
let filter = ss.getFilter();
let filterCriteria = filter.getColumnFilterCriteria(2);
let criteria = SpreadsheetApp.newFilterCriteria()
.withCriteria(filterCriteria.getCriteriaType(), filterCriteria.getCriteriaValues())
.setHiddenValues(["Northwest"])
.build();
filter.setColumnFilterCriteria(3, criteria);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
criteria | BooleanCriteria | 布林條件的類型。 |
args | Object[] | 適用於條件類型的引數陣列；引數數量及其類型與上述對應的 when...() 方法相符。 |
回攻員
FilterCriteriaBuilder — 這個建構工具用於鏈結。