Edit

Share via

Excel.ValueFilterCondition enum

  • Reference
Package:
excel

Enum representing all accepted conditions by which a value filter can be applied. Used to configure the type of PivotFilter that is applied to the field. PivotFilter.exclusive can be set to true to invert many of these conditions.

Remarks

[ API set: ExcelApi 1.12 ]

Examples

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

Fields

between = "Between"

Between lowerBound and upperBound criteria.

Required Criteria: {value, lowerBound, upperBound}. Optional Criteria: {exclusive}.
bottomN = "BottomN"

In bottom N (threshold) [items, percent, sum] of value category.

Required Criteria: {value, threshold, selectionType}.
equals = "Equals"

Equals comparator criterion.

Required Criteria: {value, comparator}. Optional Criteria: {exclusive}.
greaterThan = "GreaterThan"

Greater than comparator criterion.

Required Criteria: {value, comparator}.
greaterThanOrEqualTo = "GreaterThanOrEqualTo"

Greater than or equal to comparator criterion.

Required Criteria: {value, comparator}.
lessThan = "LessThan"

Less than comparator criterion.

Required Criteria: {value, comparator}.
lessThanOrEqualTo = "LessThanOrEqualTo"

Less than or equal to comparator criterion.

Required Criteria: {value, comparator}.
topN = "TopN"

In top N (threshold) [items, percent, sum] of value category.

Required Criteria: {value, threshold, selectionType}.
unknown = "Unknown"

ValueFilterCondition is unknown or unsupported.