Excel.PivotValueFilter interface
要应用于 PivotField 的值筛选器的可配置模板。 定义 condition 需要设置哪些条件才能使筛选器运行。
注解
示例
// 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”且条件为“greaterThan”，则筛选器将删除所有不大于 50 的项值。 |
| condition | 指定筛选器的条件，该条件定义必要的筛选条件。 |
| exclusive | 如果 |
| lower |
筛选条件的范围的 |
| selection |
指定筛选器是针对顶部/底部 N 项、顶部/底部 N 百分比还是顶部/底部 N 个总和。 |
| threshold | 要根据顶部/底部筛选条件筛选的项数、百分比或总和的“N”阈值。 |
| upper |
筛选条件的范围 |
| value | 要筛选的字段中所选“值”的名称。 |
属性详细信息
comparator
比较器是与其他值进行比较的静态值。 比较的类型由 条件定义。 例如，如果比较器为“50”且条件为“greaterThan”，则筛选器将删除所有不大于 50 的项值。
comparator?: number;属性值
number
注解
condition
指定筛选器的条件，该条件定义必要的筛选条件。
condition: Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN";属性值
Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN"
注解
exclusive
如果 true为 ，则筛选器 排除 满足条件的项目。 默认值为 false (筛选器，以包含符合条件) 的项。
exclusive?: boolean;属性值
boolean
注解
lowerBound
selectionType
指定筛选器是针对顶部/底部 N 项、顶部/底部 N 百分比还是顶部/底部 N 个总和。
selectionType?: Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum";属性值
Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum"