Class FilterCriteria

معايير الفلتر

استخدِم هذه الفئة للحصول على معلومات عن المعايير في الفلاتر الحالية أو نسخها.

طرق الاستخدام الشائعة

نسخ المعايير

يحصل العيّنة التالية على الفلتر الذي ينطبق على النطاق A1:C20، ويحصل على المعايير المطبَّقة على العمود "ج"، وينسخ المعايير إلى العمود "ب". 
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Copies the filter criteria applied to column C.
const filter = range.getFilter();
const criteria = filter.getColumnFilterCriteria(3).copy().build();
// Applies the copied criteria to column B. The copied criteria overwrites any
// existing criteria on column B.
filter.setColumnFilterCriteria(2, criteria);

الحصول على القيم المخفية بواسطة الفلتر

يحصل العيّنة التالية على الفلتر الذي ينطبق على النطاق المحدّد ويسجّل القيم من عمود B الذي يخفي الفلتر. 
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
copy()FilterCriteriaBuilderنسخ معايير هذا الفلتر وإنشاء أداة إنشاء معايير يمكنك تطبيقها على فلتر آخر
getCriteriaType()BooleanCriteriaتعرِض هذه الدالة نوع المعايير المنطقي، على سبيل المثال، CELL_EMPTY.
getCriteriaValues()Object[]لعرض صفيف من الوسيطات للمعايير المنطقية.
getHiddenValues()String[]عرض القيم التي يخفيها الفلتر
getVisibleBackgroundColor()Colorعرض لون الخلفية المستخدَم كمعايير فلترة
getVisibleForegroundColor()Colorتعرِض هذه الدالة لون المقدّمة المستخدَم كمعايير فلترة.
getVisibleValues()String[]لعرض القيم التي يعرضها فلتر الجدول المحوري

مستندات تفصيلية

copy()

نسخ معايير هذا الفلتر وإنشاء أداة إنشاء معايير يمكنك تطبيقها على فلتر آخر

يمكنك استخدام هذه الطريقة مع أي نوع من الفلاتر. إذا كنت تستخدم فلتر ورقة بيانات، يمكنك نسخ المعايير إلى عمود آخر. 

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
const criteria = filter.getColumnFilterCriteria(3).copy().build();
// Applies the copied criteria to column B. The copied criteria overwrites any
// existing criteria on column B.
filter.setColumnFilterCriteria(2, criteria);

الإرجاع

FilterCriteriaBuilder - أداة إنشاء معايير الفلتر استنادًا إلى معايير الفلتر هذه

getCriteriaType()

تعرِض هذه الدالة نوع المعايير المنطقي، على سبيل المثال، CELL_EMPTY. للتعرّف على أنواع المعايير المنطقية، اطّلِع على التعداد BooleanCriteria.

غالبًا ما يستخدم الأشخاص هذه الطريقة لإضافة معايير شرطية منطقية إلى فلتر بدون استبدال المعايير الحالية.

يمكنك استخدام هذه الطريقة لأي نوع من الفلاتر. إذا لم تكن معايير الفلتر عبارة عن شرط برمجي برمجي، يتم عرض null. 

const ss = SpreadsheetApp.getActiveSheet();
// Gets the filter on the active sheet.
const filter = ss.getFilter();
// Gets the criteria type and returns a string representing the criteria type
// object.
const criteriaType =
    filter.getColumnFilterCriteria(2).getCriteriaType().toString();
// Logs the criteria type.
console.log(criteriaType);

الإرجاع

BooleanCriteria: نوع المعايير المنطقية، أو null إذا لم تكن المعايير شرطًا منطقيًا

getCriteriaValues()

لعرض صفيف من الوسيطات للمعايير المنطقية. لا تحتوي بعض أنواع المعايير المنطقية على وسيطات وتُعرِض صفيفًا فارغًا، على سبيل المثال، CELL_NOT_EMPTY.

غالبًا ما يستخدم الأشخاص هذه الطريقة لإضافة معايير شرطية منطقية إلى فلتر بدون استبدال المعايير الحالية.

  • للحصول على نوع المعايير المنطقية، استخدِم getCriteriaType().
  • لاستخدام نوع المعايير وقيم المعايير لإنشاء معايير فلتر أو تعديلها، اطّلِع على FilterCriteriaBuilder.withCriteria(criteria, args).

    يمكنك استخدام هذه الطريقة لأي نوع من الفلاتر. 

    const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Gets the values of the boolean criteria and logs them. For example, if the
// boolean condition is whenNumberGreaterThan(10), then the logged value is 10.
const criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues();
console.log(criteriaValues);

    الإرجاع

    Object[]: صفيف من الوسيطات المناسبة لنوع المعايير المنطقية يتطابق عدد الوسيطات ونوعها مع طريقة when...() المقابلة لفئة FilterCriteriaBuilder.

getHiddenValues()

عرض القيم التي يخفيها الفلتر

استخدِم هذه المعايير مع الفلاتر في Grid ورقة بيانات، وهو النوع التلقائي لورقة البيانات. تعرِض القيمة null إذا تم استدعاء هذه الطريقة لأنواع أخرى من الفلاتر. 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

الإرجاع

String[]: مصفوفة من القيم التي يخفيها الفلتر

getVisibleBackgroundColor()

عرض لون الخلفية المستخدَم كمعايير فلترة تظل الخلايا التي تتضمّن لون الخلفية هذا مرئية.

استخدِم هذه المعايير مع الفلاتر في Grid ورقة بيانات، وهو النوع التلقائي لورقة البيانات. تعرِض القيمة null إذا تم استدعاء هذه الطريقة لأنواع أخرى من الفلاتر. 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the background color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleBackgroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

الإرجاع

Color: لون الخلفية المستخدَم كمعايير فلترة

getVisibleForegroundColor()

تعرِض هذه الدالة لون المقدّمة المستخدَم كمعايير فلترة. تظل الخلايا التي تتضمّن لون المقدّمة هذا مرئية.

استخدِم هذه المعايير مع الفلاتر في Grid ورقة بيانات، وهو النوع التلقائي لورقة البيانات. تعرِض القيمة null إذا تم استدعاء هذه الطريقة لأنواع أخرى من الفلاتر. 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the foreground color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleForegroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

الإرجاع

Color: لون المقدّمة المستخدَم كمعايير فلترة

getVisibleValues()

لعرض القيم التي يعرضها فلتر الجدول المحوري

هذه المعايير مخصّصة فقط للفلاتر في الجداول المحورية غير المرتبطة بقاعدة بيانات. لعرض صفيف فارغ لأنواع الفلاتر الأخرى. 

const ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet, then gets the visible values of its
// first filter.
const pivotTable = ss.getPivotTables()[0];
const pivotFilterValues =
    pivotTable.getFilters()[0].getFilterCriteria().getVisibleValues();
// Logs the visible values.
console.log(pivotFilterValues);

الإرجاع

String[]: صفيف من القيم التي يعرضها فلتر الجدول المحوري