Pythonjava: Filtering Pivot Tables by Label or Value

Mon, 01 Jan 0001 00:00:00 +0000

Aspose.Cells provides five practical strategies for filtering the data displayed in a pivot table. You can apply label filters to text-based row or column fields, use date filters when the field contains only date-time cells or blanks, apply value filters against aggregated numbers, use top 10 filters to rank by a value field, or manually hide and unhide individual pivot items using the is_hidden property. Each strategy is exposed through dedicated APIs on the PivotField and PivotItem classes.

Introduction

Pivot tables are powerful analytical tools, but raw summaries often contain far more information than you need to present. Filtering is the primary mechanism for narrowing a pivot table down to the rows, columns, or values that matter for a specific report. Aspose.Cells for Python via Java mirrors the filtering capabilities that are available in Microsoft Excel, exposing them programmatically so that report generation can be fully automated.

The following filtering strategies are covered in this article:

Label Filter — filters row or column field items based on their text labels.
Date Filter — filters row or column fields that contain only date-time values (or blanks).
Value Filter — filters items based on the aggregated values of a data field.
Top 10 Filter — shows only the top or bottom N items ranked by a value field.
Hide / Unhide Pivot Items — manually controls the visibility of each individual item in a field.

Each approach uses a different method on the PivotField class or a property on the PivotItem class. After applying any filter, you must call refresh_data() and calculate_data() on the pivot table so that the cached data and calculated values reflect the new filter state.

Label Filter

A label filter allows you to filter the items of a row or column field by comparing their text captions against a pattern. This is useful when you want to display only products whose names start with a specific letter, contain a particular word, or match some other caption-based criterion.

Aspose.Cells exposes label filtering through the PivotField.filter_by_label(PivotFilterType, str) method. The PivotFilterType enumeration includes values such as CaptionBeginsWith, CaptionContains, CaptionEndsWith, CaptionDoesNotContain, CaptionIsNotBlank, CaptionIsBlank, and so on. The second argument supplies the label string used for comparison.

The following example loads a workbook containing an existing pivot table, applies a label filter so that only items whose captions begin with a specified prefix remain visible, refreshes the pivot table, and saves the result.

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import Workbook
from asposecells.api import Workbook, PivotFilterType

fileName = "sample.xlsx"
prefix = "B"

# Load the existing workbook containing a pivot table
workbook = Workbook(fileName)

# Access the worksheet by index (first worksheet)
worksheet = workbook.getWorksheets().get(0)

# Access the pivot table by index
pivotTable = worksheet.getPivotTables().get(0)

# Retrieve the first row PivotField
rowField = pivotTable.getRowFields().get(0)

# Apply the label filter — show only row items whose labels begin with the supplied prefix
rowField.filterByLabel(PivotFilterType.CaptionBeginsWith, prefix, "")

# Refresh and recalculate the pivot table data so the filter takes effect
pivotTable.getPivotCache().refresh()

# Save the workbook back to disk
workbook.save(fileName)

jpype.shutdownJVM()

Date Filter

Date filters let you narrow a pivot table by date-based criteria such as today, last week, this month, next quarter, or a specific date range. They are specialized filters that work only against fields that store date-time information.

The date filter only works when the row or column area contains only date-time cells or blank values. If the underlying field contains other data types such as numbers or text, the date filter will not produce the expected result. Make sure the field is formatted as a date and that all values are valid DateTime instances or empty cells before applying this filter.

Aspose.Cells exposes date filtering through the PivotField.filter_by_date(PivotFilterType, values) method. The PivotFilterType enumeration contains dedicated date values such as Today, Yesterday, LastWeek, ThisWeek, NextWeek, LastMonth, ThisMonth, NextMonth, LastQuarter, ThisQuarter, NextQuarter, LastYear, ThisYear, NextYear, and Between. Depending on the chosen filter type, you pass one or two DateTime values (for Between, you pass the start and end dates).

