Excel.PivotField class

表示 Excel PivotField。

Extends

注解

[ API 集:ExcelApi 1.8 ]

属性

context

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

id

PivotField 的 ID。

items

返回与 PivotField 关联的 PivotItems。

name

PivotField 的名称。

showAllItems

确定是否显示 PivotField 的所有项。

subtotals

PivotField 小计。

方法

applyFilter(filter)

设置字段的一个或多个当前数据透视筛选器,并将其应用于字段。 如果提供的筛选器无效或无法应用,则会引发异常。

clearAllFilters()

清除所有字段筛选器中的所有条件。 这会删除字段上的任何活动筛选。

clearFilter(filterType)

清除给定类型的字段筛选器中的所有现有条件, (当前) 应用条件。

clearFilter(filterTypeString)

清除给定类型的字段筛选器中的所有现有条件, (当前) 应用条件。

getFilters()

获取字段上当前应用的所有筛选器。

isFiltered(filterType)

检查字段上是否有任何已应用的筛选器。

isFiltered(filterTypeString)

检查字段上是否有任何已应用的筛选器。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

sortByLabels(sortBy)

PivotField 排序。 如果指定 DataPivotHierarchy,则会基于它进行排序,如果未指定,则会基于 PivotField 本身进行排序。

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

按给定范围中的指定值对 PivotField 进行排序。 范围定义当同一 DataPivotHierarchy 中存在多个值时,将使用哪些特定值进行排序。

sortByValues(sortByString, valuesHierarchy, pivotItemScope)

按给定范围中的指定值对 PivotField 进行排序。 范围定义当同一 DataPivotHierarchy 中存在多个值时,将使用哪些特定值进行排序。

toJSON()

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

属性详细信息

context

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

context: RequestContext;

属性值

id

PivotField 的 ID。

readonly id: string;

属性值

string

注解

[ API 集:ExcelApi 1.8 ]

items

返回与 PivotField 关联的 PivotItems。

readonly items: Excel.PivotItemCollection;

属性值

注解

[ API 集:ExcelApi 1.8 ]

name

PivotField 的名称。

name: string;

属性值

string

注解

[ API 集:ExcelApi 1.8 ]

showAllItems

确定是否显示 PivotField 的所有项。

showAllItems: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.8 ]

subtotals

PivotField 小计。

subtotals: Excel.Subtotals;

属性值

注解

[ API 集:ExcelApi 1.8 ]

方法详细信息

applyFilter(filter)

设置字段的一个或多个当前数据透视筛选器,并将其应用于字段。 如果提供的筛选器无效或无法应用,则会引发异常。

applyFilter(filter: Excel.PivotFilters): void;

参数

filter
Excel.PivotFilters

配置的特定 PivotFilter,或包含多个已配置筛选器的 PivotFilters 接口。

返回

void

注解

[ API 集:ExcelApi 1.12 ]

clearAllFilters()

清除所有字段筛选器中的所有条件。 这会删除字段上的任何活动筛选。

clearAllFilters(): void;

返回

void

注解

