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();

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

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

חזרה

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

אישור

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

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

setColumnFilterCriteria(columnPosition, filterCriteria)

הגדרת קריטריוני הסינון בעמודה שצוינה. קודם כל יוצרים את ה-builder של קריטריוני הסינון באמצעות SpreadsheetApp.newFilterCriteria(). לאחר מכן מוסיפים קריטריונים ל-builder באמצעות הכיתה 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. לדוגמה, האינדקס של עמודה 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.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.sort(2, true);

פרמטרים

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

חזרה

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

אישור

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

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