Excel.PivotLabelFilter interface

Paquete:
excel

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

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml

await Excel.run(async (context) => {
  // Add a PivotFilter to filter based on the strings of item labels.

  // Get the PivotTable.
  const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");

  // Get the "Type" field.
  const field = pivotTable.hierarchies.getItem("Type").fields.getItem("Type");

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

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

  await context.sync();
});

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. Nota: Una cadena numérica se trata como un número cuando se compara con otras cadenas numéricas.
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. Nota: Una cadena numérica se trata como un número cuando se compara con otras cadenas numéricas.
substring

Subcadena usada para las condiciones de beginsWithfiltro , endsWithy contains .
upperBound

Límite superior del intervalo para la condición de between filtro. Nota: Una cadena numérica se trata como un número cuando se compara con otras cadenas numéricas.

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. Nota: Una cadena numérica se trata como un número cuando se compara con otras cadenas numéricas.

comparator?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

condition

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

condition: Excel.LabelFilterCondition | "Unknown" | "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between";

Valor de propiedad

Excel.LabelFilterCondition | "Unknown" | "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between"

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

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

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

lowerBound

Límite inferior del intervalo para la condición de between filtro. Nota: Una cadena numérica se trata como un número cuando se compara con otras cadenas numéricas.

lowerBound?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

substring

Subcadena usada para las condiciones de beginsWithfiltro , endsWithy contains .

substring?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

upperBound

Límite superior del intervalo para la condición de between filtro. Nota: Una cadena numérica se trata como un número cuando se compara con otras cadenas numéricas.

upperBound?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]