Class Filter

סינון

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

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

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

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

הסרת מסנן

בדוגמה הבאה, המסנן מופיע בגיליון הפעיל ומסיר אותו.

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

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

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

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

שיטות

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

תיעוד מפורט

getColumnFilterCriteria(columnPosition)

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

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

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

פרמטרים

שם	תיאור	התיאור
columnPosition	Integer	המיקום של העמודה באינדקס. לדוגמה, האינדקס של עמודה B הוא 2.

החזרות

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

הרשאות

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

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

---

getRange()

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

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

החזרות

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

הרשאות

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

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

---

remove()

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

// Removes the filter from the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let 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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

פרמטרים

שם	תיאור	התיאור
columnPosition	Integer	המיקום של העמודה באינדקס. לדוגמה, האינדקס של עמודה B הוא 2.

החזרות

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

הרשאות

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

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

---

setColumnFilterCriteria(columnPosition, filterCriteria)

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

let ss = SpreadsheetApp.getActiveSheet();
let 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);

פרמטרים

שם	תיאור	התיאור
columnPosition	Integer	המיקום של העמודה באינדקס. לדוגמה, האינדקס של עמודה B הוא 2.
filterCriteria	FilterCriteria	הקריטריונים לסינון. אם מגדירים את הקריטריונים כ-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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.sort(2, true);

פרמטרים

שם	תיאור	התיאור
columnPosition	Integer	המיקום של העמודה באינדקס. לדוגמה, האינדקס של עמודה B הוא 2.
ascending	Boolean	אם הערך הוא true, הטווח המסונן בסדר עולה. אם הערך false, הטווח המסונן ממיין בסדר יורד.

החזרות

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

הרשאות

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

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