PivotFilter

PivotFilter class

Represents a PivotFilter in PivotFilter Collection.

class PivotFilter;

Properties

Property	Type	Description
useWholeDay	boolean	Indicates whether uses whole days in its filtering criteria.
autoFilter	AutoFilter	Readonly. Gets the autofilter of the pivot filter.
filterType	PivotFilterType	Readonly. Gets the autofilter type of the pivot filter.
fieldIndex	number	Readonly. Gets the index of source field which this pivot filter is applied to.
filterCategory	FilterCategory	Readonly. Gets the category of this filter.
value1	string	Gets the string value1 of the label pivot filter.
value2	string	Gets the string value2 of the label pivot filter.
measureFldIndex	number	Gets the measure field index of the pivot filter.
valueFieldIndex	number	Gets the index of value field in the value region.
measureCubeFieldIndex	number	Readonly. 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.
memberPropertyFieldIndex	number	Gets the member property field index of the pivot filter.
name	string	Gets the name of the pivot filter.
evaluationOrder	number	Gets the Evaluation Order of the pivot filter.

Methods

Method	Description
getUseWholeDay()	@deprecated. Please use the ‘useWholeDay’ property instead. Indicates whether uses whole days in its filtering criteria.
setUseWholeDay(boolean)	@deprecated. Please use the ‘useWholeDay’ property instead. Indicates whether uses whole days in its filtering criteria.
getAutoFilter()	@deprecated. Please use the ‘autoFilter’ property instead. Gets the autofilter of the pivot filter.
getFilterType()	@deprecated. Please use the ‘filterType’ property instead. Gets the autofilter type of the pivot filter.
getFieldIndex()	@deprecated. Please use the ‘fieldIndex’ property instead. Gets the index of source field which this pivot filter is applied to.
getFilterCategory()	@deprecated. Please use the ‘filterCategory’ property instead. Gets the category of this filter.
getValue1()	@deprecated. Please use the ‘value1’ property instead. Gets the string value1 of the label pivot filter.
setValue1(string)	@deprecated. Please use the ‘value1’ property instead. Gets the string value1 of the label pivot filter.
getValue2()	@deprecated. Please use the ‘value2’ property instead. Gets the string value2 of the label pivot filter.
setValue2(string)	@deprecated. Please use the ‘value2’ property instead. Gets the string value2 of the label pivot filter.
getMeasureFldIndex()	@deprecated. Please use the ‘measureFldIndex’ property instead. Gets the measure field index of the pivot filter.
setMeasureFldIndex(number)	@deprecated. Please use the ‘measureFldIndex’ property instead. Gets the measure field index of the pivot filter.
getValueFieldIndex()	@deprecated. Please use the ‘valueFieldIndex’ property instead. Gets the index of value field in the value region.
setValueFieldIndex(number)	@deprecated. Please use the ‘valueFieldIndex’ property instead. Gets the index of value field in the value region.
getMeasureCubeFieldIndex()	@deprecated. Please use the ‘measureCubeFieldIndex’ property instead. 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()	@deprecated. Please use the ‘memberPropertyFieldIndex’ property instead. Gets the member property field index of the pivot filter.
setMemberPropertyFieldIndex(number)	@deprecated. Please use the ‘memberPropertyFieldIndex’ property instead. Gets the member property field index of the pivot filter.
getName()	@deprecated. Please use the ’name’ property instead. Gets the name of the pivot filter.
setName(string)	@deprecated. Please use the ’name’ property instead. Gets the name of the pivot filter.
getEvaluationOrder()	@deprecated. Please use the ’evaluationOrder’ property instead. Gets the Evaluation Order of the pivot filter.
setEvaluationOrder(number)	@deprecated. Please use the ’evaluationOrder’ property instead. 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.

useWholeDay

Indicates whether uses whole days in its filtering criteria.

useWholeDay : boolean;

autoFilter

Readonly. Gets the autofilter of the pivot filter.

autoFilter : 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.

filterType

