Class FilterCriteria

FilterCriteria

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

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

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

הדוגמה הבאה מאחזרת את המסנן שחל על הטווח A1:C20, מקבל את הקריטריונים הוחלו על עמודה C ומעתיקים את הקריטריונים לעמודה B.
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Copies the filter criteria applied to column C.
let filter = range.getFilter();
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);

הצגת ערכים המוסתרים על ידי המסנן

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

שיטות

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

מסמכי תיעוד מפורטים

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 enum.

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

  • כדי לקבל את הארגומנטים של הקריטריונים, משתמשים בפונקציה getCriteriaValues().
  • כדי להשתמש בסוג הקריטריונים ובערכי הקריטריונים כדי ליצור או לשנות קריטריוני סינון, אפשר לעיין במאמר FilterCriteriaBuilder.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().
  • כדי להשתמש בסוג הקריטריונים ובערכי הקריטריונים כדי ליצור או לשנות קריטריונים לסינון, ראו: FilterCriteriaBuilder.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()

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

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