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

Class FilterCriteriaBuilder

כדי להוסיף קריטריונים למסנן:

יוצרים את ה-builder של הקריטריונים באמצעות SpreadsheetApp.newFilterCriteria().
מוסיפים הגדרות ל-builder באמצעות השיטות מהמחלקה הזו.
משתמשים ב-build() כדי לאסוף את הקריטריונים עם ההגדרות שצוינו.

שימושים נפוצים

הסתרת ערכים בגיליון

בדוגמה הבאה מקבלים את המסנן הקיים של הגיליון ומוסיפים קריטריונים להסתרת התאים בעמודה C שמכילים את המילים "hello" או "world". אפשר להשתמש בקריטריונים שבמדגם הזה רק עם מסננים בגיליון 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);

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`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`	הגדרת קריטריונים לסינון כדי להציג תאים עם מספר שנמצא בין שני מספרים ספציפיים, או שהוא אחד משני המספרים האלה.
`whenNumberEqualTo(number)`	`FilterCriteriaBuilder`	הגדרת קריטריונים של מסנן כדי להציג תאים עם מספר שווה למספר שצוין.
`whenNumberEqualToAny(numbers)`	`FilterCriteriaBuilder`	הגדרת קריטריונים לסינון כך שיוצגו תאים עם מספר שווה לאחד מהמספרים שצוינו.
`whenNumberGreaterThan(number)`	`FilterCriteriaBuilder`	הגדרת קריטריונים לסינון כך שיוצגו תאים עם מספר גדול מהמספר שצוין
`whenNumberGreaterThanOrEqualTo(number)`	`FilterCriteriaBuilder`	הגדרת קריטריונים לסינון כך שיוצגו תאים עם מספר גדול מ- או שווה ל-.
`whenNumberLessThan(number)`	`FilterCriteriaBuilder`	הגדרת קריטריון הסינון כך שיוצגו תאים עם מספר שקטן מהמספר שצוין.
`whenNumberLessThanOrEqualTo(number)`	`FilterCriteriaBuilder`	הגדרת קריטריונים לסינון כך שיוצגו תאים עם מספר שקטן מ- או שווה ל-.
`whenNumberNotBetween(start, end)`	`FilterCriteriaBuilder`	הגדרת קריטריונים לסינון כך שיוצגו תאים עם מספר שאינו נמצא בין שני מספרים ספציפיים, ולא אחד משני המספרים האלה.
`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. מידע נוסף על סוגי הקריטריונים הבוליאניים זמין ב-enum‏ BooleanCriteria.

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

כדי לקבל את הארגומנטים של הקריטריונים, משתמשים ב-getCriteriaValues().
במאמר withCriteria(criteria, args) מוסבר איך משתמשים בסוג הקריטריונים ובערכים שלהם כדי ליצור או לשנות קריטריונים לסינון.

אפשר להשתמש בשיטה הזו בכל סוג של מסנן. אם קריטריון הסינון הוא לא תנאי בוליאני, הפונקציה מחזירה את הערך 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[] – מערך של ארגומנטים שמתאימים לסוג הקריטריון הבוליאני. מספר הארגומנטים והסוג שלהם תואמים לשיטה when...() המתאימה של הכיתה FilterCriteriaBuilder.

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

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

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

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

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

פרמטרים

שם	סוג	תיאור
`values`	`String[]`	רשימת הערכים שרוצים להסתיר.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

זריקות

Error – אם אחד מהערכים הוא null.

`setVisibleBackgroundColor(visibleBackgroundColor)`

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

אפשר להשתמש בקריטריונים האלה רק במסננים של גיליונות 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);

פרמטרים

שם	סוג	תיאור
`visibleBackgroundColor`	`Color`	צבע הרקע שרוצים להגדיר. הצבע צריך להיות בצורת RGB. השיטה הזו לא תומכת בצבעי עיצוב.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`visibleForegroundColor`	`Color`	צבע החזית שרוצים להגדיר. הצבע צריך להיות בצורת RGB. השיטה הזו לא תומכת בצבעי עיצוב.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`values`	`String[]`	רשימת הערכים שרוצים להציג.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

זריקות

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 – ה-builder הזה, לשרשור.

`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 – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`date`	`Date`	התאריך האחרון להסתרה.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenDateAfter(date)`

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

פרמטרים

שם	סוג	תיאור
`date`	`RelativeDate`	התאריך היחסי האחרון.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`date`	`Date`	התאריך המוקדם ביותר להסתרה.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenDateBefore(date)`

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

פרמטרים

