表示切片器,用于以非协作方式过滤范围、图表和数据透视表。此类包含用于访问和修改现有切片器的方法。如需创建新的切片器,请使用 Sheet.insertSlicer(range, anchorRowPos, anchorColPos)
。
方法
方法 | 返回类型 | 简介 |
---|---|---|
get | Color | 返回 Slicer 的背景 Color 。 |
get | Integer | 返回在切片器中应用过滤器的列位置(相对于切片器的数据范围),如果未设置列位置,则返回 null 。 |
get | Container | 获取有关分屏器在工作表中的位置的信息。 |
get | Filter | 返回切片器的过滤条件;如果未设置过滤条件,则返回 null 。 |
get | Range | 获取应用切片器的数据范围。 |
get | String | 返回分屏标题。 |
get | String | 获取标题的水平对齐方式。 |
get | Text | 返回切片标题的文字样式。 |
is | Boolean | 返回是否已将给定切片器应用于数据透视表。 |
remove() | void | 删除分屏。 |
set | Slicer | 设置是否应将给定分屏器应用于工作表中的数据透视表。 |
set | Slicer | 设置分屏的背景颜色。 |
set | Slicer | 设置 Slicer 的背景 Color 。 |
set | Slicer | 设置分屏的列编号和过滤条件。 |
set | Slicer | 设置分屏器在工作表中的显示位置。 |
set | Slicer | 设置要应用切片器的数据范围。 |
set | Slicer | 设置分屏标题。 |
set | Slicer | 设置分屏中的标题的水平对齐方式。 |
set | Slicer | 设置分屏的文字样式。 |
已弃用的方法
方法 | 返回类型 | 简介 |
---|---|---|
| String | 以 CSS 表示法(例如“#ffffff”)返回 Slicer 的背景颜色。 |
详细文档
getBackgroundColorObject()
getColumnPosition()
返回在切片器中应用过滤器的列位置(相对于切片器的数据范围),如果未设置列位置,则返回 null
。这应是列的编号为 1 的位置,与过滤器类似。
返回
Integer
- 此切片器的列位置。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getContainerInfo()
获取有关分屏器在工作表中的位置的信息。
返回
Container
- 一个包含 Slicer 的容器位置的对象。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilterCriteria()
返回切片器的过滤条件;如果未设置过滤条件,则返回 null
。
返回
Filter
- 此切片器的过滤条件。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange()
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()
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)
设置 Slicer 的列编号和过滤条件。null
值会重置 Slicer 过滤器。
参数
名称 | 类型 | 说明 |
---|---|---|
column | Integer | 此切片器的新列位置。 |
filter | Filter | 此 Slicer 的新过滤条件。 |
返回
Slicer
- 此 Slicer,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
设置分屏器在工作表中的显示位置。锚点行和列位置索引从 1 开始编号。
参数
名称 | 类型 | 说明 |
---|---|---|
anchor | Integer | 分屏器的顶部会固定在此行中。 |
anchor | Integer | 分屏的顶部会固定在此列中。 |
offsetX | Integer | 相对于单元格角的水平偏移量(以像素为单位)。 |
offsetY | Integer | 相对于单元格角的垂直偏移量(以像素为单位)。 |
返回
Slicer
- 此 Slicer,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRange(rangeApi)
setTitle(title)
setTitleHorizontalAlignment(horizontalAlignment)
setTitleTextStyle(textStyle)
已弃用的方法
getBackgroundColor()
getBackgroundColor()
已弃用。已替换为 get
以 CSS 表示法(例如“#ffffff”)返回 Slicer 的背景颜色。
返回
String
- 此 Slicer 的背景颜色。如果未设置任何颜色,则返回 null
。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets