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傳回 Slice' 標題的文字樣式。
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

Return 鍵

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

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getColumnPosition()

傳回在篩選器控制項中套用篩選器的欄位置 (相對於篩選器控制項的資料範圍),如未傳回資料欄位置,則傳回「null」。這應該會是資料欄的 1 索引位置,與篩選器類似。

Return 鍵

Integer:這個篩選器控制項的欄位置,

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getContainerInfo()

取得篩選器控制項在工作表中的位置。

Return 鍵

ContainerInfo — 包含 Slice' 容器位置的物件。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getFilterCriteria()

傳回篩選器控制項的篩選條件,如未設定篩選條件,則傳回 null

Return 鍵

FilterCriteria:這個篩選器控制項的篩選條件。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getRange()

取得套用篩選器的資料類型。

Return 鍵

Range — 篩選器控制項範圍。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getTitle()

傳回篩選器控制項的標題。

Return 鍵

String — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getTitleHorizontalAlignment()

取得標題的水平對齊方式。

Return 鍵

String:這個篩選器控制項標題的水平對齊。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getTitleTextStyle()

傳回 Slice' 標題的文字樣式。

Return 鍵

TextStyle:這個篩選器控制項的文字格式。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

isAppliedToPivotTables()

傳回是否套用資料透視表的指定篩選器控制項。

Return 鍵

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指定這個滑桿是否應套用至資料透視表。

Return 鍵

Slicer — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setBackgroundColor(color)

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

參數

名稱類型說明
colorString這個區塊控制項在 CSS 標記法中的新背景顏色 (例如 '#ffffff')。

Return 鍵

Slicer — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setBackgroundColorObject(color)

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

參數

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

Return 鍵

Slicer — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setColumnFilterCriteria(columnPosition, filterCriteria)

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

參數

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

Return 鍵

Slicer — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

設定篩選器控制項在工作表上的位置。錨點列和欄位置索引是 1 的索引。

參數

名稱類型說明
anchorRowPosInteger篩選器控制項的上方會固定在此列中。
anchorColPosInteger篩選器工具的上方有錨點。
offsetXInteger儲存格角落的水平偏移量 (以像素為單位)。
offsetYInteger儲存格角落的垂直偏移量 (以像素為單位)。

Return 鍵

Slicer — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setRange(rangeApi)

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

參數

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

Return 鍵

Slicer — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setTitle(title)

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

參數

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

Return 鍵

Slicer — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setTitleHorizontalAlignment(horizontalAlignment)

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

參數

名稱類型說明
horizontalAlignmentString這個滑桿控制項的標題新水平對齊。

Return 鍵

Slicer — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setTitleTextStyle(textStyle)

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

參數

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

Return 鍵

Slicer — 此區塊控制項,用於鏈結。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

已淘汰的方法