Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class PivotFields

java.lang.Object
  extended by com.aspose.cells.PivotFields

public class PivotFields
extends java.lang.Object

Represents a collection of all the PivotField objects in the PivotTable's specific PivotFields type.


Method Summary
 int add(PivotField pivotField)
          Adds a PivotField Object to the specific type PivotFields.
 int addByBaseIndex(int baseFieldIndex)
          Adds a PivotField Object to the specific type PivotFields.
 PivotField get(int index)
          Gets the PivotField Object at the specific index.
 byte getType()
          Gets the PivotFields type.
 void remove(int index)
          Removes the PivotField Object at the specific index from the specific type PivotFields.
 int size()
          Gets the number of the PiovtFields in the PivotFields.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getType

public byte getType()
Gets the PivotFields type.

Returns:
the PivotFields type.

get

public PivotField get(int index)
Gets the PivotField Object at the specific index.

Parameters:
index - index of the PivotTable object.
Returns:
the PivotField Object at the specific index.
Throws:
java.lang.IllegalArgumentException - if the index is out of range.

size

public int size()
Gets the number of the PiovtFields in the PivotFields.

Returns:
the number of the PiovtFields in the PivotFields.

addByBaseIndex

public int addByBaseIndex(int baseFieldIndex)
Adds a PivotField Object to the specific type PivotFields.

Parameters:
baseFieldIndex - field index in the base PivotFields.
Returns:
the index of the PivotField Object in this PivotFields.

add

public int add(PivotField pivotField)
Adds a PivotField Object to the specific type PivotFields.

Parameters:
pivotField - a PivotField Object.
Returns:
the index of the PivotField Object in this PivotFields.

remove

public void remove(int index)
Removes the PivotField Object at the specific index from the specific type PivotFields.

Parameters:
index - the PivotField Object at the specific index from the specific type PivotFields.