Excel.PivotTableStyleCollection class
表示数据透视表样式的集合。
方法
| add(name, make |
创建具有指定名称的空白。 |
| get |
获取集合中 PivotTable 的数量。 |
| get |
获取父对象作用域的默认数据透视表样式。 |
| get |
按名称获取 |
| get |
按名称获取 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set |
设置要在父对象作用域中使用的默认数据透视表样式。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
items
方法详细信息
add(name, makeUniqueName)
创建具有指定名称的空白。PivotTableStyle
add(name: string, makeUniqueName?: boolean): Excel.PivotTableStyle;参数
- name
-
string
新数据透视表样式的唯一名称。 如果该名称已在使用中，将引发 InvalidArgument 错误。
- makeUniqueName
-
boolean
可选。 默认为 false. 如果 true，将在需要时将数字附加到名称中，以使其唯一。
返回
新创建 PivotTableStyle的 .
注解
getCount()
获取集合中 PivotTable 的数量。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getDefault()
获取父对象作用域的默认数据透视表样式。
getDefault(): Excel.PivotTableStyle;返回
PivotTableStyle当前默认数据透视表样式的对象。
注解
getItem(name)
按名称获取 PivotTableStyle 。
getItem(name: string): Excel.PivotTableStyle;参数
- name
-
string
要检索的数据透视表样式的名称。
返回
PivotTableStyle名称与输入匹配的对象。
注解
getItemOrNullObject(name)
按名称获取 PivotTableStyle 。 如果不 PivotTableStyle 存在，则此方法返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(name: string): Excel.PivotTableStyle;参数
- name
-
string
要检索的数据透视表样式的名称。
返回
PivotTableStyle名称与输入匹配的对象。
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection;参数
- options
-
Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.PivotTableStyleCollection;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableStyleCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
setDefault(newDefaultStyle)
设置要在父对象作用域中使用的默认数据透视表样式。
setDefault(newDefaultStyle: PivotTableStyle | string): void;参数
- newDefaultStyle
-
Excel.PivotTableStyle | string
PivotTableStyle应为新的默认值的对象或对象名称PivotTableStyle。
返回
void
注解
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.PivotTableStyleCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.PivotTableStyleCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): Excel.Interfaces.PivotTableStyleCollectionData;