PivotFilter

PivotFilter class

Represents a PivotFilter in PivotFilter Collection.

class PivotFilter;

Methods

MethodDescription
getAutoFilter()Gets the autofilter of the pivot filter.
getFilterType()Gets the autofilter type of the pivot filter.
getFieldIndex()Gets the field index of the pivot 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.
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.
isNull()Checks whether the implementation object is null.

getAutoFilter()

Gets the autofilter of the pivot filter.

getAutoFilter() : AutoFilter;

Returns

AutoFilter

getFilterType()

Gets the autofilter type of the pivot filter.

getFilterType() : PivotFilterType;

Returns

PivotFilterType

getFieldIndex()

Gets the field index of the pivot filter.

getFieldIndex() : number;

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:

ParameterTypeDescription
valuestringThe 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:

ParameterTypeDescription
valuestringThe value to set.

getMeasureFldIndex()

Gets the measure field index of the pivot filter.

getMeasureFldIndex() : number;

setMeasureFldIndex(number)

Gets the measure field index of the pivot filter.

setMeasureFldIndex(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

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:

ParameterTypeDescription
valuenumberThe 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:

ParameterTypeDescription
valuestringThe 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:

ParameterTypeDescription
valuenumberThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;