com.aspose.cells

Class PivotFormatCondition

java.lang.Object

com.aspose.cells.PivotFormatCondition

public class PivotFormatCondition
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.getPivotFormatConditions().add();
         PivotFormatCondition pfc = pivot.getPivotFormatConditions().get(formatIndex);
         FormatConditionCollection fcc = pfc.getFormatConditions();
         fcc.addArea(pivot.getDataBodyRange());
         int idx = fcc.addCondition(FormatConditionType.CELL_VALUE);
         FormatCondition fc = fcc.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	addColumnAreaCondition(PivotField columnField) Adds PivotTable conditional format limit in the column fields.
void	addColumnAreaCondition(java.lang.String fieldName) Adds PivotTable conditional format limit in the column fields.
void	addDataAreaCondition(PivotField dataField) Adds PivotTable conditional format limit in the data fields.
void	addDataAreaCondition(java.lang.String fieldName) Adds PivotTable conditional format limit in the data fields.
void	addRowAreaCondition(PivotField rowField) Adds PivotTable conditional format limit in the row fields.
void	addRowAreaCondition(java.lang.String fieldName) Adds PivotTable conditional format limit in the row fields.
FormatConditionCollection	getFormatConditions() Get formatconditions for the pivot table condition format .
int	getRuleType() Gets rule type for the pivot table condition format .
int	getScopeType() Gets scope type for the pivot table condition format .
void	setConditionalAreas() Sets conditional areas of PivotFormatCondition object.
void	setRuleType(int value) Sets rule type for the pivot table condition format .
void	setScopeType(int value) Sets scope type for the pivot table condition format .

Methods inherited from class java.lang.Object

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

Method Detail

addDataAreaCondition

public void addDataAreaCondition(java.lang.String fieldName)

Adds PivotTable conditional format limit in the data fields.

Parameters:

fieldName - The name of PivotField.

addDataAreaCondition

public void addDataAreaCondition(PivotField dataField)

Adds PivotTable conditional format limit in the data fields.

Parameters:

dataField - The PivotField in the data fields.

addRowAreaCondition

public void addRowAreaCondition(java.lang.String fieldName)

Adds PivotTable conditional format limit in the row fields.

Parameters:

fieldName - The name of PivotField.

addRowAreaCondition

public void addRowAreaCondition(PivotField rowField)

Adds PivotTable conditional format limit in the row fields.

Parameters:

rowField - The PivotField in the row fields.

addColumnAreaCondition

public void addColumnAreaCondition(java.lang.String fieldName)

Adds PivotTable conditional format limit in the column fields.

Parameters:

fieldName - The name of PivotField.

addColumnAreaCondition

public void addColumnAreaCondition(PivotField columnField)

Adds PivotTable conditional format limit in the column fields.

Parameters:

columnField - The PivotField in the column fields.

setConditionalAreas

public void setConditionalAreas()

Sets conditional areas of PivotFormatCondition object.

getScopeType

public int getScopeType()

Gets scope type for the pivot table condition format .

See PivotConditionFormatScopeType.

setScopeType

public void setScopeType(int value)

Sets scope type for the pivot table condition 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.

getFormatConditions

public FormatConditionCollection getFormatConditions()

Get formatconditions for the pivot table condition format .