ExcelScript.PivotFilters interface

Paquete:

ExcelScript

Interfaz que representa todos los pivotfilters aplicados actualmente a un campo dinámico determinado.

Propiedades

dateFilter	Filtro de fecha aplicado actualmente al campo dinámico. Esta propiedad es null si no se aplica ningún filtro de valor.
labelFilter	Filtro de etiqueta aplicado actualmente al campo dinámico. Esta propiedad es null si no se aplica ningún filtro de valor.
manualFilter	Filtro manual aplicado actualmente al campo dinámico. Esta propiedad es null si no se aplica ningún filtro de valor.
valueFilter	Filtro de valor aplicado actualmente al campo dinámico. Esta propiedad es null si no se aplica ningún filtro de valor.

Detalles de las propiedades

dateFilter

Filtro de fecha aplicado actualmente al campo dinámico. Esta propiedad es null si no se aplica ningún filtro de valor.

dateFilter?: PivotDateFilter;

Valor de propiedad

ExcelScript.PivotDateFilter

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
    }
  });
}

labelFilter

Filtro de etiqueta aplicado actualmente al campo dinámico. Esta propiedad es null si no se aplica ningún filtro de valor.

labelFilter?: PivotLabelFilter;

Valor de propiedad

ExcelScript.PivotLabelFilter

Ejemplos

/**
 * 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 });
}

manualFilter

Filtro manual aplicado actualmente al campo dinámico. Esta propiedad es null si no se aplica ningún filtro de valor.

manualFilter?: PivotManualFilter;

Valor de propiedad

ExcelScript.PivotManualFilter

Ejemplos

/**
 * This script adds a manual filter to a PivotTable. 
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the first PivotTable in the workbook.
  const pivot = workbook.getPivotTables()[0];

  // Get the hierarchy to use as the filter.
  const location = pivot.getHierarchy("Location");

  // Use "Location" as the FilterHierarchy.
  pivot.addFilterHierarchy(location);

  // Select items for the filter.
  // Note that hierarchies and fields have a 1:1 relationship in Excel,
  // so `getFields()[0]` always gets the correct field.
  location.getFields()[0].applyFilter({
    manualFilter: {
      selectedItems: ["Seattle", "Chicago"]
    }
  });
}

valueFilter

Filtro de valor aplicado actualmente al campo dinámico. Esta propiedad es null si no se aplica ningún filtro de valor.

valueFilter?: PivotValueFilter;

Valor de propiedad

ExcelScript.PivotValueFilter

Ejemplos

/**
 * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable on the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let pivotTable = sheet.getPivotTables()[0];

  // Get the first row hierarchy to use as the field which gets filtered.
  let rowHierarchy = pivotTable.getRowHierarchies()[0];

  // Get the first data hierarchy to use as the values for filtering the rows.
  let dataHierarchy = pivotTable.getDataHierarchies()[0];

  // Create a filter that excludes values greater than 500.
  let filter: ExcelScript.PivotValueFilter = {
    condition: ExcelScript.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: dataHierarchy.getName()
  };

  // Apply the filter.
  rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
    valueFilter: filter
  });
}