ExcelScript.PivotValueFilter interface

包:

ExcelScript

要应用于 PivotField 的值筛选器的可配置模板。 定义 condition 需要设置哪些条件才能使筛选器运行。

注解

示例

/**
 * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable on the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let pivotTable = sheet.getPivotTables()[0];

  // Get the first row hierarchy to use as the field which gets filtered.
  let rowHierarchy = pivotTable.getRowHierarchies()[0];

  // Get the first data hierarchy to use as the values for filtering the rows.
  let dataHierarchy = pivotTable.getDataHierarchies()[0];

  // Create a filter that excludes values greater than 500.
  let filter: ExcelScript.PivotValueFilter = {
    condition: ExcelScript.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: dataHierarchy.getName()
  };

  // Apply the filter.
  rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
    valueFilter: filter
  });
}

属性

comparator	比较器是与其他值进行比较的静态值。 比较的类型由 条件定义。 例如，如果比较器为“50”且条件为“greaterThan”，则筛选器将删除所有不大于 50 的项值。
condition	指定筛选器的条件，该条件定义必要的筛选条件。
exclusive	如果 true为 ，则筛选器 排除 满足条件的项目。 默认值为 false (筛选器，以包含符合条件) 的项。
lowerBound	筛选条件的范围的 between 下限。
selectionType	指定筛选器是针对顶部/底部 N 项、顶部/底部 N 百分比还是顶部/底部 N 个总和。
threshold	要根据顶部/底部筛选条件筛选的项数、百分比或总和的“N”阈值。
upperBound	筛选条件的范围 between 上限。
value	要筛选的字段中所选“值”的名称。

属性详细信息

comparator

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

comparator?: number;

属性值

number

condition

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

condition: ValueFilterCondition;

属性值

ExcelScript.ValueFilterCondition

exclusive

如果 true为 ，则筛选器 排除 满足条件的项目。 默认值为 false (筛选器，以包含符合条件) 的项。

exclusive?: boolean;

属性值

boolean

lowerBound

筛选条件的范围的 between 下限。

lowerBound?: number;

属性值

number

selectionType

指定筛选器是针对顶部/底部 N 项、顶部/底部 N 百分比还是顶部/底部 N 个总和。

selectionType?: TopBottomSelectionType;

属性值

ExcelScript.TopBottomSelectionType

threshold

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

threshold?: number;

属性值

number

upperBound

筛选条件的范围 between 上限。

upperBound?: number;

属性值

number

value

要筛选的字段中所选“值”的名称。

value: string;

属性值

string