Class FilterCriteria

FilterCriteria

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

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

העתקת הקריטריונים

בדוגמה הבאה מקבלים את המסנן שחלה על הטווח A1:C20, מקבלים את הקריטריונים שחלים על העמודה ג' ומעתיקים את הקריטריונים לעמודה ב'. 
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Copies the filter criteria applied to column C.
const filter = range.getFilter();
const criteria = filter.getColumnFilterCriteria(3).copy().build();
// Applies the copied criteria to column B. The copied criteria overwrites any
// existing criteria on column B.
filter.setColumnFilterCriteria(2, criteria);

אחזור ערכים שהמסנן מסתיר

בדוגמה הבאה מקבלים את המסנן שחלה על הטווח הנתון ומתעדים ביומן את הערכים בעמודה B שהמסנן מסתיר. 
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

Methods

שיטהסוג הערך המוחזרתיאור קצר
copy()FilterCriteriaBuilderמעתיק את קריטריוני הסינון האלה ויוצר כלי ליצירת קריטריונים שאפשר להחיל על מסנן אחר.
getCriteriaType()BooleanCriteriaהפונקציה מחזירה את הסוג הבוליאני של הקריטריון, לדוגמה, CELL_EMPTY.
getCriteriaValues()Object[]הפונקציה מחזירה מערך של ארגומנטים לקריטריונים בוליאניים.
getHiddenValues()String[]הפונקציה מחזירה את הערכים שהמסנן מסתיר.
getVisibleBackgroundColor()Colorהפונקציה מחזירה את צבע הרקע שמשמש כקריטריון סינון.
getVisibleForegroundColor()Colorהפונקציה מחזירה את צבע החזית שמשמש כקריטריון סינון.
getVisibleValues()String[]הפונקציה מחזירה את הערכים שמוצגים במסנן של טבלת הצירים.

מסמכים מפורטים

copy()

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

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

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

חזרה

FilterCriteriaBuilder – כלי ליצירת קריטריונים לסינון על סמך קריטריוני הסינון האלה.

getCriteriaType()

הפונקציה מחזירה את הסוג הבוליאני של הקריטריון, לדוגמה, CELL_EMPTY. מידע נוסף על סוגי הקריטריונים הבוליאניים זמין ב-enum‏ BooleanCriteria.

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

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

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

חזרה

BooleanCriteria — הסוג של הקריטריון הבוליאני, או null אם הקריטריון הוא לא תנאי בוליאני.

getCriteriaValues()

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

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

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

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

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

    חזרה

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

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

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

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

חזרה

Color — צבע הרקע שמשמש כקריטריון סינון.

getVisibleForegroundColor()

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

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

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

חזרה

Color — צבע החזית שמשמש כקריטריון סינון.

getVisibleValues()

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

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

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

חזרה

String[] – מערך של ערכים שמוצגים במסנן של טבלת הצירים.