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

כדי לקבל פרטים נוספים על הקריטריונים של המסנן, אפשר לשרשר את השיטה הזו באמצעות שיטות כיתה אחת (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);

פרמטרים

שםסוגתיאור
columnPositionIntegerהמיקום של העמודה באינדקס. לדוגמה, האינדקס של עמודה 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);

פרמטרים

שםסוגתיאור
columnPositionIntegerהמיקום של העמודה באינדקס. לדוגמה, האינדקס של עמודה 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);

פרמטרים

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

פרמטרים

שםסוגתיאור
columnPositionIntegerהמיקום של העמודה באינדקס. לדוגמה, האינדקס של עמודה B הוא 2.
ascendingBooleanאם הערך הוא true, הפונקציה ממיינת את הטווח המסונן בסדר עולה. אם false הפונקציה ממיינת את הטווח המסונן בסדר יורד.

חזרה

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

אישור

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

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