Excel.PivotField class
表示 Excel 数据透视域。
注解
使用方
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| id | 数据透视字段的 ID。 |
| items | 返回与数据透视字段关联的数据透视项。 |
| name | PivotField 的名称。 |
| show |
确定是否显示 PivotField 的所有项。 |
| subtotals | PivotField 小计。 |
方法
| apply |
设置字段的一个或多个当前 PivotFilter，并将它们应用到字段。 如果提供的筛选器无效或无法应用，将引发异常。 |
| clear |
清除该字段的所有筛选器中的所有条件。 这将删除字段上的任何活动筛选。 |
| clear |
从给定类型的字段筛选器中清除所有现有条件 (如果当前已应用) 条件。 |
| clear |
从给定类型的字段筛选器中清除所有现有条件 (如果当前已应用) 条件。 |
| get |
获取当前在字段上应用的所有筛选器。 |
| is |
检查字段上是否有任何应用的筛选器。 |
| is |
检查字段上是否有任何应用的筛选器。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| sort |
PivotField 排序。 如果指定 DataPivotHierarchy，则会基于它进行排序，如果未指定，则会基于 PivotField 本身进行排序。 |
| sort |
按给定范围中的指定值对 PivotField 进行排序。 作用域定义当存在来自同一 DataPivotHierarchy 的多个值时，将使用哪些特定值进行排序。 |
| sort |
按给定范围中的指定值对 PivotField 进行排序。 作用域定义当存在来自同一 DataPivotHierarchy 的多个值时，将使用哪些特定值进行排序。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
id
items
返回与数据透视字段关联的数据透视项。
readonly items: Excel.PivotItemCollection;属性值
注解
name
showAllItems
subtotals
方法详细信息
applyFilter(filter)
设置字段的一个或多个当前 PivotFilter，并将它们应用到字段。 如果提供的筛选器无效或无法应用，将引发异常。
applyFilter(filter: Excel.PivotFilters): void;参数
- filter
- Excel.PivotFilters
已配置的特定 PivotFilter，或包含多个已配置筛选器的 PivotFilters 接口。
返回
void
注解
clearAllFilters()
清除该字段的所有筛选器中的所有条件。 这将删除字段上的任何活动筛选。
clearAllFilters(): void;返回
void
注解
示例
// 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
注解
clearFilter(filterType)
从给定类型的字段筛选器中清除所有现有条件 (如果当前已应用) 条件。
clearFilter(filterType: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;参数
- filterType
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
要清除其所有条件的字段的筛选器类型。
返回
void
注解
getFilters()
获取当前在字段上应用的所有筛选器。
getFilters(): OfficeExtension.ClientResult<Excel.PivotFilters>;返回
具有所有活动筛选器的 PivotFilters 接口。
注解
isFiltered(filterType)
检查字段上是否有任何应用的筛选器。
isFiltered(filterType?: Excel.PivotFilterType): OfficeExtension.ClientResult<boolean>;参数
- filterType
- Excel.PivotFilterType
要检查的筛选器类型。 如果未提供类型，则此方法将检查是否应用了任何筛选器。
返回
OfficeExtension.ClientResult<boolean>
如果字段应用了类型的 filterType 筛选器，则为 True。 如果未指定，true如果filterType字段应用了任何筛选器，则返回。
注解
isFiltered(filterType)
检查字段上是否有任何应用的筛选器。
isFiltered(filterType?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;参数
- filterType
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
要检查的筛选器类型。 如果未提供类型，则此方法将检查是否应用了任何筛选器。
返回
OfficeExtension.ClientResult<boolean>
如果字段应用了类型的 filterType 筛选器，则为 True。 如果未指定，true如果filterType字段应用了任何筛选器，则返回。
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField;参数
为要加载的对象属性提供选项。
返回
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
注解
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
注解
sortByValues(sortBy, valuesHierarchy, pivotItemScope)
按给定范围中的指定值对 PivotField 进行排序。 作用域定义当存在来自同一 DataPivotHierarchy 的多个值时，将使用哪些特定值进行排序。
sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;参数
- sortBy
-
"Ascending" | "Descending"
指定按升序还是降序完成排序。
- valuesHierarchy
- Excel.DataPivotHierarchy
指定数据轴上要用于排序的值层次结构。
- pivotItemScope
-
Array<Excel.PivotItem | string>
应用于排序范围的项目。 这些项目将构成您要排序的行或列。 如果使用字符串而不是 PivotItem，则字符串表示 PivotItem 的 ID。 如果要排序依据的轴上除了数据层次结构之外没有其他项，则此项可以为空。
返回
void
注解
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.PivotField 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.PivotFieldData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.PivotFieldData;