דף זה תורגם על ידי Cloud Translation API.

Class FilterCriteriaBuilder

כדי להוסיף קריטריונים למסנן, צריך לבצע את הפעולות הבאות:

יוצרים את הכלי ליצירת קריטריונים באמצעות SpreadsheetApp.newFilterCriteria().
אפשר להוסיף הגדרות ל-builder באמצעות השיטות מהקורס הזה.
משתמשים בפונקציה 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, גיליון שמחובר למסד נתונים, עם קריטריונים להצגת תאים ריקים בעמודה 'קטגוריה' בלבד.

// 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()`	`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`	המדיניות מגדירה את הקריטריונים לסינון כך שיוצגו תאים עם נוסחה ספציפית (למשל `=B:B<C:C`) שהערך שלה הוא `true`.
`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 מספרים שצוינו.
`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();
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[] - מערך ארגומנטים המתאים לסוג הקריטריונים הבוליאני. מספר הארגומנטים והסוג שלהם תואמים לשיטה when...() התואמת של המחלקה FilterCriteriaBuilder.

`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()`

מחזירה את צבע הרקע שמשמש כקריטריונים של סינון. תאים עם צבע הרקע הזה יישארו גלויים.

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()`

מחזירה את צבע החזית המשמש כקריטריון מסנן. תאים עם צבע החזית הזה יישארו גלויים.

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)`

מגדירה קריטריוני סינון שמציגים תאים עם תאריכים שחלים אחרי התאריך היחסי שצוין. ב-Enum 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)`

מגדירה קריטריוני סינון שמציגים תאים עם תאריכים שנמצאים לפני התאריך היחסי שצוין. כדי לראות את האפשרויות של התאריכים היחסיים, אפשר לעיין ב-Enum 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)`

מגדירה קריטריוני סינון שמציגים תאים עם תאריכים ששווים לתאריך היחסי שצוין. כדי לראות את האפשרויות של התאריכים היחסיים, אפשר לעיין ב-Enum 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)`

מגדיר את הקריטריונים לסינון כך שיוצגו תאים שאינם זהים לתאריך שצוין.

סוג הנתונים בעמודה שלפיה אתם מסננים חייב להיות תאריך.

// 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)`

הפונקציה מגדירה את הקריטריונים לסינון כך שיוצגו תאים עם תאריכים שלא שווים לאף אחד מהתאריכים שמצוינים.

// 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)`

הפונקציה מגדירה את הקריטריונים לסינון כך שיוצגו תאים עם מספר השווה לכל אחד מהמספרים שמצוינים.

// 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)`

הפונקציה מגדירה את הקריטריונים לסינון כך שיוצגו תאים עם מספר שאינו שווה לאף אחד מהמספרים שצוינו.

// 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)`

מגדירה את הקריטריונים לסינון כך שיוצגו תאים עם טקסט ששווה לכל אחד מערכי הטקסט שמצוינים. הטקסט אינו תלוי אותיות רישיות.

// 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)`

מגדיר את הקריטריונים לסינון כך שיוצגו תאים עם טקסט שאינו שווה לטקסט שצוין. הטקסט אינו תלוי אותיות רישיות.

// 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)`

מגדירה את הקריטריונים לסינון כך שיוצגו תאים עם טקסט שלא שווה לאף אחד מהערכים שצוינו. הטקסט אינו תלוי אותיות רישיות.

// 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 – הכלי הזה – לשרשורים.