Excel.PivotTableScopedCollection class

包:

excel

表示数据透视表的作用域集合。 数据透视表根据数据透视表左上角的位置进行排序。 它们按从上到下然后从左到右排序。

扩展

OfficeExtension.ClientObject

注解

API 集：ExcelApi 1.12

使用方

• Excel.Range： getPivotTables

属性

context	与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
items	获取此集合中已加载的子项。

方法

getCount()	获取集合中的数据透视表数。
getFirst()	获取集合中的第一个数据透视表。 集合中的数据透视表按从上到下和从左到右排序，这样左上角的表就是集合中的第一个数据透视表。
getFirstOrNullObject()	获取集合中的第一个数据透视表。 集合中的数据透视表按从上到下和从左到右排序，以便左上角的表是集合中的第一个数据透视表。 如果集合为空，则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItem(key)	按名称获取 PivotTable 对象。
getItemOrNullObject(name)	按名称获取 PivotTable 对象。 如果数据透视表不存在，则此方法将返回其 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.PivotTableScopedCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.PivotTableScopedCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

items

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

readonly items: Excel.PivotTable[];

属性值

Excel.PivotTable[]

方法详细信息

getCount()

获取集合中的数据透视表数。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

API 集：ExcelApi 1.12

getFirst()

获取集合中的第一个数据透视表。 集合中的数据透视表按从上到下和从左到右排序，这样左上角的表就是集合中的第一个数据透视表。

getFirst(): Excel.PivotTable;

返回

Excel.PivotTable

注解

API 集：ExcelApi 1.12

getFirstOrNullObject()

获取集合中的第一个数据透视表。 集合中的数据透视表按从上到下和从左到右排序，以便左上角的表是集合中的第一个数据透视表。 如果集合为空，则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getFirstOrNullObject(): Excel.PivotTable;

返回

Excel.PivotTable

注解

API 集：ExcelApi 1.15

getItem(key)

按名称获取 PivotTable 对象。

getItem(key: string): Excel.PivotTable;

参数

key

string

要检索的数据透视表的名称。

返回

Excel.PivotTable

注解

API 集：ExcelApi 1.12

getItemOrNullObject(name)

按名称获取 PivotTable 对象。 如果数据透视表不存在，则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(name: string): Excel.PivotTable;

参数

name

string

要检索的数据透视表的名称。

返回

Excel.PivotTable

注解

API 集：ExcelApi 1.12

load(options)

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

load(options?: Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableScopedCollection;

参数

options

Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返回

Excel.PivotTableScopedCollection

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.PivotTableScopedCollection

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

OfficeExtension.LoadOption

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

返回

Excel.PivotTableScopedCollection

toJSON()

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

toJSON(): Excel.Interfaces.PivotTableScopedCollectionData;

返回

Excel.Interfaces.PivotTableScopedCollectionData