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)

设置截剪器的背景 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

已废弃的方法