The following example loads a workbook with a pivot table whose row area contains a date field, applies a date filter that restricts the visible items to a particular date range, refreshes the pivot table, and saves the workbook.

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import Workbook
from asposecells.api import Workbook, PivotFilterType

inputPath = "sample.xlsx"
outputPath = "output_filtered.xlsx"

if not os.path.exists(inputPath):
    raise FileNotFoundError(f"Source workbook not found: {inputPath}")

# Load the existing workbook that contains the pivot table
workbook = Workbook(inputPath)

# Access the worksheet that holds the pivot table (by index)
worksheet = workbook.getWorksheets().get(0)

# Access the pivot table by index
pivotTable = worksheet.getPivotTables().get(0)

# Retrieve the date PivotField from the row area
# (Date filter only works when the row/column area contains only date-time cells or blanks)
dateField = pivotTable.getRowFields().get(0)

# Define the date criterion for the Between filter
Date = jpype.JClass("java.util.Date")
startDate = Date(2020 - 1900, 0, 1)
endDate = Date(2020 - 1900, 11, 31)

# Apply the date filter on the pivot field
dateField.filterByDate(PivotFilterType.DateBetween, startDate, endDate)

# Refresh and recalculate the pivot table so the filter takes effect
pivotTable.getPivotCache().refresh()

# Persist the workbook
workbook.save(outputPath)

jpype.shutdownJVM()

Value Filter

Value filters operate on the aggregated values that a pivot table calculates in its data area. Instead of matching text labels, they compare numeric totals against a threshold. Typical use cases include showing only products whose sum of sales exceeds a target amount or only regions whose count of transactions falls within a range.

Aspose.Cells exposes value filtering through the PivotField.filter_by_value(value_field, filter_type, values) method. The filter_type parameter uses values such as ValueGreaterThan, ValueLessThan, ValueBetween, ValueEqual, ValueNotEqual, ValueGreaterThanOrEqual, and ValueLessThanOrEqual. The value_field parameter specifies which data field should be evaluated, and the final argument(s) supply the threshold value(s).

The following example loads a workbook with a pivot table, applies a value filter that keeps only items whose aggregated sales exceed a numeric threshold, refreshes the pivot table, and saves the workbook.

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import Workbook
from asposecells.api import Workbook, PivotFilterType

workbook = Workbook("sample.xlsx")
worksheet = workbook.getWorksheets().get(0)
pivotTable = worksheet.getPivotTables().get(0)

rowField = pivotTable.getRowFields().get(0)
dataField = pivotTable.getDataFields().get(0)

# Find the data field index manually since PivotFieldCollection doesn't have IndexOf
dataFieldIndex = -1
for i in range(pivotTable.getDataFields().getCount()):
    if pivotTable.getDataFields().get(i) == dataField:
        dataFieldIndex = i
        break

if dataFieldIndex >= 0:
    rowField.filterByValue(dataFieldIndex, PivotFilterType.VALUE_GREATER_THAN, 5000, float('inf'))

pivotTable.getPivotCache().refresh()

workbook.save("output.xlsx")

jpype.shutdownJVM()

Top 10 Filter

The top 10 filter is a specialized form of value filter that retains only the highest or lowest N items based on a chosen value field. It is commonly used for ranking reports such as “top 10 products by revenue” or “bottom 5 regions by sales count”.

The top 10 filter is only effective when the pivot table has one or more value pivot fields in the data area. Without at least one value field, there is no aggregated measure to rank the items against, and the filter cannot be applied.

Aspose.Cells exposes top 10 filtering through the PivotField.filter_top10(item_count, is_top, value_field, filter_type) method. The item_count parameter defines how many items to retain, is_top indicates whether to keep the top items (true) or the bottom items (false), value_field references the data field used for ranking, and filter_type controls how the value is computed (typically Sum, but also Count and Percent).

The following example loads a workbook with a pivot table that contains a value field, applies a top 10 filter to keep only the highest 10 items by the sum of sales, refreshes the pivot table, and saves the workbook.

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import Workbook
from asposecells.api import Workbook, Worksheet, PivotTable, PivotField, PivotFilterType