[ API 集:ExcelApi 1.12 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml
await Excel.run(async (context) => {
  // Clear all the PivotFilters.

  // Get the PivotTable.
  const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
  pivotTable.hierarchies.load("name");
  await context.sync();

  // Clear the filters on each PivotField.
  pivotTable.hierarchies.items.forEach((hierarchy) => {
    hierarchy.fields.getItem(hierarchy.name).clearAllFilters();
  });
  await context.sync();
});

clearFilter(filterType)

清除给定类型的字段筛选器中的所有现有条件, (当前) 应用条件。

clearFilter(filterType: Excel.PivotFilterType): void;

参数

filterType
Excel.PivotFilterType

要清除其所有条件的字段的筛选器类型。

返回

void

注解

[ API 集:ExcelApi 1.12 ]

clearFilter(filterTypeString)

清除给定类型的字段筛选器中的所有现有条件, (当前) 应用条件。

clearFilter(filterTypeString: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;

参数

filterTypeString

"Unknown" | "Value" | "Manual" | "Label" | "Date"

要清除其所有条件的字段的筛选器类型。

返回

void

注解

[ API 集:ExcelApi 1.12 ]

getFilters()

获取字段上当前应用的所有筛选器。

getFilters(): OfficeExtension.ClientResult<Excel.PivotFilters>;

返回

包含所有活动筛选器的 PivotFilters 接口。

注解

[ API 集:ExcelApi 1.12 ]

isFiltered(filterType)

检查字段上是否有任何已应用的筛选器。

isFiltered(filterType?: Excel.PivotFilterType): OfficeExtension.ClientResult<boolean>;

参数

filterType
Excel.PivotFilterType

要检查的筛选器类型。 如果未提供任何类型,此方法将检查是否应用了任何筛选器。

返回

如果字段应用了类型的 filterType 筛选器,则为 True。 如果未 filterType 指定 , true 则如果字段具有任何已应用的筛选器,则返回 。

注解

[ API 集:ExcelApi 1.12 ]

isFiltered(filterTypeString)

检查字段上是否有任何已应用的筛选器。

isFiltered(filterTypeString?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;

参数

filterTypeString

"Unknown" | "Value" | "Manual" | "Label" | "Date"

要检查的筛选器类型。 如果未提供任何类型,此方法将检查是否应用了任何筛选器。

返回

如果字段应用了类型的 filterType 筛选器,则为 True。 如果未 filterType 指定 , true 则如果字段具有任何已应用的筛选器,则返回 。

注解

[ API 集:ExcelApi 1.12 ]

load(options)

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

load(options?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField;

参数

options
Excel.Interfaces.PivotFieldLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

set(properties, options)

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

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

参数

properties
Excel.Interfaces.PivotFieldUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.PivotField): void;

参数

properties
Excel.PivotField

返回

void

sortByLabels(sortBy)

PivotField 排序。 如果指定 DataPivotHierarchy,则会基于它进行排序,如果未指定,则会基于 PivotField 本身进行排序。

sortByLabels(sortBy: SortBy): void;

参数

sortBy
Excel.SortBy

指定排序是按升序还是降序进行。

返回

void

注解

[ API 集:ExcelApi 1.8 ]

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

按给定范围中的指定值对 PivotField 进行排序。 范围定义当同一 DataPivotHierarchy 中存在多个值时,将使用哪些特定值进行排序。

sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;

参数

sortBy
Excel.SortBy

指定排序是按升序还是降序进行。

valuesHierarchy
Excel.DataPivotHierarchy

指定要用于排序的数据轴上的值层次结构。

pivotItemScope

Array<Excel.PivotItem | string>

应用于排序范围的项。 这些将是构成要排序的行或列的项。 如果使用字符串而不是 PivotItem,则字符串表示 PivotItem 的 ID。 如果要排序的轴上除了数据层次结构之外,没有其他项,则此项可以为空。

返回

void

注解

[ API 集:ExcelApi 1.9 ]

sortByValues(sortByString, valuesHierarchy, pivotItemScope)

按给定范围中的指定值对 PivotField 进行排序。 范围定义当同一 DataPivotHierarchy 中存在多个值时,将使用哪些特定值进行排序。

sortByValues(sortByString: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;

参数

sortByString

"Ascending" | "Descending"

指定排序是按升序还是降序进行。

valuesHierarchy
Excel.DataPivotHierarchy

指定要用于排序的数据轴上的值层次结构。

pivotItemScope

Array<Excel.PivotItem | string>

应用于排序范围的项。 这些将是构成要排序的行或列的项。 如果使用字符串而不是 PivotItem,则字符串表示 PivotItem 的 ID。 如果要排序的轴上除了数据层次结构之外,没有其他项,则此项可以为空。

返回

void

注解

[ API 集:ExcelApi 1.9 ]

toJSON()

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

toJSON(): Excel.Interfaces.PivotFieldData;

返回