PivotItem

PivotItem class

Represents a item in a PivotField report.

class PivotItem;

Properties

PropertyTypeDescription
isHiddenbooleanGets and Sets whether the pivot item is hidden.
positionnumberSpecifying the position index in all the PivotItems,not the PivotItems under the same parent node.
positionInSameParentNodenumberSpecifying the position index in the PivotItems under the same parent node.
isDetailHiddenbooleanGets and sets whether the detail of this pivot item is hidden.
isCalculatedItembooleanReadonly. Indicates whether this pivot item is a calculated formula item.
isMissingbooleanReadonly. Indicates whether the item is removed from the data source.
valueObjectReadonly. Gets the value of the pivot item
namestringGets the name of the pivot item.
indexnumberGets the index of the pivot item in cache field.

Methods

MethodDescription
isHidden()@deprecated. Please use the ‘isHidden’ property instead. Gets and Sets whether the pivot item is hidden.
setIsHidden(boolean)@deprecated. Please use the ‘isHidden’ property instead. Gets and Sets whether the pivot item is hidden.
getPosition()@deprecated. Please use the ‘position’ property instead. Specifying the position index in all the PivotItems,not the PivotItems under the same parent node.
setPosition(number)@deprecated. Please use the ‘position’ property instead. Specifying the position index in all the PivotItems,not the PivotItems under the same parent node.
getPositionInSameParentNode()@deprecated. Please use the ‘positionInSameParentNode’ property instead. Specifying the position index in the PivotItems under the same parent node.
setPositionInSameParentNode(number)@deprecated. Please use the ‘positionInSameParentNode’ property instead. Specifying the position index in the PivotItems under the same parent node.
isDetailHidden()@deprecated. Please use the ‘isDetailHidden’ property instead. Gets and sets whether the detail of this pivot item is hidden.
setIsDetailHidden(boolean)@deprecated. Please use the ‘isDetailHidden’ property instead. Gets and sets whether the detail of this pivot item is hidden.
isCalculatedItem()@deprecated. Please use the ‘isCalculatedItem’ property instead. Indicates whether this pivot item is a calculated formula item.
isMissing()@deprecated. Please use the ‘isMissing’ property instead. Indicates whether the item is removed from the data source.
getValue()@deprecated. Please use the ‘value’ property instead. Gets the value of the pivot item
getName()@deprecated. Please use the ’name’ property instead. Gets the name of the pivot item.
setName(string)@deprecated. Please use the ’name’ property instead. Gets the name of the pivot item.
getIndex()@deprecated. Please use the ‘index’ property instead. Gets the index of the pivot item in cache field.
setIndex(number)@deprecated. Please use the ‘index’ property instead. Gets the index of the pivot item in cache field.
move(number, boolean)Moves the item up or down
getFormula()Gets the formula of this calculated item. Only works when this item is calculated item.
getStringValue()Gets the string value of the pivot item If the value is null, it will return ""
getDoubleValue()Gets the double value of the pivot item If the value is null or not number ,it will return 0
getDateTimeValue()Gets the date time value of the pivot item If the value is null ,it will return DateTime.MinValue
isNull()Checks whether the implementation object is null.

isHidden

Gets and Sets whether the pivot item is hidden.

isHidden : boolean;

position

Specifying the position index in all the PivotItems,not the PivotItems under the same parent node.

position : number;

positionInSameParentNode

Specifying the position index in the PivotItems under the same parent node.

positionInSameParentNode : number;

isDetailHidden

Gets and sets whether the detail of this pivot item is hidden.

isDetailHidden : boolean;

isCalculatedItem

Readonly. Indicates whether this pivot item is a calculated formula item.

isCalculatedItem : boolean;

isMissing

Readonly. Indicates whether the item is removed from the data source.

isMissing : boolean;

Remarks

True means this value has benn removed from the data source.

value

Readonly. Gets the value of the pivot item

value : Object;

name

Gets the name of the pivot item.

name : string;

index

Gets the index of the pivot item in cache field.

index : number;

isHidden()

@deprecated. Please use the ‘isHidden’ property instead. Gets and Sets whether the pivot item is hidden.

isHidden() : boolean;

setIsHidden(boolean)

@deprecated. Please use the ‘isHidden’ property instead. Gets and Sets whether the pivot item is hidden.

setIsHidden(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getPosition()

@deprecated. Please use the ‘position’ property instead. Specifying the position index in all the PivotItems,not the PivotItems under the same parent node.

getPosition() : number;

setPosition(number)

@deprecated. Please use the ‘position’ property instead. Specifying the position index in all the PivotItems,not the PivotItems under the same parent node.

setPosition(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getPositionInSameParentNode()

@deprecated. Please use the ‘positionInSameParentNode’ property instead. Specifying the position index in the PivotItems under the same parent node.

getPositionInSameParentNode() : number;

setPositionInSameParentNode(number)

@deprecated. Please use the ‘positionInSameParentNode’ property instead. Specifying the position index in the PivotItems under the same parent node.

setPositionInSameParentNode(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

isDetailHidden()

@deprecated. Please use the ‘isDetailHidden’ property instead. Gets and sets whether the detail of this pivot item is hidden.

isDetailHidden() : boolean;

setIsDetailHidden(boolean)

@deprecated. Please use the ‘isDetailHidden’ property instead. Gets and sets whether the detail of this pivot item is hidden.

setIsDetailHidden(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isCalculatedItem()

@deprecated. Please use the ‘isCalculatedItem’ property instead. Indicates whether this pivot item is a calculated formula item.

isCalculatedItem() : boolean;

isMissing()

@deprecated. Please use the ‘isMissing’ property instead. Indicates whether the item is removed from the data source.

isMissing() : boolean;

Remarks

True means this value has benn removed from the data source.

getValue()

@deprecated. Please use the ‘value’ property instead. Gets the value of the pivot item

getValue() : Object;

getName()

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

getName() : string;

setName(string)

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

setName(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getIndex()

@deprecated. Please use the ‘index’ property instead. Gets the index of the pivot item in cache field.

getIndex() : number;

setIndex(number)

@deprecated. Please use the ‘index’ property instead. Gets the index of the pivot item in cache field.

setIndex(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

move(number, boolean)

Moves the item up or down

move(count: number, isSameParent: boolean) : void;

Parameters:

ParameterTypeDescription
countnumberThe number of moving up or down. /// Move the item up if this is less than zero; /// Move the item down if this is greater than zero.
isSameParentbooleanSpecifying whether moving operation is in the same parent node or not

getFormula()

Gets the formula of this calculated item. Only works when this item is calculated item.

getFormula() : string;

getStringValue()

Gets the string value of the pivot item If the value is null, it will return ""

getStringValue() : string;

getDoubleValue()

Gets the double value of the pivot item If the value is null or not number ,it will return 0

getDoubleValue() : number;

getDateTimeValue()

Gets the date time value of the pivot item If the value is null ,it will return DateTime.MinValue

getDateTimeValue() : Date;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;