Excel.FilterPivotHierarchy class

包:

excel

表示 Excel FilterPivotHierarchy。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.8 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
enableMultipleFilterItems	确定是否允许多个筛选项。
fields	返回与 FilterPivotHierarchy 相关联的 PivotFields。
id	FilterPivotHierarchy 的 ID。
name	FilterPivotHierarchy 的名称。
position	FilterPivotHierarchy 的位置。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
setToDefault()	将 FilterPivotHierarchy 重置回其默认值。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 而原始 Excel.FilterPivotHierarchy 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.FilterPivotHierarchyData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

enableMultipleFilterItems

确定是否允许多个筛选项。

enableMultipleFilterItems: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.8 ]

fields

返回与 FilterPivotHierarchy 相关联的 PivotFields。

readonly fields: Excel.PivotFieldCollection;

属性值

Excel.PivotFieldCollection

注解

[ API 集：ExcelApi 1.8 ]

id

FilterPivotHierarchy 的 ID。

readonly id: string;

属性值

string

注解

[ API 集：ExcelApi 1.8 ]

name

FilterPivotHierarchy 的名称。

name: string;

属性值

string

注解

[ API 集：ExcelApi 1.8 ]

position

FilterPivotHierarchy 的位置。

position: number;

属性值

number

注解

[ API 集：ExcelApi 1.8 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy;

参数

options

Excel.Interfaces.FilterPivotHierarchyLoadOptions

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

返回

Excel.FilterPivotHierarchy

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.FilterPivotHierarchy

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.FilterPivotHierarchy;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

返回

Excel.FilterPivotHierarchy

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.FilterPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties

Excel.Interfaces.FilterPivotHierarchyUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options

OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.FilterPivotHierarchy): void;

参数

properties

Excel.FilterPivotHierarchy

返回

void

setToDefault()

将 FilterPivotHierarchy 重置回其默认值。

setToDefault(): void;

返回

void

注解

[ API 集：ExcelApi 1.8 ]

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 而原始 Excel.FilterPivotHierarchy 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.FilterPivotHierarchyData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.FilterPivotHierarchyData;

返回

Excel.Interfaces.FilterPivotHierarchyData