com.aspose.cells

Class PivotConditionalFormat

java.lang.Object

com.aspose.cells.PivotConditionalFormat

public class PivotConditionalFormat
extends java.lang.Object

Represents a PivotTable Format Condition in PivotFormatCondition Collection.

Example

 
         Workbook book = new Workbook();
         Worksheet sheet = book.getWorksheets().get(0);
         Cells cells = sheet.getCells();
         cells.get(0, 0).setValue("fruit");
         cells.get(1, 0).setValue("grape");
         cells.get(2, 0).setValue("blueberry");
         cells.get(3, 0).setValue("kiwi");
         cells.get(4, 0).setValue("cherry");
         cells.get(5, 0).setValue("grape");
         cells.get(6, 0).setValue("blueberry");
         cells.get(7, 0).setValue("kiwi");
         cells.get(8, 0).setValue("cherry");
 
         cells.get(0, 1).setValue("year");
         cells.get(1, 1).setValue(2020);
         cells.get(2, 1).setValue(2020);
         cells.get(3, 1).setValue(2020);
         cells.get(4, 1).setValue(2020);
         cells.get(5, 1).setValue(2021);
         cells.get(6, 1).setValue(2021);
         cells.get(7, 1).setValue(2021);
         cells.get(8, 1).setValue(2021);
 
         cells.get(0, 2).setValue("amount");
         cells.get(1, 2).setValue(50);
         cells.get(2, 2).setValue(60);
         cells.get(3, 2).setValue(70);
         cells.get(4, 2).setValue(80);
         cells.get(5, 2).setValue(90);
         cells.get(6, 2).setValue(100);
         cells.get(7, 2).setValue(110);
         cells.get(8, 2).setValue(120);
 
         PivotTableCollection pivots = sheet.getPivotTables();
 
         int pivotIndex = pivots.add("=Sheet1!A1:C9", "A12", "TestPivotTable");
         PivotTable pivot = pivots.get(pivotIndex);
         pivot.addFieldToArea(PivotFieldType.ROW, "fruit");
         pivot.addFieldToArea(PivotFieldType.COLUMN, "year");
         pivot.addFieldToArea(PivotFieldType.DATA, "amount");
 
         pivot.setPivotTableStyleType(PivotTableStyleType.PIVOT_TABLE_STYLE_MEDIUM_10);
 
         //Add PivotFormatCondition
         int formatIndex = pivot.getConditionalFormats().add();
         PivotConditionalFormat pfc = pivot.getConditionalFormats().get(formatIndex);
         pfc.addFieldArea(PivotFieldType.DATA, pivot.getDataFields().get(0));
         int idx = pfc.getFormatConditions().addCondition(FormatConditionType.CELL_VALUE);
         FormatCondition fc = pfc.getFormatConditions().get(idx);
         fc.setFormula1("100");
         fc.setOperator(OperatorType.GREATER_OR_EQUAL);
         fc.getStyle().setBackgroundColor(Color.getRed());
 
         pivot.refreshData();
         pivot.calculateData();
 
         //do your business
 
         book.save("out.xlsx");
 

Method Summary

Methods

Modifier and Type	Method and Description
void	addCellArea(CellArea ca) Adds an area based on pivot table view.
void	addFieldArea(int axisType, PivotField field) Adds an area of pivot field.
void	addFieldArea(int axisType, java.lang.String fieldName) Adds an area of pivot field.
void	applyTo(int row, int column, int scope) Applies the conditional format to range.
CellArea[]	getCellAreas() Gets all cell areas where this conditional format applies to.
FormatConditionCollection	getFormatConditions() Get conditions for the pivot table conditional format .
PivotAreaCollection	getPivotAreas() Gets all pivot areas.
int	getRuleType() Gets rule type for the pivot table condition format .
int	getScopeType() Gets scope type for the pivot table conditional format .
void	setRuleType(int value) Sets rule type for the pivot table condition format .
void	setScopeType(int value) Sets scope type for the pivot table conditional format .

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCellAreas

public CellArea[] getCellAreas()

Gets all cell areas where this conditional format applies to.

Returns:

getPivotAreas

public PivotAreaCollection getPivotAreas()

Gets all pivot areas.

addCellArea

public void addCellArea(CellArea ca)

Adds an area based on pivot table view.

Parameters:

ca - The cell area.

applyTo

public void applyTo(int row,
           int column,
           int scope)

Applies the conditional format to range. Only for the data region.

Parameters:

row - The selected row.

column - The selected column.

scope - PivotConditionFormatScopeType. The scope

addFieldArea

public void addFieldArea(int axisType,
                java.lang.String fieldName)

Adds an area of pivot field.

Parameters:

axisType - PivotFieldType. The region type.

fieldName - The name of pivot field.

addFieldArea

public void addFieldArea(int axisType,
                PivotField field)

Adds an area of pivot field.

Parameters:

axisType - PivotFieldType. The region type.

field - The pivot field.

getFormatConditions

public FormatConditionCollection getFormatConditions()

Get conditions for the pivot table conditional format .

getScopeType

public int getScopeType()

Gets scope type for the pivot table conditional format .

See PivotConditionFormatScopeType.

setScopeType

public void setScopeType(int value)

Sets scope type for the pivot table conditional format .

See PivotConditionFormatScopeType.

getRuleType

public int getRuleType()

Gets rule type for the pivot table condition format .

See PivotConditionFormatRuleType.

setRuleType

public void setRuleType(int value)

Sets rule type for the pivot table condition format .

See PivotConditionFormatRuleType.