com.aspose.cells

Class PivotFilterCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.PivotFilterCollection

All Implemented Interfaces:

java.lang.Iterable

public class PivotFilterCollection
extends CollectionBase

Represents a collection of all the PivotFilter objects

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int fieldIndex, int type) Deprecated. Use PivotFilterCollection.AddValueFilter(),AddTop10Filter(),AddLabelFilter() and AddDateFilter() methods,instead.
PivotFilter	addDateFilter(int baseFieldIndex, int type, DateTime dateTime1, DateTime dateTime2) Filters by date setting of row or column pivot field.
PivotFilter	addLabelFilter(int baseFieldIndex, int type, java.lang.String label1, java.lang.String label2) Filters by captions of row or column pivot field.
PivotFilter	addTop10Filter(int baseFieldIndex, int valueFieldIndex, int type, boolean isTop, int itemCount) Filters by values of data pivot field.
PivotFilter	addValueFilter(int baseFieldIndex, int valueFieldIndex, int type, double value1, double value2) Filters by values of data pivot field.
void	clearFilter(int fieldIndex) Clear PivotFilter from the specific PivotField
PivotFilter	get(int index) Gets the pivotfilter object at the specific index.

Methods inherited from class com.aspose.cells.CollectionBase

add, clear, contains, getCount, indexOf, iterator, removeAt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public PivotFilter get(int index)

Gets the pivotfilter object at the specific index.

Overrides:

get in class CollectionBase

Parameters:

index - Specified position index.

Returns:

The item at specified position.

add

public int add(int fieldIndex,
      int type)

Deprecated. Use PivotFilterCollection.AddValueFilter(),AddTop10Filter(),AddLabelFilter() and AddDateFilter() methods,instead.

Adds a PivotFilter Object to the specific type

Remarks

NOTE: This method is now obsolete. Instead, please use PivotFilterCollection.AddValueFilter(),AddTop10Filter(),AddLabelFilter() and AddDateFilter() methods. This method will be removed 12 months later since November 2024. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

fieldIndex - the PivotField index

type - PivotFilterType. the PivotFilter type

Returns:

the index of the PivotFilter Object in this PivotFilterCollection.

addTop10Filter

public PivotFilter addTop10Filter(int baseFieldIndex,
                         int valueFieldIndex,
                         int type,
                         boolean isTop,
                         int itemCount)

Filters by values of data pivot field.

Parameters:

baseFieldIndex - The index of field in the source.

valueFieldIndex - The index of data field in the data region.

type - PivotFilterType. The type of filtering data. Only can be Count,Sum and Percent.

isTop - Indicates whether filter from top or bottom

itemCount - The item count

addValueFilter

public PivotFilter addValueFilter(int baseFieldIndex,
                         int valueFieldIndex,
                         int type,
                         double value1,
                         double value2)

Filters by values of data pivot field.

Parameters:

baseFieldIndex - The index of field in the source.

valueFieldIndex - The index of value field in the value region.

type - PivotFilterType. The type of filtering data.

value1 - The value of filter condition

value2 - The upper-bound value of between filter condition

addLabelFilter

public PivotFilter addLabelFilter(int baseFieldIndex,
                         int type,
                         java.lang.String label1,
                         java.lang.String label2)

Filters by captions of row or column pivot field.

Parameters:

baseFieldIndex - The index of field in the source.

type - PivotFilterType. The type of filtering data.

label1 - The label of filter condition

label2 - The upper-bound label of between filter condition

addDateFilter

public PivotFilter addDateFilter(int baseFieldIndex,
                        int type,
                        DateTime dateTime1,
                        DateTime dateTime2)

Filters by date setting of row or column pivot field.

Parameters:

baseFieldIndex - The index of field in the source.

type - PivotFilterType. The type of filtering data.

dateTime1 - The date label of filter condition

dateTime2 - The upper-bound date label of between filter condition

clearFilter

public void clearFilter(int fieldIndex)

Clear PivotFilter from the specific PivotField

Parameters:

fieldIndex - the PivotField index