Excel.PivotValueFilter interface

应用于数据透视字段的值筛选器的可配置模板。 定义 condition 过滤器运行需要设置哪些条件。

注解

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) => {
  // Add a PivotFilter to filter on the values correlated with a row.

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

  // Get the "Farm" field.
  const field = pivotTable.hierarchies.getItem("Farm").fields.getItem("Farm");

  // Filter to only include rows with more than 500 wholesale crates sold.
  const filter: Excel.PivotValueFilter = {
    condition: Excel.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: "Sum of Crates Sold Wholesale"
  };

  // Apply the value filter to the field.
  field.applyFilter({ valueFilter: filter });

  await context.sync();
});

属性

comparator

比较器是与其他值进行比较的静态值。 比较类型由条件定义。 例如,如果比较器为“50”,条件为“大于”,则筛选器将删除所有不大于 50 的项值。

condition

指定筛选器的条件,该条件定义必要的筛选条件。

exclusive

如果 ,筛选 true将排除 符合条件的项目。 默认为 (筛选器以 false 包含符合条件) 的项。

lowerBound

筛选条件的 between 范围下限。

selectionType

指定筛选器是用于前/后 N 项、前/后 N 个百分比,还是最高/后 N 个总和。

threshold

要针对顶部/底部筛选条件筛选的项目、百分比或总和的“N”阈值数。

upperBound

筛选条件的 between 范围上限。

value

要作为筛选所依据的字段中所选“值”的名称。

属性详细信息

comparator

比较器是与其他值进行比较的静态值。 比较类型由条件定义。 例如,如果比较器为“50”,条件为“大于”,则筛选器将删除所有不大于 50 的项值。

comparator?: number;

属性值

number

注解

API 集:ExcelApi 1.12

condition

指定筛选器的条件,该条件定义必要的筛选条件。

condition: Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN";

属性值

Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN"

注解

API 集:ExcelApi 1.12

exclusive

如果 ,筛选 true将排除 符合条件的项目。 默认为 (筛选器以 false 包含符合条件) 的项。

exclusive?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.12

lowerBound

筛选条件的 between 范围下限。

lowerBound?: number;

属性值

number

注解

API 集:ExcelApi 1.12

selectionType

指定筛选器是用于前/后 N 项、前/后 N 个百分比,还是最高/后 N 个总和。

selectionType?: Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum";

属性值

Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum"

注解

API 集:ExcelApi 1.12

threshold

要针对顶部/底部筛选条件筛选的项目、百分比或总和的“N”阈值数。

threshold?: number;

属性值

number

注解

API 集:ExcelApi 1.12

upperBound

筛选条件的 between 范围上限。

upperBound?: number;

属性值

number

注解

API 集:ExcelApi 1.12

value

要作为筛选所依据的字段中所选“值”的名称。

value: string;

属性值

string

注解

API 集:ExcelApi 1.12