ExcelScript.PivotDateFilter interface

Пакет:

ExcelScript

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

Свойства

comparator	Компаратор — это статическое значение, с которым сравниваются другие значения. Тип сравнения определяется условием.
condition	Указывает условие для фильтра, определяющее необходимые критерии фильтрации.
exclusive	Если trueзадано значение , фильтр исключает элементы, соответствующие условиям. Значение по умолчанию — false (фильтр для включения элементов, соответствующих условиям).
lowerBound	Нижняя граница диапазона для between условия фильтра.
upperBound	Верхняя граница диапазона для between условия фильтра.
wholeDays	Для equalsусловий фильтра , before, afterи between указывает, следует ли сравнивать целые дни.

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

comparator

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

comparator?: FilterDatetime;

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

ExcelScript.FilterDatetime

condition

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

condition: DateFilterCondition;

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

ExcelScript.DateFilterCondition

Примеры

/**
 * This script applies a filter to a PivotTable that filters out rows 
 * that aren't from this month.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the "Date Recorded" field to filter. 
  // The data in this field must be dates in order for the filter to work.
  const pivot = workbook.getPivotTables()[0];
  const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
  const rowField = rowHierarchy.getFields()[0];

  // Apply the date filter.
  rowField.applyFilter({
    dateFilter: {
      // Setting the condition to `thisMonth` means items that are before or
      // after this month will not be displayed.
      condition: ExcelScript.DateFilterCondition.thisMonth
    }
  });
}

exclusive

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

exclusive?: boolean;

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

boolean

lowerBound

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

lowerBound?: FilterDatetime;

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

ExcelScript.FilterDatetime

Примеры

/**
 * This script applies a filter to a PivotTable that filters it
 * to only show rows from between June 20th, 2022 and July 10th, 2022.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the "Date Recorded" field to filter. 
  // The data in this field must be dates in order for the filter to work.
  const pivot = workbook.getPivotTables()[0];
  const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
  const rowField = rowHierarchy.getFields()[0];

  // Create the filter's date boundaries.
  let earliestDate: ExcelScript.FilterDatetime = {
    date: "2022-06-20",
    specificity: ExcelScript.FilterDatetimeSpecificity.day
  };
  let latestDate: ExcelScript.FilterDatetime = {
    date: "2022-07-10",
    specificity: ExcelScript.FilterDatetimeSpecificity.day
  };

  // Apply the date filter.
  rowField.applyFilter({
    dateFilter: {
      condition: ExcelScript.DateFilterCondition.between,
      lowerBound: earliestDate,
      upperBound: latestDate
    }
  });
}

upperBound

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

upperBound?: FilterDatetime;

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

ExcelScript.FilterDatetime

wholeDays

Для equalsусловий фильтра , before, afterи between указывает, следует ли сравнивать целые дни.

wholeDays?: boolean;

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

boolean