Agregar campos de filtro a una tabla dinámica en Aspose.Cells para .NET

Introducción

Un campo de filtro es un campo dinámico que controla qué subconjunto de los datos de origen muestra el cuerpo de la tabla dinámica. Los usuarios finales lo ven como un menú desplegable en la parte superior de una tabla dinámica renderizada en Excel, y al seleccionar uno de los elementos de página disponibles, el cuerpo de la tabla dinámica se reconstruye de modo que solo se resumen los registros que pertenecen a ese elemento de página. Un campo dinámico se convierte en un campo de filtro cuando se registra como PivotFieldType.PAGE en lugar de PivotFieldType.ROW, PivotFieldType.COLUMN, o PivotFieldType.DATA.

Un campo de filtro puede operar con dos comportamientos. En el comportamiento predeterminado de selección única, solo un elemento de página es visible a la vez, por lo que el cuerpo de la tabla dinámica resume exactamente un subconjunto. En el comportamiento de selección múltiple, el campo expone una lista de casillas de verificación, y el cuerpo de la tabla dinámica resume la unión de cada elemento de página marcado. La misma fuente de campo puede moverse de un lado a otro entre estos comportamientos alternando una sola propiedad.

Aspose.Cells for Python via .NET expone dos formas equivalentes de registrar un campo de filtro. La API de alto nivel es PivotTable.add_field_to_area(PivotFieldType.PAGE, "field_name"), que toma el nombre de la columna de origen y agrega el campo en una sola llamada. La API de bajo nivel es PivotTable.page_fields.add(PivotField), que se utiliza cuando ya tiene una referencia a PivotField y desea agregar la misma instancia de campo al área de filtro. Ambas API terminan poblando la misma colección page_fields, y el resto de este artículo demuestra cómo elegir entre ellas y cómo controlar cada modo de filtrado.

Agregar un campo de filtro

Hay dos formas de registrar un campo dinámico en el área de filtro. La llamada de alto nivel toma el nombre de la columna de origen como una cadena de texto y es la ruta más común. La llamada de bajo nivel acepta una instancia existente de PivotField y es conveniente cuando el mismo objeto de campo debe reutilizarse en múltiples áreas dinámicas. Ambas llamadas colocan el campo en PivotTable.page_fields, tras lo cual aparece como el menú desplegable de página en la parte superior de la tabla dinámica renderizada.

Agregar un campo de filtro con add_field_to_area

El siguiente ejemplo construye un pequeño conjunto de datos de Fruta / Año / Cantidad, coloca una tabla dinámica en la celda E3 con Fruit en el área de filas, Amount en el área de datos y Year en el área de filtro, actualiza la tabla dinámica y guarda el libro de trabajo.

import aspose.cells as ac

# Crear un nuevo libro de trabajo
workbook = ac.Workbook()
worksheet = workbook.worksheets[0]
worksheet.name = "Data"

# Configurar la fila de encabezado
worksheet.cells["A1"].put_value("Fruit")
worksheet.cells["B1"].put_value("Year")
worksheet.cells["C1"].put_value("Amount")

# Poblar 9 filas de datos de muestra: Fruta, Año, Cantidad
data = [
    ["apple", 2020, 100],
    ["banana", 2021, 200],
    ["apple", 2021, 150],
    ["grape", 2020, 120],
    ["orange", 2022, 180],
    ["banana", 2020, 90],
    ["grape", 2021, 130],
    ["apple", 2022, 170],
    ["orange", 2021, 110]
]

for i in range(len(data)):
    worksheet.cells[i + 1, 0].put_value(data[i][0])
    worksheet.cells[i + 1, 1].put_value(data[i][1])
    worksheet.cells[i + 1, 2].put_value(data[i][2])

# Agregar una tabla dinámica anclada en la celda E3
pivot_index = worksheet.pivot_tables.add("A1:C10", "E3", "PivotTable1")
pivot_table = worksheet.pivot_tables[pivot_index]

# Agregar campos a sus áreas: Fruta como Fila, Cantidad como Dato, Año como Campo de página
pivot_table.add_field_to_area(ac.PivotFieldType.Row, "Fruit")
pivot_table.add_field_to_area(ac.PivotFieldType.Data, "Amount")
pivot_table.add_field_to_area(ac.PivotFieldType.Page, "Year")

# Actualizar y calcular los datos de la tabla dinámica
pivot_table.calculate_data()

