Excel.FilterPivotHierarchyCollection class
表示与数据透视表关联的 FilterPivotHierarchy 项的集合。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| items | 获取此集合中已加载的子项。 |
方法
| add(pivot |
将 PivotHierarchy 添加到当前轴。 如果行、列或筛选轴上的其他位置存在层次结构，则会将该层次结构从相应的位置移除。 |
| get |
获取集合中的透视层级结构的数量。 |
| get |
按名称或 ID 获取 FilterPivotHierarchy。 |
| get |
按名称获取 FilterPivotHierarchy。 如果 FilterPivotHierarchy 不存在，则此方法返回一个 对象，其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| remove(filter |
从当前轴删除 PivotHierarchy。 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
items
方法详细信息
add(pivotHierarchy)
将 PivotHierarchy 添加到当前轴。 如果行、列或筛选轴上的其他位置存在层次结构，则会将该层次结构从相应的位置移除。
add(pivotHierarchy: Excel.PivotHierarchy): Excel.FilterPivotHierarchy;参数
- pivotHierarchy
- Excel.PivotHierarchy
返回
注解
getCount()
获取集合中的透视层级结构的数量。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItem(name)
按名称或 ID 获取 FilterPivotHierarchy。
getItem(name: string): Excel.FilterPivotHierarchy;参数
- name
-
string
要检索的 FilterPivotHierarchy 的名称。
返回
注解
getItemOrNullObject(name)
按名称获取 FilterPivotHierarchy。 如果 FilterPivotHierarchy 不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(name: string): Excel.FilterPivotHierarchy;参数
- name
-
string
要检索的 FilterPivotHierarchy 的名称。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.FilterPivotHierarchyCollection;参数
- options
-
Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.FilterPivotHierarchyCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.FilterPivotHierarchyCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
remove(filterPivotHierarchy)
从当前轴删除 PivotHierarchy。
remove(filterPivotHierarchy: Excel.FilterPivotHierarchy): void;参数
- filterPivotHierarchy
- Excel.FilterPivotHierarchy
返回
void
注解
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.FilterPivotHierarchyCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.FilterPivotHierarchyCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Excel.Interfaces.FilterPivotHierarchyCollectionData;