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

المَعلمات

الاسمTypeالوصف
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.
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);

المَعلمات

الاسمTypeالوصف
columnPositionIntegerالموضع الذي تمت فهرسته من خلال العمود 1. على سبيل المثال، فهرس العمود B هو 2.

استرجاع الكرة

Filter - الفلتر المستخدَم للتسلسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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

setColumnFilterCriteria(columnPosition, filterCriteria)

تحدِّد هذه السياسة معايير الفلتر في العمود المحدَّد. أولاً، أنشئ أداة إنشاء معايير الفلاتر باستخدام SpreadsheetApp.newFilterCriteria(). بعد ذلك، أضِف المعايير إلى "أداة الإنشاء" باستخدام الفئة 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);

المَعلمات

الاسمTypeالوصف
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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.sort(2, true);

المَعلمات

الاسمTypeالوصف
columnPositionIntegerالموضع الذي تمت فهرسته من خلال العمود 1. على سبيل المثال، فهرس العمود B هو 2.
ascendingBooleanإذا كان true، سيتم ترتيب النطاق الذي تمت فلترته تصاعديًا، وإذا كان false، سيتم ترتيب النطاق تنازليًا.

استرجاع الكرة

Filter - الفلتر المستخدَم للتسلسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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