Class Slicer

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)

設定切割器的背景 Color。null 值會重設背景顏色。

參數

名稱類型說明
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)

設定切片器在工作表上顯示的位置。錨定資料列和資料欄位置的索引為 1。

參數

名稱類型說明
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

已淘汰的方法