Share via

ExcelScript.PivotValueFilter interface

  • Ссылка
Пакет:
ExcelScript

Настраиваемый шаблон для фильтра значений, применяемого к сводным полям. Определяет 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", а условие — "большеThan", все значения элементов, не превышающие 50, будут удалены фильтром.
condition

Указывает условие для фильтра, определяющее необходимые критерии фильтрации.
exclusive

Если trueзадано значение , фильтр исключает элементы, соответствующие условиям. Значение по умолчанию — false (фильтр для включения элементов, соответствующих условиям).
lowerBound

Нижняя граница диапазона для between условия фильтра.
selectionType

Указывает, используется ли фильтр для верхнего или нижнего N элементов, верхнего или нижнего N процентов или верхней/нижней суммы N.
threshold

Пороговое число "N" элементов, процентов или сумм, которые должны быть отфильтрованы для верхнего или нижнего условий фильтра.
upperBound

Верхняя граница диапазона для between условия фильтра.
value

Имя выбранного значения в поле, по которому выполняется фильтрация.

Сведения о свойстве

comparator

Компаратор — это статическое значение, с которым сравниваются другие значения. Тип сравнения определяется условием. Например, если компаратор имеет значение "50", а условие — "большеThan", все значения элементов, не превышающие 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