Class Slicer

篩選器控制項

代表篩選器器,用於以非協作方式篩選範圍、圖表和資料透視表。這個類別包含存取及修改現有配量器的方法。如要建立新的篩選器控制項,請使用 Sheet.insertSlicer(range, anchorRowPos, anchorColPos)

方法

方法傳回類型簡短說明
getBackgroundColorObject()Color傳回篩選器控制項的背景 Color
getColumnPosition()Integer傳回在篩選器器中套用篩選器的資料欄位置 (相對於篩選器器的資料範圍);如未設定資料欄位置,會傳回 null
getContainerInfo()ContainerInfo取得篩選器控制項在工作表中的位置相關資訊。
getFilterCriteria()FilterCriteria傳回篩選器控制項的篩選條件;如未設定篩選條件,則傳回 null
getRange()Range取得要套用篩選器控制項的資料範圍。
getTitle()String傳回篩選器控制項的標題。
getTitleHorizontalAlignment()String取得標題的水平對齊方式。
getTitleTextStyle()TextStyle傳回篩選器控制項標題的文字樣式。
isAppliedToPivotTables()Boolean傳回是否要將指定的篩選器控制項套用至資料透視表。
remove()void刪除篩選器控制項。
setApplyToPivotTables(applyToPivotTables)Slicer設定是否要將指定篩選器控制項套用至工作表中的資料透視表。
setBackgroundColor(color)Slicer設定篩選器控制項的背景顏色。
setBackgroundColorObject(color)Slicer設定篩選器控制項的背景 Color
setColumnFilterCriteria(columnPosition, filterCriteria)Slicer設定篩選器控制項的欄索引和篩選條件。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)Slicer設定篩選器控制項在工作表上的顯示位置。
setRange(rangeApi)Slicer設定要套用篩選器控制項的資料範圍。
setTitle(title)Slicer設定篩選器控制項的標題。
setTitleHorizontalAlignment(horizontalAlignment)Slicer設定篩選器控制項中標題的水平對齊方式。
setTitleTextStyle(textStyle)Slicer設定篩選器控制項的文字樣式。

內容詳盡的說明文件

getBackgroundColorObject()

傳回篩選器控制項的背景 Color

回攻員

Color — 這個篩選器控制項的背景顏色。如果沒有設定顏色,則傳回 null

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

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()

取得要套用篩選器控制項的資料範圍。

回攻員

Range — 篩選器控制項範圍。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

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()

傳回篩選器控制項標題的文字樣式。

回攻員

TextStyle — 這個篩選器控制項標題的文字樣式。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

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)

設定是否要將指定篩選器控制項套用至工作表中的資料透視表。

參數

名稱類型說明
applyToPivotTablesBoolean指定是否要將這個篩選器控制項套用至資料透視表。

回攻員

Slicer — 這個篩選器控制項,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

setBackgroundColor(color)

設定篩選器控制項的背景顏色。null 值會重設背景顏色。

參數

名稱類型說明
colorString這個篩選器控制項在 CSS 標記法 (例如「#ffffff」) 中的新背景顏色。

回攻員

Slicer — 這個篩選器控制項,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

setBackgroundColorObject(color)

設定篩選器控制項的背景 Colornull 值會重設背景顏色。

參數

名稱類型說明
colorColor這個篩選器控制項的新背景顏色。

回攻員

Slicer — 這個篩選器控制項,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

setColumnFilterCriteria(columnPosition, filterCriteria)

設定篩選器控制項的欄索引和篩選條件。null 值會重設篩選器控制項篩選器。

參數

名稱類型說明
columnPositionInteger這個篩選器控制項的新資料欄位置。
filterCriteriaFilterCriteria這個篩選器控制項的新篩選條件。

回攻員

Slicer — 這個篩選器控制項,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

設定篩選器控制項在工作表上的顯示位置。錨定列和欄位置索引會編入索引。

參數

名稱類型說明
anchorRowPosInteger篩選器控制項的頂端會固定在這個列中。
anchorColPosInteger在這個顏色中,篩選器控制項的頂部會固定於該欄。
offsetXInteger與儲存格角落的水平偏移 (以像素為單位)。
offsetYInteger與儲存格角落的垂直偏移 (以像素為單位)。

回攻員

Slicer — 這個篩選器控制項,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

setRange(rangeApi)

設定要套用篩選器控制項的資料範圍。

參數

名稱類型說明
rangeApiRange這個篩選器控制項的新範圍。

回攻員

Slicer — 這個篩選器控制項,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

setTitle(title)

設定篩選器控制項的標題。如果標題空白,系統會將標題重設為預設值。

參數

名稱類型說明
titleString這個篩選器控制項的新標題。

回攻員

Slicer — 這個篩選器控制項,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

setTitleHorizontalAlignment(horizontalAlignment)

設定篩選器控制項中標題的水平對齊方式。null 值會重設對齊。

參數

名稱類型說明
horizontalAlignmentString這個篩選器控制項標題的新水平對齊方式。

回攻員

Slicer — 這個篩選器控制項,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

setTitleTextStyle(textStyle)

設定篩選器控制項的文字樣式。

參數

名稱類型說明
textStyleTextStyle篩選器控制項標題的新文字樣式。

回攻員

Slicer — 這個篩選器控制項,用於鏈結。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權:

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

已淘汰的方法