PivotFieldCollection
PivotFieldCollection class
Represents a collection of all the PivotField objects in the PivotTable’s specific PivotFields type.
Methods
| Name | Description |
|---|---|
| add(pivotField) | Adds a PivotField Object to the specific type PivotFields. |
| addByBaseIndex(baseFieldIndex) | Adds a PivotField Object to the specific type PivotFields. |
| clear() | clear all fields of PivotFieldCollection |
| get() | Gets the PivotField Object at the specific index. |
| get() | Gets the PivotField Object of the specific name. |
| getCount() | Gets the count of the pivotFields. |
| getType() | Gets the PivotFields type. The value of the property is PivotFieldType integer constant. |
| iterator() | Gets an enumerator over the elements in this collection in proper sequence. |
| move(currPos, destPos) | Moves the PivotField from current position to destination position |
add(pivotField)
Adds a PivotField Object to the specific type PivotFields.
| Parameter | Type | Description |
|---|---|---|
| pivotField | PivotField | a PivotField Object. |
Returns: Number — Number the index of the PivotField Object in this PivotFields.
addByBaseIndex(baseFieldIndex)
Adds a PivotField Object to the specific type PivotFields.
| Parameter | Type | Description |
|---|---|---|
| baseFieldIndex | Number | field index in the base PivotFields. |
Returns: Number — Number the index of the PivotField Object in this PivotFields.
clear()
clear all fields of PivotFieldCollection
get()
Gets the PivotField Object at the specific index.
get()
Gets the PivotField Object of the specific name.
getCount()
Gets the count of the pivotFields.
getType()
Gets the PivotFields type. The value of the property is PivotFieldType integer constant.
iterator()
Gets an enumerator over the elements in this collection in proper sequence.
Returns: Iterator — Iterator enumerator
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 |