Class FilterCriteria

معیارهای فیلتر

از این کلاس برای دریافت اطلاعات یا کپی کردن معیارهای فیلترهای موجود استفاده کنید.

کاربردهای رایج

معیارهای کپی

نمونه زیر فیلتری را که برای محدوده A1:C20 اعمال می‌شود، دریافت می‌کند، معیارهای اعمال شده برای ستون C را دریافت می‌کند و معیارها را در ستون B کپی می‌کند. 
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() Filter Criteria Builder این معیارهای فیلتر را کپی می‌کند و یک سازنده معیار ایجاد می‌کند که می‌توانید آن را برای فیلتر دیگری اعمال کنید.
get Criteria Type() Boolean Criteria |null نوع بولی معیار، مثلاً CELL_EMPTY ، را برمی‌گرداند.
get Criteria Values() Object[] آرایه‌ای از آرگومان‌ها را برای معیارهای بولی برمی‌گرداند.
get Hidden Values() String[] مقادیری را که فیلتر پنهان می‌کند، برمی‌گرداند.
get Visible Background Color() Color |null رنگ پس‌زمینه‌ای که به عنوان معیار فیلتر استفاده می‌شود را برمی‌گرداند.
get Visible Foreground Color() Color |null رنگ پیش‌زمینه‌ای که به عنوان معیار فیلتر استفاده می‌شود را برمی‌گرداند.
get Visible Values() 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);

بازگشت

Filter Criteria Builder - سازنده معیارهای فیلتر بر اساس این معیارهای فیلتر.

get Criteria Type()

نوع بولی معیار را برمی‌گرداند، برای مثال، CELL_EMPTY . برای کسب اطلاعات بیشتر در مورد انواع معیارهای بولی، به enum Boolean Criteria مراجعه کنید.

افراد اغلب از این روش برای اضافه کردن معیارهای شرط بولی به یک فیلتر بدون جایگزینی معیارهای موجود استفاده می‌کنند.

شما می‌توانید از این متد برای هر نوع فیلتری استفاده کنید. اگر معیار فیلتر یک شرط بولی نباشد، 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);

بازگشت

Boolean Criteria |null — نوع معیارهای بولی، یا اگر معیار یک شرط بولی نباشد، null .

get Criteria Values()

آرایه‌ای از آرگومان‌ها را برای معیارهای بولی برمی‌گرداند. برخی از انواع معیارهای بولی آرگومان ندارند و یک آرایه خالی برمی‌گردانند، برای مثال، CELL_NOT_EMPTY .

افراد اغلب از این روش برای اضافه کردن معیارهای شرط بولی به یک فیلتر بدون جایگزینی معیارهای موجود استفاده می‌کنند.

  • برای دریافت نوع معیار بولی، get Criteria Type() استفاده کنید.
  • برای استفاده از نوع معیار و مقادیر معیارها برای ایجاد یا اصلاح معیارهای فیلتر، به Filter Criteria Builder.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...() مربوط به کلاس Filter Criteria Builder مطابقت دارد.

get Hidden Values()

مقادیری را که فیلتر پنهان می‌کند، برمی‌گرداند.

از این معیار با فیلترها روی صفحات 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[] — آرایه‌ای از مقادیر که فیلتر آنها را پنهان می‌کند.

get Visible Background Color()

رنگ پس‌زمینه‌ای که به عنوان معیار فیلتر استفاده می‌شود را برمی‌گرداند. سلول‌هایی که این رنگ پس‌زمینه را دارند، قابل مشاهده باقی می‌مانند.

از این معیار با فیلترها روی صفحات 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 — رنگ پس‌زمینه‌ای که به عنوان معیار فیلتر استفاده می‌شود.

get Visible Foreground Color()

رنگ پیش‌زمینه‌ای که به عنوان معیار فیلتر استفاده می‌شود را برمی‌گرداند. سلول‌هایی که این رنگ پیش‌زمینه را دارند، قابل مشاهده باقی می‌مانند.

از این معیار با فیلترها روی صفحات 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 — رنگ پیش‌زمینه که به عنوان معیار فیلتر استفاده می‌شود.

get Visible Values()

مقادیری را که فیلتر جدول محوری نشان می‌دهد، برمی‌گرداند.

این معیار فقط برای فیلترهای روی جداول محوری است که به پایگاه داده متصل نیستند. برای انواع دیگر فیلترها، یک آرایه خالی برمی‌گرداند.

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[] — آرایه‌ای از مقادیر که فیلتر جدول محوری نشان می‌دهد.