Class Filter

فیلتر کنید

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

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

برای استفاده از این کلاس، ابتدا باید با استفاده از Range.getFilter() یا Sheet.getFilter() به فیلتر صفحه شبکه دسترسی داشته باشید.

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

یک فیلتر را بردارید

نمونه زیر فیلتر را روی صفحه فعال دریافت می کند و آن را حذف می کند. 
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 .
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 موقعیت 1-نمایه شده ستون. به عنوان مثال، شاخص ستون B 2 است.

بازگشت

Filter Criteria - معیارهای فیلتر.

مجوز

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

  • 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 موقعیت 1-نمایه شده ستون. به عنوان مثال، شاخص ستون B 2 است.

بازگشت

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 موقعیت 1-نمایه شده ستون. به عنوان مثال، شاخص ستون B 2 است.
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 موقعیت 1-نمایه شده ستون. به عنوان مثال، شاخص ستون B 2 است.
ascending Boolean اگر true ، محدوده فیلتر شده را به ترتیب صعودی مرتب می کند. اگر false ، محدوده فیلتر شده را به ترتیب نزولی مرتب می کند.

بازگشت

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

مجوز

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

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