PivotFieldCollection
PivotFieldCollection class
Represents a collection of all the PivotField objects in the PivotTable’s specific PivotFields type.
Properties
| Name | Type | Description |
|---|---|---|
| Type | Number | Gets the PivotFields type. The value of the property is PivotFieldType integer constant. |
| Count | Number | Gets the count of the pivotFields. |
| Item (int) | PivotField | Gets the PivotField Object at the specific index. |
| Item (java.lang.String) | PivotField | Gets the PivotField Object of the specific name. |
Methods
| Name | Description |
|---|---|
| iterator | Gets an enumerator over the elements in this collection in proper sequence. |
| addByBaseIndex | Adds a PivotField Object to the specific type PivotFields. |
| add | Adds a PivotField Object to the specific type PivotFields. |
| clear | clear all fields of PivotFieldCollection |
| move | Moves the PivotField from current position to destination position |
PivotFieldCollection.Type property
Gets the PivotFields type. The value of the property is PivotFieldType integer constant.
Type: Number
PivotFieldCollection.Count property
Gets the count of the pivotFields.
Type: Number
PivotFieldCollection.Item (int) property
Gets the PivotField Object at the specific index.
Type: PivotField
PivotFieldCollection.Item (java.lang.String) property
Gets the PivotField Object of the specific name.
Type: PivotField
iterator()
Gets an enumerator over the elements in this collection in proper sequence.
Returns: enumerator
addByBaseIndex(baseFieldIndex)
Adds a PivotField Object to the specific type PivotFields.
| Parameter | Type | Description |
|---|---|---|
| baseFieldIndex | Number | field index in the base PivotFields. |
Returns: the index of the PivotField Object in this PivotFields.
add(pivotField)
Adds a PivotField Object to the specific type PivotFields.
| Parameter | Type | Description |
|---|---|---|
| pivotField | PivotField | a PivotField Object. |
Returns: the index of the PivotField Object in this PivotFields.
clear()
clear all fields of PivotFieldCollection
move(currPos, destPos)
Moves the PivotField from current position to destination position
| Parameter | Type | Description |
|---|---|---|
| currPos | Number | Current position of PivotField based on zero |
| destPos | Number | Destination position of PivotField based on zero |