Excel.PivotLabelFilter interface

Пакет:
excel

Настраиваемый шаблон для фильтра меток для применения к полю сводных таблиц. Определяет 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 based on the strings of item labels.

  // Get the PivotTable.
  const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");

  // Get the "Type" field.
  const field = pivotTable.hierarchies.getItem("Type").fields.getItem("Type");

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

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

  await context.sync();
});

Свойства

comparator

Компаратор — это статическое значение, с которым сравниваются другие значения. Тип сравнения определяется условием. Примечание. При сравнении числовых строк числовая строка рассматривается как число.
condition

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

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

Нижняя граница диапазона для условия фильтра between . Примечание. При сравнении числовых строк числовая строка рассматривается как число.
substring

Подстрока beginsWith, используемая для условий , endsWithи contains filter.
upperBound

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

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

comparator

Компаратор — это статическое значение, с которым сравниваются другие значения. Тип сравнения определяется условием. Примечание. При сравнении числовых строк числовая строка рассматривается как число.

comparator?: string;

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

string

Комментарии

Набор API: ExcelApi 1.12

condition

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

condition: Excel.LabelFilterCondition | "Unknown" | "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between";

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

Excel.LabelFilterCondition | "Unknown" | "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between"

Комментарии

Набор API: ExcelApi 1.12

exclusive

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

exclusive?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.12

lowerBound

Нижняя граница диапазона для условия фильтра between . Примечание. При сравнении числовых строк числовая строка рассматривается как число.

lowerBound?: string;

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

string

Комментарии

Набор API: ExcelApi 1.12

substring

Подстрока beginsWith, используемая для условий , endsWithи contains filter.

substring?: string;

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

string

Комментарии

Набор API: ExcelApi 1.12

upperBound

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

upperBound?: string;

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

string

Комментарии

Набор API: ExcelApi 1.12