代表篩選器器,用於以非協作方式篩選範圍、圖表和資料透視表。這個類別包含存取及修改現有配量器的方法。如要建立新的篩選器控制項,請使用 Sheet.insertSlicer(range, anchorRowPos, anchorColPos)
。
方法
內容詳盡的說明文件
getBackgroundColorObject()
getColumnPosition()
傳回在篩選器器中套用篩選器的資料欄位置 (相對於篩選器器的資料範圍);如未設定資料欄位置,會傳回 null
。這個位置應為資料欄的 1 索引位置,類似於篩選器。
回攻員
Integer
— 這個篩選器控制項的資料欄位置。
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getContainerInfo()
取得篩選器控制項在工作表中的位置相關資訊。
回攻員
ContainerInfo
:包含篩選器控制項容器位置的物件。
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilterCriteria()
傳回篩選器控制項的篩選條件;如未設定篩選條件,則傳回 null
。
回攻員
FilterCriteria
:這個篩選器控制項的篩選條件。
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange()
getTitle()
傳回篩選器控制項的標題。
回攻員
String
— 這個篩選器控制項,用於鏈結。
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTitleHorizontalAlignment()
取得標題的水平對齊方式。
回攻員
String
:這個篩選器控制項標題的水平對齊方式。
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTitleTextStyle()
isAppliedToPivotTables()
傳回是否要將指定的篩選器控制項套用至資料透視表。
回攻員
Boolean
— 如果這個篩選器控制項套用至資料透視表,則設為 true
,否則為 false
。
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
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
setApplyToPivotTables(applyToPivotTables)
setBackgroundColor(color)
setBackgroundColorObject(color)
setColumnFilterCriteria(columnPosition, filterCriteria)
設定篩選器控制項的欄索引和篩選條件。null
值會重設篩選器控制項篩選器。
參數
名稱 | 類型 | 說明 |
---|---|---|
columnPosition | Integer | 這個篩選器控制項的新資料欄位置。 |
filterCriteria | FilterCriteria | 這個篩選器控制項的新篩選條件。 |
回攻員
Slicer
— 這個篩選器控制項,用於鏈結。
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
設定篩選器控制項在工作表上的顯示位置。錨定列和欄位置索引會編入索引。
參數
名稱 | 類型 | 說明 |
---|---|---|
anchorRowPos | Integer | 篩選器控制項的頂端會固定在這個列中。 |
anchorColPos | Integer | 在這個顏色中,篩選器控制項的頂部會固定於該欄。 |
offsetX | Integer | 與儲存格角落的水平偏移 (以像素為單位)。 |
offsetY | Integer | 與儲存格角落的垂直偏移 (以像素為單位)。 |
回攻員
Slicer
— 這個篩選器控制項,用於鏈結。
授權
使用這個方法的指令碼必須取得以下一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets