asposecells.api

Constructor Detail

• PivotArea

  PivotArea(table)

  Presents the selected area of the PivotTable.

  Parameters:

  table: PivotTable -

Property Getters/Setters Detail

• getFilters : PivotAreaFilterCollection 

  PivotAreaFilterCollection getFilters()
  

  Gets all filters for this PivotArea.

• 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.

• selectField

   selectField(axisType, fieldName)

  Parameters:

  axisType - A PivotFieldType value.

• selectField

   selectField(axisType, field)

  Parameters:

  axisType - A PivotFieldType value.

• getCellAreas

  CellArea[] getCellAreas()