ExcelScript.PivotDateFilter interface

Pacote:

ExcelScript

Modelo configurável para um filtro de data a ser aplicado a um PivotField. O condition define quais critérios precisam ser definidos para que o filtro opere.

Propriedades

comparator	O comparador é o valor estático ao qual outros valores são comparados. O tipo de comparação é definido pela condição.
condition	Especifica a condição do filtro, que define os critérios de filtragem necessários.
exclusive	Se true, o filtro excluirá itens que atendam aos critérios. O padrão é false (filtro para incluir itens que atendam aos critérios).
lowerBound	O limite inferior do intervalo para a condição de between filtro.
upperBound	O limite superior do intervalo para a condição de between filtro.
wholeDays	Para equals, before, aftere between condições de filtro, indica se as comparações devem ser feitas como dias inteiros.

Detalhes da propriedade

comparator

O comparador é o valor estático ao qual outros valores são comparados. O tipo de comparação é definido pela condição.

comparator?: FilterDatetime;

Valor da propriedade

ExcelScript.FilterDatetime

condition

Especifica a condição do filtro, que define os critérios de filtragem necessários.

condition: DateFilterCondition;

Valor da propriedade

ExcelScript.DateFilterCondition

Exemplos

/**
 * 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

Se true, o filtro excluirá itens que atendam aos critérios. O padrão é false (filtro para incluir itens que atendam aos critérios).

exclusive?: boolean;

Valor da propriedade

boolean

lowerBound

O limite inferior do intervalo para a condição de between filtro.

lowerBound?: FilterDatetime;

Valor da propriedade

ExcelScript.FilterDatetime

Exemplos

/**
 * 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

O limite superior do intervalo para a condição de between filtro.

upperBound?: FilterDatetime;

Valor da propriedade

ExcelScript.FilterDatetime

wholeDays

Para equals, before, aftere between condições de filtro, indica se as comparações devem ser feitas como dias inteiros.

wholeDays?: boolean;

Valor da propriedade

boolean