PivotItem

PivotItem class

Represents a item in a PivotField report.

class PivotItem;

Methods

Method	Description
isHidden()	Gets and Sets whether the pivot item is hidden.
setIsHidden(boolean)	Gets and Sets whether the pivot item is hidden.
getPosition()	Specifying the position index in all the PivotItems,not the PivotItems under the same parent node.
setPosition(number)	Specifying the position index in all the PivotItems,not the PivotItems under the same parent node.
getPositionInSameParentNode()	Specifying the position index in the PivotItems under the same parent node.
setPositionInSameParentNode(number)	Specifying the position index in the PivotItems under the same parent node.
isHideDetail()	Gets and Sets whether the pivot item hides detail.
setIsHideDetail(boolean)	Gets and Sets whether the pivot item hides detail.
isFormula()	Indicates whether this pivot item is a calculated formula item.
setIsFormula(boolean)	Indicates whether this pivot item is a calculated formula item.
isMissing()	Indicates whether the item is removed from the data source.
getValue()	Gets the value of the pivot item
getName()	Gets the name of the pivot item.
setName(string)	Gets the name of the pivot item.
getIndex()	Gets the index of the pivot item in cache field.
setIndex(number)	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;

setIsHidden(boolean)

Gets and Sets whether the pivot item is hidden.

setIsHidden(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getPosition()

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

getPosition() : number;

setPosition(number)

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

setPosition(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getPositionInSameParentNode()

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

getPositionInSameParentNode() : number;

setPositionInSameParentNode(number)

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

setPositionInSameParentNode(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isHideDetail()

Gets and Sets whether the pivot item hides detail.

isHideDetail() : boolean;

setIsHideDetail(boolean)

Gets and Sets whether the pivot item hides detail.

setIsHideDetail(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isFormula()

Indicates whether this pivot item is a calculated formula item.

isFormula() : boolean;

setIsFormula(boolean)

Indicates whether this pivot item is a calculated formula item.

setIsFormula(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isMissing()

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()

Gets the value of the pivot item

getValue() : object;

getName()

Gets the name of the pivot item.

getName() : string;

setName(string)

Gets the name of the pivot item.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getIndex()

Gets the index of the pivot item in cache field.

getIndex() : number;

setIndex(number)

Gets the index of the pivot item in cache field.

setIndex(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

move(number, boolean)

Moves the item up or down

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

Parameters:

Parameter	Type	Description
count	number	The 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.
isSameParent	boolean	Specifying 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;