Class FilterCriteria

FilterCriteria

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

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

نسخ المعايير

يحصل النموذج التالي على الفلتر الذي ينطبق على النطاق A1:C20، ويحصل على المعايير المطبقة على العمود C، وينسخ المعايير إلى العمود B.
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 إذا لم تكن المعايير شرطًا منطقيًا


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[]: مصفوفة من القيم التي يعرضها فلتر الجدول المحوري