Class FilterCriteria

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

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

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

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

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

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

מחזירה מערך של ארגומנטים לקריטריונים בוליאניים. לחלק מסוגי הקריטריונים הבוליאניים אין ארגומנטים והם מחזירים מערך ריק, לדוגמה, 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.

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

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

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

אפשר להשתמש בקריטריונים האלה עם מסננים בגיליונות 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|null — צבע הרקע שמשמש כקריטריון לסינון.

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

אפשר להשתמש בקריטריונים האלה עם מסננים בגיליונות 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|null — צבע החזית שמשמש כקריטריון לסינון.

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

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

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