Excel.PivotValueFilter interface

Paquete:
excel

Plantilla configurable para que un filtro de valor 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 on the values correlated with a row.

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

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

  // Filter to only include rows with more than 500 wholesale crates sold.
  const filter: Excel.PivotValueFilter = {
    condition: Excel.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: "Sum of Crates Sold Wholesale"
  };

  // Apply the value filter to the field.
  field.applyFilter({ valueFilter: 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. Por ejemplo, si el comparador es "50" y la condición es "greaterThan", el filtro quitará todos los valores de elemento que no sean mayores que 50.
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.
selectionType

Especifica si el filtro es para los N elementos superiores o inferiores, el N por ciento superior/inferior o la suma N superior/inferior.
threshold

Número de umbral "N" de elementos, porcentaje o suma que se va a filtrar para una condición de filtro superior o inferior.
upperBound

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

Nombre del "valor" elegido en el campo por el que se va a filtrar.

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. Por ejemplo, si el comparador es "50" y la condición es "greaterThan", el filtro quitará todos los valores de elemento que no sean mayores que 50.

comparator?: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

condition

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

condition: Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN";

Valor de propiedad

Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN"

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.

lowerBound?: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

selectionType

Especifica si el filtro es para los N elementos superiores o inferiores, el N por ciento superior/inferior o la suma N superior/inferior.

selectionType?: Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum";

Valor de propiedad

Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum"

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

threshold

Número de umbral "N" de elementos, porcentaje o suma que se va a filtrar para una condición de filtro superior o inferior.

threshold?: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

upperBound

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

upperBound?: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

value

Nombre del "valor" elegido en el campo por el que se va a filtrar.

value: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]