Excel.PivotTableCollection class
表示属于工作簿或工作表的所有 PivotTable 对象的集合。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| items | 获取此集合中已加载的子项。 |
方法
| add(name, source, destination) | 根据指定的源数据添加数据透视表，并将其插入目标区域的左上角单元格。 |
| get |
获取集合中的数据透视表的数量。 |
| get |
按名称获取 PivotTable 对象。 |
| get |
按名称获取 PivotTable 对象。 如果数据透视表不存在，则此方法返回对象，其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| refresh |
刷新集合中的所有数据透视表。 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
items
方法详细信息
add(name, source, destination)
根据指定的源数据添加数据透视表，并将其插入目标区域的左上角单元格。
add(name: string, source: Range | string | Table, destination: Range | string): Excel.PivotTable;参数
- name
-
string
新数据透视表的名称。
- source
-
Excel.Range | string | Excel.Table
新数据透视表的源数据可以是区域 (，也可以是字符串地址，包括工作表名称) 或表格。
- destination
-
Excel.Range | string
数据透视表目标区域（工作表中用于放置所生成的报表的区域）左上角的单元格。
返回
返回新插入的数据透视表。
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
await Excel.run(async (context) => {
const rangeToAnalyze = context.workbook.worksheets.getItem("Data").getRange("A1:E21");
const rangeToPlacePivot = context.workbook.worksheets.getItem("Pivot").getRange("A2");
context.workbook.worksheets.getItem("Pivot").pivotTables.add("Farm Sales", rangeToAnalyze, rangeToPlacePivot);
await context.sync();
});
getCount()
获取集合中的数据透视表的数量。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItem(name)
按名称获取 PivotTable 对象。
getItem(name: string): Excel.PivotTable;参数
- name
-
string
要检索的数据透视表的名称。
返回
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml
// This function refreshes the "Farm Sales" PivotTable,
// which updates the PivotTable with changes made to the source table.
await Excel.run(async (context) => {
const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
pivotTable.refresh();
await context.sync();
});
getItemOrNullObject(name)
按名称获取 PivotTable 对象。 如果数据透视表不存在，则此方法返回对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(name: string): Excel.PivotTable;参数
- name
-
string
要检索的数据透视表的名称。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.PivotTableCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
refreshAll()
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.PivotTableCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.PivotTableCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Excel.Interfaces.PivotTableCollectionData;