Excel.SlicerCollection class
表示工作簿或工作表中所有切片器对象的集合。
方法
| add(slicer |
将新切片器添加到工作簿。 |
| get |
返回集合中的切片器数量。 |
| get |
使用切片器对象的名称或 ID 获取切片器对象。 |
| get |
根据其在集合中的位置获取切片器。 |
| get |
使用切片器的名称或 ID 获取切片器。 如果切片器不存在，则此方法将返回其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
items
方法详细信息
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
要作为筛选依据的数据源中的字段。 它可以是 PivotField 对象、 TableColumn 对象、 的 ID PivotField 或 的 TableColumn名称或 ID。
- slicerDestination
-
string | Excel.Worksheet
可选。 将在其中创建新切片器的工作表。 它可以是对象，也可以是 Worksheet 工作表的名称或 ID。 如果从工作表中检索切片器集合，则可以忽略此参数。
返回
新切片器。
注解
示例
// 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>
注解
getItem(key)
使用切片器对象的名称或 ID 获取切片器对象。
getItem(key: string): Excel.Slicer;参数
- key
-
string
切片器的名称或 ID。
返回
注解
示例
// 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
要检索的对象的索引值。 从零开始编制索引。
返回
注解
getItemOrNullObject(key)
使用切片器的名称或 ID 获取切片器。 如果切片器不存在，则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(key: string): Excel.Slicer;参数
- key
-
string
要检索的切片器的名称或 ID。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.SlicerCollection;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.SlicerCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.SlicerCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): Excel.Interfaces.SlicerCollectionData;