Class Filter

فیلتر کنید

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

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

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

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

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

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

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

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

روش ها

روش نوع برگشت شرح مختصر
getColumnFilterCriteria(columnPosition) FilterCriteria معیارهای فیلتر را در ستون مشخص شده دریافت می کند، یا اگر ستون معیارهای فیلتر را برای آن اعمال نکرده باشد، null .
getRange() Range محدوده ای که این فیلتر برای آن اعمال می شود را دریافت می کند.
remove() void این فیلتر را حذف می کند.
removeColumnFilterCriteria(columnPosition) Filter معیارهای فیلتر را از ستون مشخص شده حذف می کند.
setColumnFilterCriteria(columnPosition, filterCriteria) Filter معیارهای فیلتر را روی ستون مشخص شده تنظیم می کند.
sort(columnPosition, ascending) Filter محدوده فیلتر شده را بر اساس ستون مشخص شده، به استثنای ردیف اول (ردیف سرصفحه) در محدوده ای که این فیلتر روی آن اعمال می شود، مرتب می کند.

مستندات دقیق

getColumnFilterCriteria(columnPosition)

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

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

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

پارامترها

نام تایپ کنید توضیحات
columnPosition Integer موقعیت 1-نمایه شده ستون. به عنوان مثال، شاخص ستون B 2 است.

بازگشت

FilterCriteria - معیارهای فیلتر.

مجوز

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

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

getRange()

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

// Gets the existing filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let 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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.remove();

مجوز

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

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

removeColumnFilterCriteria(columnPosition)

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

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

پارامترها

نام تایپ کنید توضیحات
columnPosition Integer موقعیت 1-نمایه شده ستون. به عنوان مثال، شاخص ستون B 2 است.

بازگشت

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

مجوز

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

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

setColumnFilterCriteria(columnPosition, filterCriteria)

معیارهای فیلتر را روی ستون مشخص شده تنظیم می کند. ابتدا سازنده معیارهای فیلتر را با استفاده از SpreadsheetApp.newFilterCriteria() ایجاد کنید. سپس با استفاده از کلاس FilterCriteriaBuilder معیارهایی را به سازنده اضافه کنید. بعد از اینکه معیارهای خود را ساختید، آن را به عنوان پارامتر filterCriteria برای این روش تنظیم کنید.

let ss = SpreadsheetApp.getActiveSheet();
let 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);

پارامترها

نام تایپ کنید توضیحات
columnPosition Integer موقعیت 1-نمایه شده ستون. به عنوان مثال، شاخص ستون B 2 است.
filterCriteria FilterCriteria معیارهای فیلتر برای تنظیم اگر معیار را روی null قرار دهید، معیارهای فیلتر را از ستون مشخص شده حذف می کند. همچنین می توانید از removeColumnFilterCriteria(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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.sort(2, true);

پارامترها

نام تایپ کنید توضیحات
columnPosition Integer موقعیت 1-نمایه شده ستون. به عنوان مثال، شاخص ستون B 2 است.
ascending Boolean اگر true ، محدوده فیلتر شده را به ترتیب صعودی مرتب می کند. اگر false ، محدوده فیلتر شده را به ترتیب نزولی مرتب می کند.

بازگشت

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

مجوز

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

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