public final class PivotFilter extends Object
Modifier and Type | Method and Description |
---|---|
void |
clearFilter()
Clears the filter from this
PivotFilter . |
PivotField |
getField()
Gets the pivot field that this pivot filter applies to.
|
Filter |
getFilter()
Gets the filter settings applied to this pivot field or
null if no filter settings are applied to this pivot field. |
PivotField |
getMeasureField()
Gets the pivot field containing summary values being filtered.
|
CustomFilter |
setCustomFilter()
Sets a
CustomFilter to this field. |
DynamicFilter |
setDynamicFilter()
Sets a
DynamicFilter to this field. |
void |
setMeasureField(PivotField field)
Sets the pivot field containing summary values being filtered.
|
Top10Filter |
setTop10Filter()
Sets a
Top10Filter to this field. |
String |
toString()
Returns a
String that represents this PivotFilter instance. |
public void clearFilter()
PivotFilter
.public PivotField getField()
public Filter getFilter()
null
if no filter settings are applied to this pivot field.null
if no filter settings are applied to this pivot field.public PivotField getMeasureField()
public CustomFilter setCustomFilter()
Sets a CustomFilter
to this field.
CustomFilter
filters by a one or two conditions (operators and values).
Use members of a returned CustomFilter
to specify filter settings.
If this PivotFilter
already specifies a filter (getFilter()
is not equal to null
), it will be overridden.
CustomFilter
.public DynamicFilter setDynamicFilter()
Sets a DynamicFilter
to this field.
DynamicFilter
filters by a dynamic criteria that can change, either with the data itself (e.g., "above average") or with the current system date (e.g., show values for "today").
Use members of a returned DynamicFilter
to specify filter settings.
If this PivotFilter
already specifies a filter (getFilter()
is not equal to null
), it will be overridden.
DynamicFilter
.public void setMeasureField(PivotField field)
field
- The pivot field containing summary values being filtered.public Top10Filter setTop10Filter()
Sets a Top10Filter
to this field.
Top10Filter
filters by a top N (percent or number of items).
Use members of a returned Top10Filter
to specify filter settings.
If this PivotFilter
already specifies a filter (getFilter()
is not equal to null
), it will be overridden.
Top10Filter
.public String toString()
String
that represents this PivotFilter
instance.
This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).
toString
in class Object
String
that represents this PivotFilter
instance.© GemBox d.o.o. — All rights reserved.