שם	סוג	תיאור
`date`	`RelativeDate`	התאריך היחסי המוקדם ביותר להסתרה.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`date`	`Date`	התאריך שאליו הערכים בתאים חייבים להתאים.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenDateEqualTo(date)`

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

פרמטרים

שם	סוג	תיאור
`date`	`RelativeDate`	התאריך היחסי שערכי התאים חייבים להתאים אליו.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`dates`	`Date[]`	התאריכים שרוצים להציג.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenDateNotEqualTo(date)`

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

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

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

פרמטרים

שם	סוג	תיאור
`date`	`Date`	התאריך שרוצים להסתיר.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenDateNotEqualToAny(dates)`

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

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

פרמטרים

שם	סוג	תיאור
`dates`	`Date[]`	התאריכים שרוצים להסתיר.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenFormulaSatisfied(formula)`

מגדיר את קריטריונים הסינון כך שיוצגו תאים עם נוסחה ספציפית (למשל =B:B<C:C) שמתקבל ממנה הערך true.

אפשר להשתמש בקריטריונים האלה רק כדי לסנן נתונים שלא מקושרים למסד נתונים.

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

פרמטרים

שם	סוג	תיאור
`formula`	`String`	נוסחה מותאמת אישית שמתקבלת הערך `true` אם הקלט תקין.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenNumberBetween(start, end)`

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

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

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

פרמטרים

שם	סוג	תיאור
`start`	`Number`	המספר הנמוך ביותר שמוצג.
`end`	`Number`	המספר הגבוה ביותר שיוצג.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`number`	`Number`	המספר שרוצים להציג.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenNumberEqualToAny(numbers)`

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

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

פרמטרים

שם	סוג	תיאור
`numbers`	`Number[]`	המספרים שרוצים להציג.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`number`	`Number`	המספר הגבוה ביותר להסתרה.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`number`	`Number`	המספר הנמוך ביותר שמוצג.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`number`	`Number`	המספר הנמוך ביותר שרוצים להסתיר.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`number`	`Number`	המספר הגבוה ביותר שיוצג.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenNumberNotBetween(start, end)`

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

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

פרמטרים

שם	סוג	תיאור
`start`	`Number`	המספר הנמוך ביותר מוסתר.
`end`	`Number`	המספר הגבוה ביותר להסתרה.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`number`	`Number`	המספר שרוצים להסתיר.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenNumberNotEqualToAny(numbers)`

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

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

פרמטרים

שם	סוג	תיאור
`numbers`	`Number[]`	המספרים שרוצים להסתיר.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenTextContains(text)`

הגדרת קריטריונים לסינון כדי להציג תאים עם טקסט שמכיל את הטקסט שצוין. הטקסט לא תלוי אותיות רישיות (case-sensitive).

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

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

פרמטרים

שם	סוג	תיאור
`text`	`String`	הטקסט שהתא חייב להכיל.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`text`	`String`	הטקסט שאסור שיופיע בתא.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenTextEndsWith(text)`

הגדרת קריטריונים לסינון כך שיוצגו תאים עם טקסט שמסתיים בטקסט שצוין. הטקסט לא תלוי אותיות רישיות (case-sensitive).

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

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

פרמטרים

שם	סוג	תיאור
`text`	`String`	הטקסט שסוף הטקסט בתא חייב להכיל.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenTextEqualTo(text)`

הגדרת קריטריונים לסינון כדי להציג תאים עם טקסט שווה לטקסט שצוין. הטקסט לא תלוי אותיות רישיות (case-sensitive).

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

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

פרמטרים

שם	סוג	תיאור
`text`	`String`	הטקסט שאליו הטקסט בתא צריך להיות שווה.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenTextEqualToAny(texts)`

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

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

פרמטרים

שם	סוג	תיאור
`texts`	`String[]`	ערכי הטקסט שתא חייב להיות שווה להם.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenTextNotEqualTo(text)`

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

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

פרמטרים

שם	סוג	תיאור
`text`	`String`	הטקסט שטקסט התא לא יכול להיות שווה לו.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenTextNotEqualToAny(texts)`

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

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

פרמטרים

שם	סוג	תיאור
`texts`	`String[]`	ערכי הטקסט שתא לא יכול להיות שווה להם.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

`whenTextStartsWith(text)`

הגדרת קריטריונים לסינון כך שיוצגו תאים עם טקסט שמתחיל בטקסט שצוין. הטקסט לא תלוי אותיות רישיות (case-sensitive).

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

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

פרמטרים

שם	סוג	תיאור
`text`	`String`	הטקסט שתחילת הטקסט בתא חייבת להכיל.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`criteria`	`BooleanCriteria`	סוג הקריטריונים הבוליאניים.
`args`	`Object[]`	מערך של ארגומנטים שמתאימים לסוג הקריטריונים. מספר הארגומנטים והסוג שלהם תואמים לשיטות `when...()` התואמות שמפורטות למעלה.

חזרה

FilterCriteriaBuilder – ה-builder הזה, לשרשור.