# Guardar el libro de trabajo
workbook.save("pageFieldSample.xlsx")

Agregar un campo de filtro con page_fields.add

Cuando ya trabaja con una instancia de PivotField, puede pasarla directamente a PivotTable.page_fields.add. La tabla dinámica y el campo de filtro se construyen exactamente como en el escenario anterior; solo se reemplaza el registro final del área de filtro con la llamada a la API de bajo nivel.

import aspose.cells as ac

# — La tabla dinámica y el campo de página se construyen exactamente como en
#   Escenario 1a (datos Fruit/Year/Amount, pivote en E3, Fruit→Fila,
#   Amount→Datos). A continuación obtenemos el PivotField Year de la
#   colección BaseFields y lo pasamos a PageFields.Add — la
#   alternativa de bajo nivel a AddFieldToArea. El resultado es
#   funcionalmente idéntico al Escenario 1a.

workbook = ac.Workbook()
sheet = workbook.worksheets[0]

# Encabezados
sheet.cells["A1"].put_value("Fruit")
sheet.cells["B1"].put_value("Year")
sheet.cells["C1"].put_value("Amount")

# Datos de muestra (9 filas)
sheet.cells["A2"].put_value("apple");    sheet.cells["B2"].put_value("2020"); sheet.cells["C2"].put_value(100)
sheet.cells["A3"].put_value("apple");    sheet.cells["B3"].put_value("2021"); sheet.cells["C3"].put_value(150)
sheet.cells["A4"].put_value("apple");    sheet.cells["B4"].put_value("2022"); sheet.cells["C4"].put_value(200)
sheet.cells["A5"].put_value("grape");    sheet.cells["B5"].put_value("2020"); sheet.cells["C5"].put_value(300)
sheet.cells["A6"].put_value("grape");    sheet.cells["B6"].put_value("2021"); sheet.cells["C6"].put_value(400)
sheet.cells["A7"].put_value("grape");    sheet.cells["B7"].put_value("2022"); sheet.cells["C7"].put_value(500)
sheet.cells["A8"].put_value("blueberry"); sheet.cells["B8"].put_value("2020"); sheet.cells["C8"].put_value(250)
sheet.cells["A9"].put_value("blueberry"); sheet.cells["B9"].put_value("2021"); sheet.cells["C9"].put_value(350)
sheet.cells["A10"].put_value("blueberry");sheet.cells["B10"].put_value("2022"); sheet.cells["C10"].put_value(450)

# Agregar tabla dinámica en E3 cubriendo A1:C10
pivot_index = sheet.pivot_tables.add("E3", "A1:C10", "PivotTable1")
pivot_table = sheet.pivot_tables[pivot_index]

# Fruit -> Fila, Amount -> Datos (Year irá a Página abajo)
pivot_table.add_field_to_area(ac.PivotFieldType.ROW, "Fruit")
pivot_table.add_field_to_area(ac.PivotFieldType.DATA, "Amount")

# Enfoque de bajo nivel: tomar el PivotField Year existente de BaseFields
# y registrarlo en el área de Página mediante PageFields.Add(PivotField).
year_field = pivot_table.base_fields["Year"]
pivot_table.page_fields.add(year_field)

# Actualizar para que el nuevo campo de página se refleje en el libro guardado
pivot_table.calculate_data()

workbook.save("output.xlsx")

Filtrado de selección única (mostrando un elemento de página)

En el comportamiento predeterminado de selección única, el campo de filtro se renderiza como un único menú desplegable y el entero PivotField.current_page_item selecciona qué elemento de página controla el cuerpo de la tabla dinámica. Asignar un índice específico selecciona ese único elemento; asignar el centinela especial 0x7FFD (decimal 32765) borra el filtro para que todos los elementos de página se resuman a la vez. La selección única es el valor predeterminado; no necesita habilitarla explícitamente.

Mostrar todos los elementos

Establecer current_page_item al valor mágico 0x7FFD equivale a borrar el filtro de página: el cuerpo de la tabla dinámica resume cada elemento de página como si no se hubiera aplicado ningún filtro.

import aspose.cells as ac

# Crear un nuevo libro de trabajo
workbook = ac.Workbook()
sheet = workbook.worksheets[0]

# Poblar datos de Fruta/Año/Cantidad
sheet.cells["A1"].put_value("Fruit")
sheet.cells["B1"].put_value("Year")
sheet.cells["C1"].put_value("Amount")

