Class FilterCriteria

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

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

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: أداة إنشاء معايير الفلتر استنادًا إلى معايير الفلتر هذه.

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

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

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

يمكنك استخدام هذه الطريقة لأي نوع من الفلاتر. إذا لم تكن معايير الفلتر شرطًا منطقيًا، تعرض الدالة 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 — نوع المعايير المنطقية، أو null إذا لم تكن المعايير شرطًا منطقيًا.

تعرض هذه الدالة مصفوفة من الوسيطات للمعايير المنطقية. لا تتضمّن بعض أنواع معايير القيم المنطقية وسيطات وتعرض مصفوفة فارغة، مثل 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.

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

استخدِم هذه المعايير مع الفلاتر في أوراق 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[]: مصفوفة من القيم التي يخفيها الفلتر.

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

استخدِم هذه المعايير مع الفلاتر في أوراق 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|null: لون الخلفية المستخدَم كمعيار للفلتر.

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

استخدِم هذه المعايير مع الفلاتر في أوراق 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|null: لون المقدّمة المستخدَم كمعيار فلترة.

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

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

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