Class Filter

فیلتر

از این کلاس برای تغییر فیلترهای موجود در صفحات Grid ، نوع پیش‌فرض صفحات، استفاده کنید. صفحات Grid، صفحات معمولی با داده‌هایی هستند که به پایگاه داده متصل نیستند.

اگر هنوز فیلتری روی برگه وجود ندارد، با استفاده از Range.createFilter() یکی ایجاد کنید.

برای استفاده از این کلاس، ابتدا باید با استفاده از Range.getFilter() یا Sheet.getFilter() به فیلتر grid sheet دسترسی پیدا کنید.

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

حذف یک فیلتر

نمونه زیر فیلتر را روی برگه فعال دریافت و آن را حذف می‌کند. 
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

محدوده‌ای که فیلتر روی آن اعمال می‌شود را دریافت کنید

نمونه زیر فیلتر را روی برگه فعال دریافت می‌کند، سپس از متد get Range() از این کلاس برای ثبت محدوده‌ای که فیلتر به آن اعمال می‌شود، استفاده می‌کند. 
const ss = SpreadsheetApp.getActiveSheet();
// Gets the existing filter on the active sheet.
const filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

روش‌ها

روش نوع بازگشتی شرح مختصر
get Column Filter Criteria(columnPosition) Filter Criteria |null معیارهای فیلتر را برای ستون مشخص شده برمی‌گرداند، یا اگر ستون معیارهای فیلتری روی آن اعمال نشده باشد null برمی‌گرداند.
get Range() Range محدوده‌ای که این فیلتر روی آن اعمال می‌شود را برمی‌گرداند.
remove() void این فیلتر را حذف می‌کند.
remove Column Filter Criteria(columnPosition) Filter معیارهای فیلتر را از ستون مشخص شده حذف می‌کند.
set Column Filter Criteria(columnPosition, filterCriteria) Filter معیارهای فیلتر را روی ستون مشخص شده تنظیم می‌کند.
sort(columnPosition, ascending) Filter محدوده فیلتر شده را بر اساس ستون مشخص شده، به استثنای ردیف اول (ردیف سربرگ) در محدوده‌ای که این فیلتر روی آن اعمال می‌شود، مرتب می‌کند.

مستندات دقیق

get Column Filter Criteria(columnPosition)

معیارهای فیلتر را برای ستون مشخص شده برمی‌گرداند، یا اگر ستون معیارهای فیلتری روی آن اعمال نشده باشد null برمی‌گرداند.

برای دریافت جزئیات بیشتر در مورد معیارهای فیلتر، این متد را با متدهای کلاس Filter Criteria زنجیر کنید.

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Gets the filter criteria applied to column B of the active sheet
// and logs the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
console.log(filterCriteria);

پارامترها

نام نوع توضیحات
column Position Integer موقعیت ستون با اندیس ۱. برای مثال، اندیس ستون B برابر با ۲ است.

بازگشت

Filter Criteria |null — معیار فیلتر.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Range()

محدوده‌ای که این فیلتر روی آن اعمال می‌شود را برمی‌گرداند.

// Gets the existing filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

بازگشت

Range — محدوده فیلتر. برای دریافت محدوده با نمادگذاری A1، این متد را با Range.getA1Notation() زنجیره کنید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

این فیلتر را حذف می‌کند.

// Removes the filter from the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.remove();

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove Column Filter Criteria(columnPosition)

معیارهای فیلتر را از ستون مشخص شده حذف می‌کند.

// Removes the filter criteria from column B.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

پارامترها

نام نوع توضیحات
column Position Integer موقعیت ستون با اندیس ۱. برای مثال، اندیس ستون B برابر با ۲ است.

بازگشت

Filter — فیلتر، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Column Filter Criteria(columnPosition, filterCriteria)

معیارهای فیلتر را روی ستون مشخص شده تنظیم می‌کند. ابتدا، سازنده معیارهای فیلتر را با استفاده از Spreadsheet App.newFilterCriteria() ایجاد کنید. سپس با استفاده از کلاس Filter Criteria Builder ، معیارها را به سازنده اضافه کنید. پس از اینکه معیارهای خود را ساختید، آن را به عنوان پارامتر filter Criteria برای این متد تنظیم کنید.

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Builds the filter criteria to use as a parameter for setColumnFilterCriteria.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setHiddenValues(['Hello', 'World'])
                     .build();
// Sets the filter criteria for column C.
filter.setColumnFilterCriteria(3, criteria);

پارامترها

نام نوع توضیحات
column Position Integer موقعیت ستون با اندیس ۱. برای مثال، اندیس ستون B برابر با ۲ است.
filter Criteria Filter Criteria معیارهای فیلتر برای تنظیم. اگر معیارها را روی null تنظیم کنید، معیارهای فیلتر را از ستون مشخص شده حذف می‌کند. همچنین می‌توانید remove Column Filter Criteria(columnPosition) استفاده کنید.

بازگشت

Filter — فیلتر، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(columnPosition, ascending)

محدوده فیلتر شده را بر اساس ستون مشخص شده، به استثنای ردیف اول (ردیف سربرگ) در محدوده‌ای که این فیلتر روی آن اعمال می‌شود، مرتب می‌کند.

// Gets the existing filter and sorts it by column B in ascending order.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.sort(2, true);

پارامترها

نام نوع توضیحات
column Position Integer موقعیت ستون با اندیس ۱. برای مثال، اندیس ستون B برابر با ۲ است.
ascending Boolean اگر true ، محدوده فیلتر شده را به ترتیب صعودی و اگر false ، محدوده فیلتر شده را به ترتیب نزولی مرتب می‌کند.

بازگشت

Filter — فیلتر، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets