asposecells.api

Class PivotArea

Presents the selected area of the PivotTable.

Constructor Summary
PivotArea(table)
Presents the selected area of the PivotTable.
 
Property Getters/Setters Summary
methodgetAxisType()
method
           Gets and sets the region of the PivotTable to which this rule applies. The value of the property is PivotFieldType integer constant.
methodgetFilters()
Gets all filters for this PivotArea.
methodisColumnGrandIncluded()
method
           Indicates whether the column grand total is included.
methodisOutline()
method
setOutline(value)
           Indicates whether the rule refers to an area that is in outline mode.
methodisRowGrandIncluded()
method
           Indicates whether the row grand total is included.
methodgetOnlyData()
method
           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.
methodgetOnlyLabel()
method
           Indicates whether only the data labels for an item selection are selected.
methodgetRuleType()
method
           Gets and sets the type of selection rule. The value of the property is PivotAreaType integer constant.
 
Method Summary
methodselect(axisType, fieldPosition, selectionType)
Select the area with filters.
 

    • Constructor Detail

      • PivotArea

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

      • getOnlyData/setOnlyData : boolean 

        boolean getOnlyData() / 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 

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

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

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

        int getAxisType() / 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 : int 

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

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

      • select

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