ExcelScript.Slicer interface

包:

ExcelScript

表示 Slicer 工作簿中的 对象。

注解

示例

/**
 * This script adds a slicer for an existing PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
    farmPivot, /* The table or PivotTale to be sliced. */
    farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  fruitSlicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  fruitSlicer.setLeft(400);
}

方法

clearFilters()	清除当前切片器上应用的所有筛选器。
delete()	删除切片器。
getCaption()	表示切片器的描述文字。
getHeight()	表示切片器的高度（以磅为单位）。 InvalidArgument使用负值或零作为输入进行设置时引发异常。
getId()	表示切片器的唯一 ID。
getIsFilterCleared()	true如果清除了切片器上当前应用的所有筛选器，则值为值。
getLeft()	表示从切片器左侧到工作表左侧的距离（以磅为单位）。 InvalidArgument将负值设置为输入时引发错误。
getName()	表示切片器的名称。
getSelectedItems()	返回所选项目密钥的数组。
getSlicerItem(key)	使用其键或名称获取切片器项。 如果切片器项不存在，则此方法返回 undefined。
getSlicerItems()	表示属于切片器的切片器项的集合。
getSortBy()	表示切片器中的项目的排序顺序。 可能的值为：“DataSourceOrder”、“Ascending”、“Descending”。
getStyle()	表示切片器样式的常量值。 可能的值为：“SlicerStyleLight1”到“SlicerStyleLight6”、“TableStyleOther1”到“TableStyleOther2”、“SlicerStyleDark1”到“SlicerStyleDark6”。 还可以指定工作簿中显示的用户定义的自定义样式。
getTop()	表示从切片器上边缘到工作表顶部的距离（以磅为单位）。 InvalidArgument将负值设置为输入时引发错误。
getWidth()	表示切片器的宽度（以磅为单位）。 InvalidArgument使用负值或零作为输入进行设置时引发错误。
getWorksheet()	表示包含切片器的工作表。
selectItems(items)	根据切片器项的键选择切片器项。 清除前面的选择。 如果数组为空，则默认选择所有项。
setCaption(caption)	表示切片器的描述文字。
setHeight(height)	表示切片器的高度（以磅为单位）。 InvalidArgument使用负值或零作为输入进行设置时引发异常。
setLeft(left)	表示从切片器左侧到工作表左侧的距离（以磅为单位）。 InvalidArgument将负值设置为输入时引发错误。
setName(name)	表示切片器的名称。
setSortBy(sortBy)	表示切片器中的项目的排序顺序。 可能的值为：“DataSourceOrder”、“Ascending”、“Descending”。
setStyle(style)	表示切片器样式的常量值。 可能的值为：“SlicerStyleLight1”到“SlicerStyleLight6”、“TableStyleOther1”到“TableStyleOther2”、“SlicerStyleDark1”到“SlicerStyleDark6”。 还可以指定工作簿中显示的用户定义的自定义样式。
setTop(top)	表示从切片器上边缘到工作表顶部的距离（以磅为单位）。 InvalidArgument将负值设置为输入时引发错误。
setWidth(width)	表示切片器的宽度（以磅为单位）。 InvalidArgument使用负值或零作为输入进行设置时引发错误。

方法详细信息

clearFilters()

清除当前切片器上应用的所有筛选器。

clearFilters(): void;

返回

void

delete()

删除切片器。

delete(): void;

返回

void

getCaption()

表示切片器的描述文字。

getCaption(): string;

返回

string

getHeight()

表示切片器的高度（以磅为单位）。 InvalidArgument使用负值或零作为输入进行设置时引发异常。

getHeight(): number;

返回

number

getId()

表示切片器的唯一 ID。

getId(): string;

返回

string

getIsFilterCleared()

true如果清除了切片器上当前应用的所有筛选器，则值为值。

getIsFilterCleared(): boolean;

返回

boolean

getLeft()

表示从切片器左侧到工作表左侧的距离（以磅为单位）。 InvalidArgument将负值设置为输入时引发错误。

getLeft(): number;

返回

number

getName()

表示切片器的名称。

getName(): string;

返回

string

getSelectedItems()

返回所选项目密钥的数组。

getSelectedItems(): string[];

返回

string[]

getSlicerItem(key)

使用其键或名称获取切片器项。 如果切片器项不存在，则此方法返回 undefined。

getSlicerItem(key: string): SlicerItem | undefined;

参数

key

string

要检索的切片器的键或名称。

返回

ExcelScript.SlicerItem | undefined

getSlicerItems()

表示属于切片器的切片器项的集合。

getSlicerItems(): SlicerItem[];

返回

ExcelScript.SlicerItem[]

getSortBy()

表示切片器中的项目的排序顺序。 可能的值为：“DataSourceOrder”、“Ascending”、“Descending”。

getSortBy(): SlicerSortType;

返回

ExcelScript.SlicerSortType

getStyle()

表示切片器样式的常量值。 可能的值为：“SlicerStyleLight1”到“SlicerStyleLight6”、“TableStyleOther1”到“TableStyleOther2”、“SlicerStyleDark1”到“SlicerStyleDark6”。 还可以指定工作簿中显示的用户定义的自定义样式。

getStyle(): string;

返回

string

getTop()

表示从切片器上边缘到工作表顶部的距离（以磅为单位）。 InvalidArgument将负值设置为输入时引发错误。

getTop(): number;

返回

number

getWidth()

表示切片器的宽度（以磅为单位）。 InvalidArgument使用负值或零作为输入进行设置时引发错误。

getWidth(): number;

返回

number

getWorksheet()

表示包含切片器的工作表。

getWorksheet(): Worksheet;

返回

ExcelScript.Worksheet

selectItems(items)

根据切片器项的键选择切片器项。 清除前面的选择。 如果数组为空，则默认选择所有项。

selectItems(items?: string[]): void;

参数

items

string[]

可选。 要选择的指定切片器项名称。

返回

void

setCaption(caption)

表示切片器的描述文字。

setCaption(caption: string): void;

参数

caption

string

返回

void

setHeight(height)

表示切片器的高度（以磅为单位）。 InvalidArgument使用负值或零作为输入进行设置时引发异常。

setHeight(height: number): void;

参数

height

number

返回

void

setLeft(left)

表示从切片器左侧到工作表左侧的距离（以磅为单位）。 InvalidArgument将负值设置为输入时引发错误。

setLeft(left: number): void;

参数

left

number

返回

void

setName(name)

表示切片器的名称。

setName(name: string): void;

参数

name

string

返回

void

setSortBy(sortBy)

表示切片器中的项目的排序顺序。 可能的值为：“DataSourceOrder”、“Ascending”、“Descending”。

setSortBy(sortBy: SlicerSortType): void;

参数

sortBy

ExcelScript.SlicerSortType

返回

void

setStyle(style)

表示切片器样式的常量值。 可能的值为：“SlicerStyleLight1”到“SlicerStyleLight6”、“TableStyleOther1”到“TableStyleOther2”、“SlicerStyleDark1”到“SlicerStyleDark6”。 还可以指定工作簿中显示的用户定义的自定义样式。

setStyle(style: string): void;

参数

style

string

返回

void

setTop(top)

表示从切片器上边缘到工作表顶部的距离（以磅为单位）。 InvalidArgument将负值设置为输入时引发错误。

setTop(top: number): void;

参数

top

number

返回

void

setWidth(width)

表示切片器的宽度（以磅为单位）。 InvalidArgument使用负值或零作为输入进行设置时引发错误。

setWidth(width: number): void;

参数

width

number

返回

void