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

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
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، اربط هذه الطريقة بـ 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