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

condition

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

exclusive

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

lowerBound

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

selectionType

Указывает, охватывает ли фильтр первые и последние N элементов, первые и последние N процентов или первые и последние N чисел.

threshold

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

upperBound

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

value

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

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

comparator

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

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

threshold?: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.12

upperBound

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

upperBound?: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.12

value

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

value: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.12