PivotFilter

PivotFilter class

Represents a PivotFilter in PivotFilter Collection.

class PivotFilter;

Methods

Method	Description
getUseWholeDay()	Indicates whether uses whole days in its filtering criteria.
setUseWholeDay(boolean)	Indicates whether uses whole days in its filtering criteria.
getAutoFilter()	Gets the autofilter of the pivot filter.
getFilterType()	Gets the autofilter type of the pivot filter.
getFieldIndex()	Gets the index of source field which this pivot filter is applied to.
getFilterCategory()	Gets the category of this filter.
getValue1()	Gets the string value1 of the label pivot filter.
setValue1(string)	Gets the string value1 of the label pivot filter.
getValue2()	Gets the string value2 of the label pivot filter.
setValue2(string)	Gets the string value2 of the label pivot filter.
getMeasureFldIndex()	Gets the measure field index of the pivot filter.
setMeasureFldIndex(number)	Gets the measure field index of the pivot filter.
getValueFieldIndex()	Gets the index of value field in the value region.
setValueFieldIndex(number)	Gets the index of value field in the value region.
getMeasureCubeFieldIndex()	Specifies the index of the measure cube field. this property is used only by filters in OLAP pivots and specifies on which measure a value filter should apply.
getMemberPropertyFieldIndex()	Gets the member property field index of the pivot filter.
setMemberPropertyFieldIndex(number)	Gets the member property field index of the pivot filter.
getName()	Gets the name of the pivot filter.
setName(string)	Gets the name of the pivot filter.
getEvaluationOrder()	Gets the Evaluation Order of the pivot filter.
setEvaluationOrder(number)	Gets the Evaluation Order of the pivot filter.
getTop10Value()	Gets top 10 setting of the filter.
getLabels()	Gets labels of the caption filter.
getNumberValues()	Gets values of the number filter.
getDateTimeValues()	Gets values of the number filter.
isNull()	Checks whether the implementation object is null.

getUseWholeDay()

Indicates whether uses whole days in its filtering criteria.

getUseWholeDay() : boolean;

setUseWholeDay(boolean)

Indicates whether uses whole days in its filtering criteria.

setUseWholeDay(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAutoFilter()

Gets the autofilter of the pivot filter.

getAutoFilter() : AutoFilter;

Returns

AutoFilter

Remarks

NOTE: This method is now obsolete. Instead, please use FilterLabel, FilterValue,FilterDate or FilterTop10 method. This method will be removed 12 months later since November 2024. Aspose apologizes for any inconvenience you may have experienced.

getFilterType()

Gets the autofilter type of the pivot filter.

getFilterType() : PivotFilterType;

Returns

PivotFilterType

getFieldIndex()

Gets the index of source field which this pivot filter is applied to.

getFieldIndex() : number;

getFilterCategory()

Gets the category of this filter.

getFilterCategory() : FilterCategory;

Returns

FilterCategory

getValue1()

Gets the string value1 of the label pivot filter.

getValue1() : string;

setValue1(string)

Gets the string value1 of the label pivot filter.

setValue1(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getValue2()

Gets the string value2 of the label pivot filter.

getValue2() : string;

setValue2(string)

Gets the string value2 of the label pivot filter.

setValue2(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getMeasureFldIndex()

Gets the measure field index of the pivot filter.

getMeasureFldIndex() : number;

Remarks

NOTE: This method is now obsolete. Instead, please use PivotFilter.ValueFieldIndex property. This method will be removed 12 months later since November 2024. Aspose apologizes for any inconvenience you may have experienced.

setMeasureFldIndex(number)

Gets the measure field index of the pivot filter.

setMeasureFldIndex(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

getValueFieldIndex()

Gets the index of value field in the value region.

getValueFieldIndex() : number;

setValueFieldIndex(number)

Gets the index of value field in the value region.

setValueFieldIndex(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getMeasureCubeFieldIndex()

Specifies the index of the measure cube field. this property is used only by filters in OLAP pivots and specifies on which measure a value filter should apply.

getMeasureCubeFieldIndex() : number;

getMemberPropertyFieldIndex()

Gets the member property field index of the pivot filter.

getMemberPropertyFieldIndex() : number;

setMemberPropertyFieldIndex(number)

Gets the member property field index of the pivot filter.

setMemberPropertyFieldIndex(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getName()

Gets the name of the pivot filter.

getName() : string;

setName(string)

Gets the name of the pivot filter.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getEvaluationOrder()

Gets the Evaluation Order of the pivot filter.

getEvaluationOrder() : number;

setEvaluationOrder(number)

Gets the Evaluation Order of the pivot filter.

setEvaluationOrder(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTop10Value()

Gets top 10 setting of the filter.

getTop10Value() : Top10Filter;

Returns

Top10Filter

getLabels()

Gets labels of the caption filter.

getLabels() : string[];

Returns

string[]

getNumberValues()

Gets values of the number filter.

getNumberValues() : number[];

Returns

number[]

getDateTimeValues()

Gets values of the number filter.

getDateTimeValues() : Date[];

Returns

Date[]

isNull()

Checks whether the implementation object is null.

isNull() : boolean;