Readonly. Gets the autofilter type of the pivot filter.

filterType : PivotFilterType;

fieldIndex

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

fieldIndex : number;

filterCategory

Readonly. Gets the category of this filter.

filterCategory : FilterCategory;

value1

Gets the string value1 of the label pivot filter.

value1 : string;

value2

Gets the string value2 of the label pivot filter.

value2 : string;

measureFldIndex

Gets the measure field index of the pivot filter.

measureFldIndex : 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.

valueFieldIndex

Gets the index of value field in the value region.

valueFieldIndex : number;

measureCubeFieldIndex

Readonly. 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.

measureCubeFieldIndex : number;

memberPropertyFieldIndex

Gets the member property field index of the pivot filter.

memberPropertyFieldIndex : number;

name

Gets the name of the pivot filter.

name : string;

evaluationOrder

Gets the Evaluation Order of the pivot filter.

evaluationOrder : number;

getUseWholeDay()

@deprecated. Please use the ‘useWholeDay’ property instead. Indicates whether uses whole days in its filtering criteria.

getUseWholeDay() : boolean;

setUseWholeDay(boolean)

@deprecated. Please use the ‘useWholeDay’ property instead. Indicates whether uses whole days in its filtering criteria.

setUseWholeDay(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAutoFilter()

@deprecated. Please use the ‘autoFilter’ property instead. Gets the autofilter of the pivot filter.

getAutoFilter() : AutoFilter;

Returns

AutoFilter

Remarks

getFilterType()

@deprecated. Please use the ‘filterType’ property instead. Gets the autofilter type of the pivot filter.

getFilterType() : PivotFilterType;

Returns

PivotFilterType

getFieldIndex()

@deprecated. Please use the ‘fieldIndex’ property instead. Gets the index of source field which this pivot filter is applied to.

getFieldIndex() : number;

getFilterCategory()

@deprecated. Please use the ‘filterCategory’ property instead. Gets the category of this filter.

getFilterCategory() : FilterCategory;

Returns

FilterCategory

getValue1()

@deprecated. Please use the ‘value1’ property instead. Gets the string value1 of the label pivot filter.

getValue1() : string;

setValue1(string)

@deprecated. Please use the ‘value1’ property instead. Gets the string value1 of the label pivot filter.

setValue1(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getValue2()

@deprecated. Please use the ‘value2’ property instead. Gets the string value2 of the label pivot filter.

getValue2() : string;

setValue2(string)

@deprecated. Please use the ‘value2’ property instead. Gets the string value2 of the label pivot filter.

setValue2(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getMeasureFldIndex()

@deprecated. Please use the ‘measureFldIndex’ property instead. Gets the measure field index of the pivot filter.

getMeasureFldIndex() : number;

Remarks

setMeasureFldIndex(number)

@deprecated. Please use the ‘measureFldIndex’ property instead. 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()

@deprecated. Please use the ‘valueFieldIndex’ property instead. Gets the index of value field in the value region.

getValueFieldIndex() : number;

setValueFieldIndex(number)

@deprecated. Please use the ‘valueFieldIndex’ property instead. 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()

@deprecated. Please use the ‘measureCubeFieldIndex’ property instead. 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()

@deprecated. Please use the ‘memberPropertyFieldIndex’ property instead. Gets the member property field index of the pivot filter.

getMemberPropertyFieldIndex() : number;

setMemberPropertyFieldIndex(number)

@deprecated. Please use the ‘memberPropertyFieldIndex’ property instead. 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()

@deprecated. Please use the ’name’ property instead. Gets the name of the pivot filter.

getName() : string;

setName(string)

@deprecated. Please use the ’name’ property instead. Gets the name of the pivot filter.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getEvaluationOrder()

@deprecated. Please use the ’evaluationOrder’ property instead. Gets the Evaluation Order of the pivot filter.

getEvaluationOrder() : number;

setEvaluationOrder(number)

@deprecated. Please use the ’evaluationOrder’ property instead. 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;