aspose.cells

Class PivotFieldCollection

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

Property Getters/Setters Summary
functiongetCount()
Gets the count of the pivotFields.
functiongetType()
Gets the PivotFields type. The value of the property is PivotFieldType integer constant.
functionget(index)
Gets the PivotField Object at the specific index.
functionget(name)
Gets the PivotField Object of the specific name.
 
Method Summary
functionadd(pivotField)
Adds a PivotField Object to the specific type PivotFields.
functionaddByBaseIndex(baseFieldIndex)
Adds a PivotField Object to the specific type PivotFields.
functionclear()
clear all fields of PivotFieldCollection
 

    • Property Getters/Setters Detail

      • getType : Number 

        function getType()
        
        Gets the PivotFields type. The value of the property is PivotFieldType integer constant.
      • getCount : Number 

        function getCount()
        
        Gets the count of the pivotFields.
      • get : PivotField 

        function get(index)
        
        Gets the PivotField Object at the specific index.
      • get : PivotField 

        function get(name)
        
        Gets the PivotField Object of the specific name.
    • Method Detail

      • addByBaseIndex

        function addByBaseIndex(baseFieldIndex)
        Adds a PivotField Object to the specific type PivotFields.
        Parameters:
        baseFieldIndex: Number - field index in the base PivotFields.
        Returns:
        the index of the PivotField Object in this PivotFields.
      • add

        function add(pivotField)
        Adds a PivotField Object to the specific type PivotFields.
        Parameters:
        pivotField: PivotField - a PivotField Object.
        Returns:
        the index of the PivotField Object in this PivotFields.
      • clear

        function clear()
        clear all fields of PivotFieldCollection