Excel.SlicerCollection class

  • 参考
包:
excel

表示工作簿或工作表中所有切片器对象的集合。

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.10 ]

属性

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
items

获取此集合中已加载的子项。

方法

add(slicerSource, sourceField, slicerDestination)

将新切片器添加到工作簿。
getCount()

返回集合中的切片器数量。
getItem(key)

使用其名称或 ID 获取切片器对象。
getItemAt(index)

根据其在集合中的位置获取切片器。
getItemOrNullObject(key)

使用切片器的名称或 ID 获取切片器。 如果切片器不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.SlicerCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.SlicerCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

items

获取此集合中已加载的子项。

readonly items: Excel.Slicer[];

属性值

Excel.Slicer[]

方法详细信息

add(slicerSource, sourceField, slicerDestination)

将新切片器添加到工作簿。

add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet): Excel.Slicer;

参数

slicerSource

string | Excel.PivotTable | Excel.Table

新切片器将基于的数据源。 它可以是 PivotTable 对象、 Table 对象或字符串。 传递数据透视表对象时，数据源是该 PivotTable 对象的源。 Table传递对象时，数据源为 Table 对象。 传递字符串时，它将解释为数据透视表或表的名称或 ID。

sourceField

string | Excel.PivotField | number | Excel.TableColumn

数据源中要筛选的字段。 它可以是 对象、TableColumn对象、的 PivotField ID 或 的名称或 IDTableColumn。PivotField

slicerDestination

string | Excel.Worksheet

可选。 将在其中创建新切片器的工作表。 它可以是 Worksheet 对象，也可以是工作表的名称或 ID。 如果从工作表检索切片器集合，则可以省略此参数。

返回

Excel.Slicer

新的切片器。

注解

[ API 集：ExcelApi 1.10 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Pivot");
    const slicer = sheet.slicers.add(
        "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
        "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
    );
    slicer.name = "Fruit Slicer";
    await context.sync();
});

getCount()

返回集合中的切片器数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

[ API 集：ExcelApi 1.10 ]

getItem(key)

使用其名称或 ID 获取切片器对象。

getItem(key: string): Excel.Slicer;

参数

key

string

切片器的名称或 ID。

返回

Excel.Slicer

注解

[ API 集：ExcelApi 1.10 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.caption = "Fruit Types";
    slicer.left = 395;
    slicer.top = 15;
    slicer.height = 135;
    slicer.width = 150;
    await context.sync();
});

getItemAt(index)

根据其在集合中的位置获取切片器。

getItemAt(index: number): Excel.Slicer;

参数

index

number

要检索的对象的索引值。 从零开始编制索引。

返回

Excel.Slicer

注解

[ API 集：ExcelApi 1.10 ]

getItemOrNullObject(key)

使用切片器的名称或 ID 获取切片器。 如果切片器不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(key: string): Excel.Slicer;

参数

key

string

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

返回

Excel.Slicer

注解

[ API 集：ExcelApi 1.10 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection;

参数

options

Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

提供要加载对象的属性的选项。

返回

Excel.SlicerCollection

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.SlicerCollection;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.SlicerCollection

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerCollection;

参数

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.SlicerCollection

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.SlicerCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.SlicerCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

toJSON(): Excel.Interfaces.SlicerCollectionData;

返回

Excel.Interfaces.SlicerCollectionData