ExcelScript.PivotLabelFilter interface

Пакет:

ExcelScript

Настраиваемый шаблон для фильтра меток, применяемого к сводной области. Определяет condition , какие критерии необходимо задать, чтобы фильтр работал.

Комментарии

Примеры

/**
 * This script filters items that start with "L" from the "Type" field
 * of the "Farm Sales" PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable.
  const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");

  // Get the "Type" field.
  const field = pivotTable.getHierarchy("Type").getPivotField("Type");

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

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

Свойства

condition	Указывает условие для фильтра, определяющее необходимые критерии фильтрации.
exclusive	Если trueзадано значение , фильтр исключает элементы, соответствующие условиям. Значение по умолчанию — false (фильтр для включения элементов, соответствующих условиям).
lowerBound	Нижняя граница диапазона для between условия фильтра. Примечание. Числовая строка обрабатывается как число при сравнении с другими числовыми строками.
substring	Подстрока, используемая для условий beginsWithфильтра , endsWithи contains .
upperBound	Верхняя граница диапазона для between условия фильтра. Примечание. Числовая строка обрабатывается как число при сравнении с другими числовыми строками.

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

condition

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

condition: LabelFilterCondition;

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

ExcelScript.LabelFilterCondition

exclusive

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

exclusive?: boolean;

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

boolean

lowerBound

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

lowerBound?: string;

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

string

substring

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

substring?: string;

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

string

upperBound

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

upperBound?: string;

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

string