Class Filter

מסנן

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

אם עדיין לא קיים מסנן בגיליון, יוצרים אותו באמצעות Range.createFilter().

כדי להשתמש בכיתה הזו, צריך קודם לגשת למסנן של גיליון התאים באמצעות Range.getFilter() או Sheet.getFilter().

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

הסרת מסנן

בדוגמה הבאה, המסנן מתקבל בגיליון הפעיל ומוסר. 
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

קבלת הטווח שהמסנן חל עליו

בדוגמה הבאה מופעל מסנן בגיליון הפעיל, ואז נעשה שימוש בשיטה getRange() מהסיווג הזה כדי לרשום ביומן את הטווח שהמסנן חל עליו. 
const ss = SpreadsheetApp.getActiveSheet();
// Gets the existing filter on the active sheet.
const filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getColumnFilterCriteria(columnPosition)FilterCriteria|nullמחזירה את קריטריוני הסינון בעמודה שצוינה, או null אם לא הוחלו על העמודה קריטריוני סינון.
getRange()Rangeמחזירה את הטווח שהמסנן חל עליו.
remove()voidהסרת המסנן הזה.
removeColumnFilterCriteria(columnPosition)Filterהפונקציה מסירה את קריטריוני הסינון מהעמודה שצוינה.
setColumnFilterCriteria(columnPosition, filterCriteria)Filterמגדירה את קריטריוני הסינון בעמודה שצוינה.
sort(columnPosition, ascending)Filterממיין את הטווח המסונן לפי העמודה שצוינה, לא כולל השורה הראשונה (שורה של כותרות) בטווח שהמסנן חל עליו.

תיעוד מפורט

getColumnFilterCriteria(columnPosition)

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

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

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Gets the filter criteria applied to column B of the active sheet
// and logs the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
console.log(filterCriteria);

פרמטרים

שםסוגתיאור
columnPositionIntegerהמיקום של העמודה, מבוסס על אינדקס שמתחיל ב-1. לדוגמה, האינדקס של עמודה ב' הוא 2.

חזרה

‫FilterCriteria|null – קריטריוני הסינון.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

מחזירה את הטווח שהמסנן חל עליו. 

// Gets the existing filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

חזרה

‫Range – הטווח של המסנן. כדי לקבל את הטווח בסימון A1, משלבים את ה-method הזה עם Range.getA1Notation().

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

הסרת המסנן הזה. 

// Removes the filter from the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.remove();

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeColumnFilterCriteria(columnPosition)

הפונקציה מסירה את קריטריוני הסינון מהעמודה שצוינה. 

// Removes the filter criteria from column B.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

פרמטרים

שםסוגתיאור
columnPositionIntegerהמיקום של העמודה, מבוסס על אינדקס שמתחיל ב-1. לדוגמה, האינדקס של עמודה ב' הוא 2.

חזרה

‫Filter – המסנן, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnFilterCriteria(columnPosition, filterCriteria)

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

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Builds the filter criteria to use as a parameter for setColumnFilterCriteria.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setHiddenValues(['Hello', 'World'])
                     .build();
// Sets the filter criteria for column C.
filter.setColumnFilterCriteria(3, criteria);

פרמטרים

שםסוגתיאור
columnPositionIntegerהמיקום של העמודה, מבוסס על אינדקס שמתחיל ב-1. לדוגמה, האינדקס של עמודה ב' הוא 2.
filterCriteriaFilterCriteriaקריטריוני הסינון שרוצים להגדיר. אם מגדירים את הקריטריונים ל-null, הקריטריונים לסינון יוסרו מהעמודה שצוינה. אפשר גם להשתמש ב-removeColumnFilterCriteria(columnPosition).

חזרה

‫Filter – המסנן, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(columnPosition, ascending)

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

// Gets the existing filter and sorts it by column B in ascending order.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.sort(2, true);

פרמטרים

שםסוגתיאור
columnPositionIntegerהמיקום של העמודה, מבוסס על אינדקס שמתחיל ב-1. לדוגמה, האינדקס של עמודה ב' הוא 2.
ascendingBooleanאם true, הטווח המסונן ממוין בסדר עולה. אם false, הטווח המסונן ממוין בסדר יורד.

חזרה

‫Filter – המסנן, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets