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 .
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 .

substring?: string;

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

string

Комментарии

Набор API: ExcelApi 1.12

upperBound

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

upperBound?: string;

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

string

Комментарии

Набор API: ExcelApi 1.12