ExcelScript.PivotLabelFilter interface

包:

ExcelScript

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

注解

示例

/**
 * This script filters items that start with "L" from the "Type" field
 * of the "Farm Sales" PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable.
  const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");

  // Get the "Type" field.
  const field = pivotTable.getHierarchy("Type").getPivotField("Type");

  // Filter out any types that start with "L" (such as "Lemons" and "Limes").
  const filter: ExcelScript.PivotLabelFilter = {
    condition: ExcelScript.LabelFilterCondition.beginsWith,
    substring: "L",
    exclusive: true
  };

  // Apply the label filter to the field.
  field.applyFilter({ labelFilter: filter });
}

属性

condition	指定筛选器的条件，该条件定义必要的筛选条件。
exclusive	如果 true为 ，则筛选器 排除 满足条件的项目。 默认值为 false (筛选器，以包含符合条件) 的项。
lowerBound	筛选条件的范围的 between 下限。 注意：与其他数字字符串进行比较时，数字字符串被视为数字。
substring	用于 、endsWith 和 contains 筛选条件的beginsWith子字符串。
upperBound	筛选条件的范围 between 上限。 注意：与其他数字字符串进行比较时，数字字符串被视为数字。

属性详细信息

condition

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

condition: LabelFilterCondition;

属性值

ExcelScript.LabelFilterCondition

exclusive

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

exclusive?: boolean;

属性值

boolean

lowerBound

筛选条件的范围的 between 下限。 注意：与其他数字字符串进行比较时，数字字符串被视为数字。

lowerBound?: string;

属性值

string

substring

用于 、endsWith 和 contains 筛选条件的beginsWith子字符串。

substring?: string;

属性值

string

upperBound

筛选条件的范围 between 上限。 注意：与其他数字字符串进行比较时，数字字符串被视为数字。

upperBound?: string;

属性值

string