data = [
    ["Apple", 2022, 100],
    ["Apple", 2023, 150],
    ["Banana", 2022, 80],
    ["Banana", 2023, 120],
    ["Cherry", 2022, 200],
    ["Cherry", 2023, 250]
]

for r in range(len(data)):
    for c in range(len(data[r])):
        sheet.cells[r + 1, c].put_value(data[r][c])

# Crear tabla dinámica en E3
pivot_tables = sheet.pivot_tables
index = pivot_tables.add("=A1:C7", "E3", "PivotTable1")
pivot_table = pivot_tables[index]

# Configurar campos dinámicos: Fruta→Fila, Cantidad→Dato, Año→Página
pivot_table.add_field_to_area(ac.PivotFieldType.Row, "Fruit")
pivot_table.add_field_to_area(ac.PivotFieldType.Data, "Amount")
pivot_table.add_field_to_area(ac.PivotFieldType.Page, "Year")

pivot_table.calculate_data()

# Limpiar el filtro de página para que cada elemento del campo de página sea visible.
# 0x7FFD (decimal 32765) es el valor centinela especial que significa "todos los elementos" —
# equivalente a seleccionar "(Todos)" en el menú desplegable del campo de página de Excel.
pivot_table.page_fields[0].current_page_item = 0x7FFD

workbook.save("output.xlsx")

Mostrar un elemento específico

Establecer current_page_item a un índice real selecciona solo ese elemento de página. El índice es la posición del elemento en la lista ordenada de elementos del campo de filtro, por lo que, por ejemplo, 1 selecciona el segundo elemento después de ordenar.

import aspose.cells as ac

# Crear libro de trabajo
workbook = ac.Workbook()
sheet = workbook.worksheets[0]
cells = sheet.cells

# Agregar datos de muestra (Fruta/Año/Monto)
cells["A1"].put_value("Fruit")
cells["B1"].put_value("Year")
cells["C1"].put_value("Amount")

cells["A2"].put_value("Apple")
cells["B2"].put_value("2020")
cells["C2"].put_value("100")

cells["A3"].put_value("Apple")
cells["B3"].put_value("2021")
cells["C3"].put_value("150")

cells["A4"].put_value("Banana")
cells["B4"].put_value("2020")
cells["C4"].put_value("200")

cells["A5"].put_value("Banana")
cells["B5"].put_value("2021")
cells["C5"].put_value("250")

# Agregar tabla dinámica en E3
pivot_tables = sheet.pivot_tables
pivot_index = pivot_tables.add("A1:C5", "E3", "PivotTable1")
pivot_table = pivot_tables[pivot_index]

# Agregar campos: Fruta→Fila, Monto→Datos, Año→Página
pivot_table.add_field_to_area(ac.PivotFieldType.ROW, "Fruit")
pivot_table.add_field_to_area(ac.PivotFieldType.DATA, "Amount")
pivot_table.add_field_to_area(ac.PivotFieldType.PAGE, "Year")

# Operaciones específicas del campo de página
pivot_table.page_fields[0].current_page_item = 1  # 1 = segundo elemento en orden ordenado (por ejemplo, "2021")

# Actualizar y calcular tabla dinámica
pivot_table.calculate_data()

workbook.save("output.xlsx")

Filtrado de selección múltiple

El filtrado de selección múltiple convierte el menú desplegable de página en una lista de casillas de verificación y permite al usuario final elegir varios elementos de página simultáneamente. Aspose.Cells expone dos propiedades que trabajan juntas. PivotField.is_multiple_item_selection_allowed debe establecerse en True antes de que la interfaz de selección múltiple surta efecto. Después de habilitarla, PivotItem.is_hidden controla qué elementos aparecen en la lista de casillas de verificación, por lo que puede mostrar todos los elementos o crear una lista blanca solo con elementos específicos.

El código a continuación habilita la selección múltiple en el mismo campo de filtro Year construido en el Escenario 1a, y luego muestra dos patrones: la Parte A muestra cada elemento de página dejando is_hidden establecido en False para cada entrada, mientras que la Parte B crea una lista blanca solo con los valores de origen que elija y oculta todo lo demás mediante un bloque if / elif que evalúa pivot_items[i].get_string_value().

import aspose.cells as ac

