Class DataSourceSheetFilter
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
فیلتر برگه منبع داده به فیلتر برگه منبع داده موجود دسترسی داشته باشید و آن را اصلاح کنید. برای ایجاد یک فیلتر برگه منبع داده جدید، از Data Source Sheet.addFilter(columnName, filterCriteria) استفاده کنید.
از این کلاس فقط با داده هایی استفاده کنید که به پایگاه داده متصل هستند.
مستندات دقیق
get Data Source Column()
ستون منبع داده را برمی‌گرداند که این فیلتر روی آن اعمال می‌شود.
بازگشت
Data Source Column - ستون منبع داده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Data Source Sheet()
Data Source Sheet را که این فیلتر به آن تعلق دارد، برمی گرداند.
بازگشت
Data Source Sheet - برگه منبع داده که این فیلتر به آن تعلق دارد.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Filter Criteria()
معیارهای فیلتر را برای این فیلتر برمی گرداند.
بازگشت
Filter Criteria - معیارهای فیلتر برای این فیلتر.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
remove()
این فیلتر را از شی منبع داده حذف می کند.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Filter Criteria(filterCriteria)
معیارهای فیلتر را برای این فیلتر تنظیم می کند.
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
filter Criteria | Filter Criteria | معیارهای فیلتر برای تنظیم |
بازگشت
Data Source Sheet Filter - فیلتر برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003e\u003ccode\u003eDataSourceSheetFilter\u003c/code\u003e allows you to access and modify existing filters applied to data source sheets connected to databases.\u003c/p\u003e\n"],["\u003cp\u003eYou can get information about the filter, such as the column it applies to, the sheet it belongs to, and its criteria.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to remove the filter and to set new filter criteria.\u003c/p\u003e\n"],["\u003cp\u003eThis class is exclusively for data connected to a database and is not intended for regular spreadsheet data.\u003c/p\u003e\n"],["\u003cp\u003eAll methods within \u003ccode\u003eDataSourceSheetFilter\u003c/code\u003e require authorization with specific scopes related to spreadsheet access.\u003c/p\u003e\n"]]],["`DataSourceSheetFilter` allows interaction with existing filters on database-connected data. Key actions include: retrieving the associated data source column, sheet, and filter criteria using `getDataSourceColumn()`, `getDataSourceSheet()`, and `getFilterCriteria()`, respectively. Filters can be removed with `remove()` or modified using `setFilterCriteria()`. Creating new filters requires `DataSourceSheet.addFilter`. All methods necessitate specific authorization scopes related to spreadsheets.\n"],null,["# Class DataSourceSheetFilter\n\nDataSourceSheetFilter\n\nAccess and modify an existing data source sheet filter. To create a new data source sheet filter,\nuse [DataSourceSheet.addFilter(columnName, filterCriteria)](/apps-script/reference/spreadsheet/data-source-sheet#addFilter(String,FilterCriteria)).\n\n\n**Only use this class with data that's connected to a database.** \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|\n| [getDataSourceColumn()](#getDataSourceColumn()) | [DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) | Returns the data source column this filter applies to. |\n| [getDataSourceSheet()](#getDataSourceSheet()) | [DataSourceSheet](/apps-script/reference/spreadsheet/data-source-sheet) | Returns the [DataSourceSheet](/apps-script/reference/spreadsheet/data-source-sheet) that this filter belongs to. |\n| [getFilterCriteria()](#getFilterCriteria()) | [FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) | Returns the filter criteria for this filter. |\n| [remove()](#remove()) | `void` | Removes this filter from the data source object. |\n| [setFilterCriteria(filterCriteria)](#setFilterCriteria(FilterCriteria)) | [DataSourceSheetFilter](#) | Sets the filter criteria for this filter. |\n\nDetailed documentation\n----------------------\n\n### `get``Data``Source``Column()`\n\nReturns the data source column this filter applies to.\n\n#### Return\n\n\n[DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) --- The data source column.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Data``Source``Sheet()`\n\nReturns the [DataSourceSheet](/apps-script/reference/spreadsheet/data-source-sheet) that this filter belongs to.\n\n#### Return\n\n\n[DataSourceSheet](/apps-script/reference/spreadsheet/data-source-sheet) --- The data source sheet, to which this filter belongs.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Filter``Criteria()`\n\nReturns the filter criteria for this filter.\n\n#### Return\n\n\n[FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) --- The filter criteria for this filter.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `remove()`\n\nRemoves this filter from the data source object.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `set``Filter``Criteria(filterCriteria)`\n\nSets the filter criteria for this filter.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------------|----------------------------------------------------------------------|-----------------------------|\n| `filter``Criteria` | [FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) | The filter criteria to set. |\n\n#### Return\n\n\n[DataSourceSheetFilter](#) --- The filter for chaining.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`"]]
