PivotShowValuesSetting

PivotShowValuesSetting class

Represents the settings about showing values as when the ShowDataAs calculation is in use.

class PivotShowValuesSetting;

Properties

PropertyTypeDescription
calculationTypePivotFieldDataDisplayFormatRepresents how to show values of a data field in the pivot report.
baseFieldIndexnumberRepresents the base field for a ShowDataAs calculation when the ShowDataAs calculation is in use.
baseItemPositionTypePivotItemPositionTypeRepresents type of the base pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute.
baseItemIndexnumberRepresents the custom index of the pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields.

Methods

MethodDescription
getCalculationType()@deprecated. Please use the ‘calculationType’ property instead. Represents how to show values of a data field in the pivot report.
setCalculationType(PivotFieldDataDisplayFormat)@deprecated. Please use the ‘calculationType’ property instead. Represents how to show values of a data field in the pivot report.
getBaseFieldIndex()@deprecated. Please use the ‘baseFieldIndex’ property instead. Represents the base field for a ShowDataAs calculation when the ShowDataAs calculation is in use.
setBaseFieldIndex(number)@deprecated. Please use the ‘baseFieldIndex’ property instead. Represents the base field for a ShowDataAs calculation when the ShowDataAs calculation is in use.
getBaseItemPositionType()@deprecated. Please use the ‘baseItemPositionType’ property instead. Represents type of the base pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute.
setBaseItemPositionType(PivotItemPositionType)@deprecated. Please use the ‘baseItemPositionType’ property instead. Represents type of the base pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute.
getBaseItemIndex()@deprecated. Please use the ‘baseItemIndex’ property instead. Represents the custom index of the pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields.
setBaseItemIndex(number)@deprecated. Please use the ‘baseItemIndex’ property instead. Represents the custom index of the pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields.
isNull()Checks whether the implementation object is null.

calculationType

Represents how to show values of a data field in the pivot report.

calculationType : PivotFieldDataDisplayFormat;

baseFieldIndex

Represents the base field for a ShowDataAs calculation when the ShowDataAs calculation is in use.

baseFieldIndex : number;

baseItemPositionType

Represents type of the base pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute.

baseItemPositionType : PivotItemPositionType;

baseItemIndex

Represents the custom index of the pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields.

baseItemIndex : number;

getCalculationType()

@deprecated. Please use the ‘calculationType’ property instead. Represents how to show values of a data field in the pivot report.

getCalculationType() : PivotFieldDataDisplayFormat;

Returns

PivotFieldDataDisplayFormat

setCalculationType(PivotFieldDataDisplayFormat)

@deprecated. Please use the ‘calculationType’ property instead. Represents how to show values of a data field in the pivot report.

setCalculationType(value: PivotFieldDataDisplayFormat) : void;

Parameters:

ParameterTypeDescription
valuePivotFieldDataDisplayFormatThe value to set.

getBaseFieldIndex()

@deprecated. Please use the ‘baseFieldIndex’ property instead. Represents the base field for a ShowDataAs calculation when the ShowDataAs calculation is in use.

getBaseFieldIndex() : number;

setBaseFieldIndex(number)

@deprecated. Please use the ‘baseFieldIndex’ property instead. Represents the base field for a ShowDataAs calculation when the ShowDataAs calculation is in use.

setBaseFieldIndex(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getBaseItemPositionType()

@deprecated. Please use the ‘baseItemPositionType’ property instead. Represents type of the base pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute.

getBaseItemPositionType() : PivotItemPositionType;

Returns

PivotItemPositionType

setBaseItemPositionType(PivotItemPositionType)

@deprecated. Please use the ‘baseItemPositionType’ property instead. Represents type of the base pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute.

setBaseItemPositionType(value: PivotItemPositionType) : void;

Parameters:

ParameterTypeDescription
valuePivotItemPositionTypeThe value to set.

getBaseItemIndex()

@deprecated. Please use the ‘baseItemIndex’ property instead. Represents the custom index of the pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields.

getBaseItemIndex() : number;

setBaseItemIndex(number)

@deprecated. Please use the ‘baseItemIndex’ property instead. Represents the custom index of the pivot item in the base field when the ShowDataAs calculation is in use. Valid only for data fields.

setBaseItemIndex(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;