# — La tabla dinámica y el campo de página se construyen exactamente como en
#   el Escenario 1a (datos de Fruta/Año/Monto, pivote en E3, Fruta→Fila,
#   Monto→Datos, Año→Página mediante AddFieldToArea).
#   A continuación aplicamos filtrado de selección múltiple en el campo de página.

workbook = ac.Workbook()
sheet = workbook.worksheets[0]
cells = sheet.cells

# Datos de muestra: Fruta | Año | Monto
cells[0, 0].put_value("Fruit")
cells[0, 1].put_value("Year")
cells[0, 2].put_value("Amount")

data = [
    ["apple",  "2019", "100"],
    ["apple",  "2020", "150"],
    ["apple",  "2021", "200"],
    ["banana", "2019", "110"],
    ["banana", "2020", "160"],
    ["banana", "2021", "210"],
    ["grape",  "2019", "120"],
    ["grape",  "2020", "170"],
    ["grape",  "2021", "220"]
]

for i in range(len(data)):
    cells[i + 1, 0].put_value(data[i][0])
    cells[i + 1, 1].put_value(int(data[i][1]))
    cells[i + 1, 2].put_value(int(data[i][2]))

pivot_sheet = workbook.worksheets.add("Pivot")
pivots = pivot_sheet.pivot_tables
pivot_index = pivots.add("E3", "A1:C10", "PivotTable1")
pivot_table = pivots[pivot_index]

pivot_table.add_field_to_area(ac.PivotFieldType.ROW, "Fruit")
pivot_table.add_field_to_area(ac.PivotFieldType.DATA, "Amount")
pivot_table.add_field_to_area(ac.PivotFieldType.PAGE, "Year")

# — Habilitar selección múltiple en el campo de página
pivot_table.page_fields[0].is_multiple_item_selection_allowed = True

# Parte A — seleccionar TODOS los elementos (hacer visible cada elemento)
pivot_items = pivot_table.page_fields[0].pivot_items
for i in range(pivot_items.count):
    pivot_items[i].is_hidden = False

# Parte B — seleccionar solo elementos específicos por valor de origen
for i in range(pivot_items.count):
    value = pivot_items[i].get_string_value()
    if value == "2020" or value == "grape" or value == "blueberry":
        pivot_items[i].is_hidden = False
    else:
        pivot_items[i].is_hidden = True

pivot_table.calculate_data()

workbook.save("output.xlsx")

Nota: Al usar el filtrado de selección múltiple a través de PivotItem.is_hidden, al menos un PivotItem debe permanecer visible (is_hidden == False). Si todos los elementos están ocultos, Excel se bloquea al abrir el archivo o renderiza una tabla dinámica en blanco. Verifique siempre que su lista blanca de selección múltiple incluya al menos un elemento de sus datos de origen.

¿Qué API y qué modo debo usar?

La tabla a continuación resume cuándo usar cada API y modo para que pueda elegir la combinación correcta sin leer cada escenario en detalle.

Escenario / Caso de uso API recomendada Propiedad utilizada Notas
Agregar un campo de filtro por nombre de columna de origen (lo más común) PivotTable.add_field_to_area(PivotFieldType.PAGE, "field_name") n/a Alto nivel, una sola línea. Use esto a menos que necesite una referencia a PivotField.
Agregar un campo de filtro cuando ya tiene un objeto PivotField PivotTable.page_fields.add(PivotField) n/a Úselo cuando el objeto de campo se obtuvo en otro lugar o necesita reutilizarse.
Filtrar a un único elemento de página (modo predeterminado) PivotField.current_page_item establecer a un índice específico Por ejemplo, 1 muestra el segundo elemento en la lista ordenada.
Mostrar todos los elementos / borrar el filtro de página PivotField.current_page_item establecer a 0x7FFD El valor mágico 0x7FFD (decimal 32765) es el centinela para “todos los elementos”.
Habilitar la interfaz de selección múltiple en Excel PivotField.is_multiple_item_selection_allowed establecer a True Requerido antes de que cualquier llamada a is_hidden surta efecto.
Ocultar / mostrar elementos individuales en una lista de selección múltiple PivotItem.is_hidden establecer por elemento Al menos un elemento debe permanecer visible (is_hidden == False).
Administrar campos de valor de una tabla dinámica en Aspose.Cells para .NET Eliminar la tabla dinámica de una hoja de cálculo