این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class FilterCriteria

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

برای ایجاد فیلتر جدید به موارد زیر مراجعه کنید:
- برای برگه ها، از Range.createFilter() استفاده کنید.
- برای جداول محوری، از Pivot Table.addFilter(sourceDataColumn, filterCriteria) استفاده کنید.
- برای برگه هایی که به یک پایگاه داده متصل هستند، Data Source Sheet.addFilter(columnName, filterCriteria) استفاده کنید.
- برای جداول محوری که به پایگاه داده متصل هستند، Data Source Pivot Table.addFilter(columnName, filterCriteria) استفاده کنید.
برای ایجاد معیارهای هر نوع فیلتر، به Spreadsheet App.newFilterCriteria() و Filter Criteria Builder مراجعه کنید.

استفاده های رایج

کپی معیارها

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

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

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

بازگشت

Boolean Criteria - نوع معیار بولی، یا اگر معیار شرط بولی نباشد، 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()`

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

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

`get Visible Foreground Color()`

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

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

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