Class PivotFilter
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
內容詳盡的說明文件
getFilterCriteria()
傳回這個樞紐篩選器的篩選條件。
回攻員
FilterCriteria
:這個樞紐篩選器的篩選條件。
授權
使用這個方法的指令碼需要一或多個下列範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getPivotTable()
傳回這個篩選器所屬的 PivotTable
。
回攻員
PivotTable
:這個篩選器所屬的資料透視表。
授權
使用這個方法的指令碼需要一或多個下列範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSourceDataColumn()
傳回這個篩選器所處理的來源資料欄數量。這些索引是以 1 為基準,舉例來說,如果這個篩選器套用至試算表 A 欄中的資料,這個方法會傳回「1」。
回攻員
Integer
:這個篩選器套用的來源資料欄數量。
授權
使用這個方法的指令碼需要一或多個下列範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSourceDataSourceColumn()
傳回篩選器運算的資料來源資料欄。如果資料透視表不是 {DataSourcePivotTableApi},則傳回 null
。
回攻員
DataSourceColumn
:篩選器運作的資料來源資料欄。
授權
使用這個方法的指令碼需要一或多個下列範圍的授權:
-
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
setFilterCriteria(filterCriteria)
設定這個樞紐篩選器的篩選條件。
參數
回攻員
PivotFilter
- 鏈結的樞紐篩選器。
授權
使用這個方法的指令碼需要一或多個下列範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-08-13 (世界標準時間)。
[null,null,["上次更新時間:2025-08-13 (世界標準時間)。"],[[["\u003cp\u003e\u003ccode\u003ePivotFilter\u003c/code\u003e objects provide methods to access and modify filters applied to pivot tables in Google Sheets.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve filter criteria, identify the associated pivot table and source data column, and remove the filter using dedicated methods.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esetFilterCriteria()\u003c/code\u003e method allows you to define specific filtering conditions for the pivot table data.\u003c/p\u003e\n"],["\u003cp\u003eThese methods require authorization with specific scopes to interact with Google Sheets data.\u003c/p\u003e\n"]]],[],null,["# Class PivotFilter\n\nPivotFilter\n\nAccess and modify pivot table filters. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|\n| [getFilterCriteria()](#getFilterCriteria()) | [FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) | Returns the filter criteria for this pivot filter. |\n| [getPivotTable()](#getPivotTable()) | [PivotTable](/apps-script/reference/spreadsheet/pivot-table) | Returns the [PivotTable](/apps-script/reference/spreadsheet/pivot-table) that this filter belongs to. |\n| [getSourceDataColumn()](#getSourceDataColumn()) | `Integer` | Returns the number of the source data column this filter operates on. |\n| [getSourceDataSourceColumn()](#getSourceDataSourceColumn()) | [DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) | Returns the data source column the filter operates on. |\n| [remove()](#remove()) | `void` | Removes this pivot filter from the pivot table. |\n| [setFilterCriteria(filterCriteria)](#setFilterCriteria(FilterCriteria)) | [PivotFilter](#) | Sets the filter criteria for this pivot filter. |\n\nDetailed documentation\n----------------------\n\n### `get``Filter``Criteria()`\n\nReturns the filter criteria for this pivot filter.\n\n#### Return\n\n\n[FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) --- The filter criteria for this pivot 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### `get``Pivot``Table()`\n\nReturns the [PivotTable](/apps-script/reference/spreadsheet/pivot-table) that this filter belongs to.\n\n#### Return\n\n\n[PivotTable](/apps-script/reference/spreadsheet/pivot-table) --- The pivot table this filter belongs to.\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``Source``Data``Column()`\n\nReturns the number of the source data column this filter operates on. These indices are\n1-based, for example if this filter applies to data in column A of the spreadsheet this method\nreturns \"1.\"\n\n#### Return\n\n\n`Integer` --- The number of the source data column this filter applies to.\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``Source``Data``Source``Column()`\n\nReturns the data source column the filter operates on. Returns `null` if the pivot table\nis not a {DataSourcePivotTableApi}.\n\n#### Return\n\n\n[DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) --- The data source column the filter operates on.\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 pivot filter from the pivot table.\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 pivot 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[PivotFilter](#) --- The pivot 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`"]]