Class Slicer

Slicer

表示切片器，用于以非协作方式过滤范围、图表和数据透视表。此类包含用于访问和修改现有切片器的方法。如需创建新的切片器，请使用 Sheet.insertSlicer(range, anchorRowPos, anchorColPos)。

方法

方法	返回类型	简介
getBackgroundColorObject()	Color	返回 Slicer 的背景 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	设置 Slicer 的背景 Color。
setColumnFilterCriteria(columnPosition, filterCriteria)	Slicer	设置分屏的列编号和过滤条件。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	Slicer	设置分屏器在工作表中的显示位置。
setRange(rangeApi)	Slicer	设置要应用切片器的数据范围。
setTitle(title)	Slicer	设置分屏标题。
setTitleHorizontalAlignment(horizontalAlignment)	Slicer	设置分屏中的标题的水平对齐方式。
setTitleTextStyle(textStyle)	Slicer	设置分屏的文字样式。

已弃用的方法

方法	返回类型	简介
getBackgroundColor()	String	以 CSS 表示法（例如“#ffffff”）返回 Slicer 的背景颜色。

详细文档

getBackgroundColorObject()

返回 Slicer 的背景 Color。

返回

Color - 此 Slicer 的背景颜色。如果未设置任何颜色，则返回 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 - 一个包含 Slicer 的容器位置的对象。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• 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 - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

设置是否应将给定分屏器应用于工作表中的数据透视表。

参数

名称	类型	说明
applyToPivotTables	Boolean	指定此切片器是否应应用于数据透视表。

返回

Slicer - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

setBackgroundColor(color)

设置分屏的背景颜色。null 值会重置背景颜色。

参数

名称	类型	说明
color	String	此切片器的新背景颜色（采用 CSS 表示法，例如“#ffffff”）。

返回

Slicer - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

setBackgroundColorObject(color)

设置 Slicer 的背景 Color。null 值会重置背景颜色。

参数

名称	类型	说明
color	Color	此 Slicer 的新背景颜色。

返回

Slicer - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

setColumnFilterCriteria(columnPosition, filterCriteria)

设置 Slicer 的列编号和过滤条件。null 值会重置 Slicer 过滤器。

参数

名称	类型	说明
columnPosition	Integer	此切片器的新列位置。
filterCriteria	FilterCriteria	此 Slicer 的新过滤条件。

返回

Slicer - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

设置分屏器在工作表中的显示位置。锚点行和列位置索引从 1 开始编号。

参数

名称	类型	说明
anchorRowPos	Integer	分屏器的顶部会固定在此行中。
anchorColPos	Integer	分屏的顶部会固定在此列中。
offsetX	Integer	相对于单元格角的水平偏移量（以像素为单位）。
offsetY	Integer	相对于单元格角的垂直偏移量（以像素为单位）。

返回

Slicer - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

setRange(rangeApi)

设置要应用切片器的数据范围。

参数

名称	类型	说明
rangeApi	Range	此切片器的新范围。

返回

Slicer - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

setTitle(title)

设置分屏标题。如果标题为空，系统会将标题重置为默认值。

参数

名称	类型	说明
title	String	此切片器的新标题。

返回

Slicer - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

setTitleHorizontalAlignment(horizontalAlignment)

设置分屏中的标题的水平对齐方式。null 值会重置对齐方式。

参数

名称	类型	说明
horizontalAlignment	String	此 Slicer 标题的新水平对齐方式。

返回

Slicer - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

setTitleTextStyle(textStyle)

设置分屏的文字样式。

参数

名称	类型	说明
textStyle	TextStyle	切片标题的新文本样式。

返回

Slicer - 此 Slicer，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

已弃用的方法

getBackgroundColor()

已弃用。已替换为 getBackgroundColorObject()

以 CSS 表示法（例如“#ffffff”）返回 Slicer 的背景颜色。

返回

String - 此 Slicer 的背景颜色。如果未设置任何颜色，则返回 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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