ExcelScript.PivotDateFilter interface

Paquete:

ExcelScript

Plantilla configurable para que un filtro de fecha se aplique a un campo dinámico. condition define qué criterios deben establecerse para que el filtro funcione.

Propiedades

comparator	El comparador es el valor estático con el que se comparan otros valores. La condición define el tipo de comparación.
condition	Especifica la condición del filtro, que define los criterios de filtrado necesarios.
exclusive	Si truees , filter excluye los elementos que cumplen los criterios. El valor predeterminado es false (filtrar para incluir elementos que cumplan los criterios).
lowerBound	Límite inferior del intervalo para la condición de between filtro.
upperBound	Límite superior del intervalo para la condición de between filtro.
wholeDays	Para equalslas condiciones de filtro , before, aftery between , indica si las comparaciones deben realizarse como días enteros.

Detalles de las propiedades

comparator

El comparador es el valor estático con el que se comparan otros valores. La condición define el tipo de comparación.

comparator?: FilterDatetime;

Valor de propiedad

ExcelScript.FilterDatetime

condition

Especifica la condición del filtro, que define los criterios de filtrado necesarios.

condition: DateFilterCondition;

Valor de propiedad

ExcelScript.DateFilterCondition

Ejemplos

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

Si truees , filter excluye los elementos que cumplen los criterios. El valor predeterminado es false (filtrar para incluir elementos que cumplan los criterios).

exclusive?: boolean;

Valor de propiedad

boolean

lowerBound

Límite inferior del intervalo para la condición de between filtro.

lowerBound?: FilterDatetime;

Valor de propiedad

ExcelScript.FilterDatetime

Ejemplos

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

Límite superior del intervalo para la condición de between filtro.

upperBound?: FilterDatetime;

Valor de propiedad

ExcelScript.FilterDatetime

wholeDays

Para equalslas condiciones de filtro , before, aftery between , indica si las comparaciones deben realizarse como días enteros.

wholeDays?: boolean;

Valor de propiedad

boolean