aspose.cells

Class PivotArea

Presents the selected area of the PivotTable.

Constructor Summary
PivotArea(table)
Presents the selected area of the PivotTable.
 
Property Getters/Setters Summary
functiongetAxisType()
function
           Gets and sets the region of the PivotTable to which this rule applies. The value of the property is PivotFieldType integer constant.
functiongetFilters()
Gets all filters for this PivotArea.
functionisColumnGrandIncluded()
function
           Indicates whether the column grand total is included.
functionisOutline()
function
setOutline(value)
           Indicates whether the rule refers to an area that is in outline mode.
functionisRowGrandIncluded()
function
           Indicates whether the row grand total is included.
functiongetOnlyData()
function
           Indicates whether only the data values (in the data area of the view) for an item selection are selected and does not include the item labels.
functiongetOnlyLabel()
function
           Indicates whether only the data labels for an item selection are selected.
functiongetRuleType()
function
           Gets and sets the type of selection rule. The value of the property is PivotAreaType integer constant.
 
Method Summary
functionselect(axisType, fieldPosition, selectionType)
Select the area with filters.
 

    • Constructor Detail

      • PivotArea

        function PivotArea(table)
        Presents the selected area of the PivotTable.
        Parameters:
        table: PivotTable -
    • Property Getters/Setters Detail

      • getOnlyData/setOnlyData : boolean 

        function getOnlyData() / function setOnlyData(value)
        
        Indicates whether only the data values (in the data area of the view) for an item selection are selected and does not include the item labels.
      • getOnlyLabel/setOnlyLabel : boolean 

        function getOnlyLabel() / function setOnlyLabel(value)
        
        Indicates whether only the data labels for an item selection are selected.
      • isRowGrandIncluded/setRowGrandIncluded : boolean 

        function isRowGrandIncluded() / function setRowGrandIncluded(value)
        
        Indicates whether the row grand total is included.
      • isColumnGrandIncluded/setColumnGrandIncluded : boolean 

        function isColumnGrandIncluded() / function setColumnGrandIncluded(value)
        
        Indicates whether the column grand total is included.
      • getAxisType/setAxisType : Number 

        function getAxisType() / function setAxisType(value)
        
        Gets and sets the region of the PivotTable to which this rule applies. The value of the property is PivotFieldType integer constant.
      • getRuleType/setRuleType : Number 

        function getRuleType() / function setRuleType(value)
        
        Gets and sets the type of selection rule. The value of the property is PivotAreaType integer constant.
      • isOutline/setOutline : boolean 

        function isOutline() / function setOutline(value)
        
        Indicates whether the rule refers to an area that is in outline mode.
    • Method Detail

      • select

        function select(axisType, fieldPosition, selectionType)
        Select the area with filters.
        Parameters:
        axisType: Number - A PivotFieldType value. The region of the PivotTable to which this rule applies.
        fieldPosition: Number - Position of the field within the axis to which this rule applies.
        selectionType: Number - A PivotTableSelectionType value. Specifies what can be selected in a PivotTable during a structured selection.