# Load the existing workbook that contains the pivot table
inputPath = "input.xlsx"
outputPath = "output.xlsx"
workbook = Workbook(inputPath)

# Access the worksheet that holds the pivot table (index 0)
worksheet = workbook.getWorksheets().get(0)

# Access the pivot table by index
pivotTable = worksheet.getPivotTables().get(0)

# Confirm there is at least one value PivotField in the data area
if pivotTable.getDataFields().getCount() == 0:
    raise Exception("Pivot table has no value (data) PivotField.")
valueField = pivotTable.getDataFields().get(0)

# Retrieve the target row PivotField (the field we want to apply Top 10 on)
rowField = pivotTable.getRowFields().get(0)

# The first (and only) data field is at index 0; Top 10 ranks by it.
valueFieldIndex = 0

# Apply the Top 10 filter on the row field:
#   - itemCount   = 10
#   - filterType  = PivotFilterType.Sum
#   - isTop       = true (top N; false would mean bottom N)
#   - valueFieldIndex = the index of the data field used to rank items
rowField.filterTop10(10, PivotFilterType.Sum, True, valueFieldIndex)

# Refresh the pivot table data and recalculate it so the filter takes effect
pivotTable.getPivotCache().refresh()

# Save the workbook
workbook.save(outputPath)

jpype.shutdownJVM()

Filter by Hiding or Unhiding Pivot Items

In addition to the structured filter APIs, Aspose.Cells allows you to control the visibility of each individual pivot item directly. By iterating through the PivotItems collection of a PivotField and toggling the is_hidden property, you can selectively suppress specific items without applying a formula-based filter. Setting is_hidden = True hides the item from the pivot table; setting is_hidden = False unhides it and makes it visible again.

This approach is useful when the filtering rule is irregular or item-specific, such as hiding a small number of named categories that should not appear in a particular report. The example below loads a pivot table, hides a specific item by name, demonstrates how to unhide it, refreshes the pivot table, and saves the workbook.

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import Workbook
from asposecells.api import Workbook, Worksheet, Cells, Range, SaveFormat, PivotTable, PivotField, PivotItem

# Load an existing workbook containing a pivot table
workbook = Workbook("pivot_table_sample.xlsx")

# Access the first worksheet which contains the pivot table
sheet = workbook.getWorksheets().get(0)

# Access the pivot table by index (the first pivot table on the sheet)
pivotTable = sheet.getPivotTables().get(0)

# Retrieve the target PivotField (the first row label field that we'll hide/unhide items in)
pivotField = pivotTable.getRowFields().get(0)

# Iterate through the PivotItems collection of the selected PivotField
itemCount = pivotField.getPivotItems().getCount()
for i in range(itemCount):
    item = pivotField.getPivotItems().get(i)

    # Hide pivot items that match a specific name/criterion
    if item.getName() == "Item1" or item.getName() == "Item2":
        item.setIsHidden(True)

    # Demonstrate unhiding: re-show a previously hidden pivot item
    if item.getName() == "Item3":
        item.setIsHidden(False)

# Refresh and recalculate the pivot table so changes take effect
pivotTable.getPivotCache().refresh()

# Save the workbook — hidden items stay in the underlying data
# but are excluded from the displayed pivot table output
workbook.save("output_pivot_filtered.xlsx")

jpype.shutdownJVM()

Summary

Aspose.Cells for Python via Java provides a complete set of pivot table filtering capabilities that match those found in Microsoft Excel. Label, date, and value filters cover the most common analytical scenarios, while the top 10 filter handles ranking reports. When the filtering rule is irregular, the PivotItem.is_hidden property offers a flexible, item-level fallback. Combining these strategies — for example, applying a label filter and then hiding specific items — allows you to build precisely targeted pivot table reports entirely from code.

Documentation – Add Pivot Table Row and Column Fields in Aspose.Cells for Python via Java