PivotConditionalFormat
Inheritance: java.lang.Object
public class PivotConditionalFormat
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");
Methods
Method | Description |
---|---|
addCellArea(CellArea ca) | Adds an area based on pivot table view. |
addFieldArea(int axisType, PivotField field) | Adds an area of pivot field. |
addFieldArea(int axisType, String fieldName) | Adds an area of pivot field. |
applyTo(int row, int column, int scope) | Applies the conditional format to range. |
equals(Object arg0) | |
getCellAreas() | Gets all cell areas where this conditional format applies to. |
getClass() | |
getFormatConditions() | Get conditions for the pivot table conditional format . |
getPivotAreas() | Gets all pivot areas. |
getRuleType() | Gets rule type for the pivot table condition format . |
getScopeType() | Gets scope type for the pivot table conditional format . |
hashCode() | |
notify() | |
notifyAll() | |
setRuleType(int value) | Sets rule type for the pivot table condition format . |
setScopeType(int value) | Sets scope type for the pivot table conditional format . |
toString() | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
addCellArea(CellArea ca)
public void addCellArea(CellArea ca)
Adds an area based on pivot table view.
Parameters:
Parameter | Type | Description |
---|---|---|
ca | CellArea | The cell area. |
addFieldArea(int axisType, PivotField field)
public void addFieldArea(int axisType, PivotField field)
Adds an area of pivot field.
Parameters:
Parameter | Type | Description |
---|---|---|
axisType | int | PivotFieldType. The region type. |
field | PivotField | The pivot field. |
addFieldArea(int axisType, String fieldName)
public void addFieldArea(int axisType, String fieldName)
Adds an area of pivot field.
Parameters:
Parameter | Type | Description |
---|---|---|
axisType | int | PivotFieldType. The region type. |
fieldName | java.lang.String | The name of pivot field. |
applyTo(int row, int column, int scope)
public void applyTo(int row, int column, int scope)
Applies the conditional format to range. Only for the data region.
Parameters:
Parameter | Type | Description |
---|---|---|
row | int | The selected row. |
column | int | The selected column. |
scope | int | PivotConditionFormatScopeType. The scope |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
Parameter | Type | Description |
---|---|---|
arg0 | java.lang.Object |
Returns: boolean
getCellAreas()
public CellArea[] getCellAreas()
Gets all cell areas where this conditional format applies to.
Returns: com.aspose.cells.CellArea[] -
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getFormatConditions()
public FormatConditionCollection getFormatConditions()
Get conditions for the pivot table conditional format .
Returns: FormatConditionCollection
getPivotAreas()
public PivotAreaCollection getPivotAreas()
Gets all pivot areas.
Returns: PivotAreaCollection
getRuleType()
public int getRuleType()
Gets rule type for the pivot table condition format .
See PivotConditionFormatRuleType.
Returns: int
getScopeType()
public int getScopeType()
Gets scope type for the pivot table conditional format .
See PivotConditionFormatScopeType.
Returns: int
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setRuleType(int value)
public void setRuleType(int value)
Sets rule type for the pivot table condition format .
See PivotConditionFormatRuleType.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setScopeType(int value)
public void setScopeType(int value)
Sets scope type for the pivot table conditional format .
See PivotConditionFormatScopeType.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
Parameter | Type | Description |
---|---|---|
arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
Parameter | Type | Description |
---|---|---|
arg0 | long | |
arg1 | int |