Class FilterCriteria

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
معايير الفلتر

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

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

نسخ المعايير

يحصل النموذج التالي على الفلتر الذي ينطبق على النطاق A1:C20، ويحصل على المعايير المطبّقة على العمود ج، وينسخ المعايير إلى العمود ب.
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Copies the filter criteria applied to column C.
let filter = range.getFilter();
let 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 الذي يخفيه الفلتر.
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
let 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()

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

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

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
let 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.

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

تذكرة ذهاب وعودة

BooleanCriteria — نوع المعايير المنطقية، أو null إذا لم تكن المعايير منطقية #39;t.


getCriteriaValues()

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

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

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

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

    let ss = SpreadsheetApp.getActiveSheet();
    let 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.
    let criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues();
    console.log(criteriaValues);

    تذكرة ذهاب وعودة

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


getHiddenValues()

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

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

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

تذكرة ذهاب وعودة

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


getVisibleBackgroundColor()

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

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

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

تذكرة ذهاب وعودة

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


getVisibleForegroundColor()

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

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

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

تذكرة ذهاب وعودة

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


getVisibleValues()

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

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

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

تذكرة ذهاب وعودة

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