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

condition

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

exclusive

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

lowerBound

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

selectionType

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

threshold

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

upperBound

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

value

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

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

comparator

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

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

threshold?: number;

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

number

Комментарии

Набор API: ExcelApi 1.12

upperBound

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

upperBound?: number;

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

number

Комментарии

Набор API: ExcelApi 1.12

value

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

value: string;

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

string

Комментарии

Набор API: ExcelApi 1.12