com.aspose.cells
Class DataBar

java.lang.Object
    extended by com.aspose.cells.DataBar

public class DataBar 
extends java.lang.Object

Describe the DataBar conditional formatting rule. This conditional formatting rule displays a gradated data bar in the range of cells.

Example:

//Instantiating a Workbook object
Workbook workbook = new Workbook();

Worksheet sheet = workbook.getWorksheets().get(0);

//Adds an empty conditional formatting
int index = sheet.getConditionalFormattings().add();

FormatConditionCollection fcs = sheet.getConditionalFormattings().get(index);

//Sets the conditional format range.
CellArea ca = new CellArea();

ca.StartRow = 0;

ca.EndRow = 2;

ca.StartColumn = 0;

ca.EndColumn = 0;

fcs.addArea(ca);

//Adds condition.
int idx = fcs.addCondtion(FormatConditionType.DATA_BAR);

fcs.addArea(ca);

FormatCondition cond = fcs.get(idx);

//Get Databar
DataBar dataBar = cond.getDataBar();

dataBar.setColor(Color.getOrange());

//Set Databar properties
dataBar.getMinCfvo().setType(FormatConditionValueType.PERCENTILE);

dataBar.getMinCfvo().setValue(30);

dataBar.setShowValue(false);

//Put Cell Values
Cell cell1 = sheet.getCells().get("A1");

cell1.putValue(10);

Cell cell2 = sheet.getCells().get("A2");

cell2.putValue(120);

Cell cell3 = sheet.getCells().get("A3");

cell3.putValue(260);

//Saving the Excel file
workbook.save("D:\\book1.xlsx");

Property Getters/Setters Summary
com.aspose.cells.ColorgetAxisColor()
voidsetAxisColor(com.aspose.cells.Color value)
           Gets the color of the axis for cells with conditional formatting as data bars.
intgetAxisPosition()
voidsetAxisPosition(int value)
           Gets or sets the position of the axis of the data bars specified by a conditional formatting rule. The value of the property is DataBarAxisPosition integer constant.
DataBarBordergetBarBorder()
           Gets an object that specifies the border of a data bar.
intgetBarFillType()
voidsetBarFillType(int value)
           Gets or sets how a data bar is filled with color. The value of the property is DataBarFillType integer constant.
com.aspose.cells.ColorgetColor()
voidsetColor(com.aspose.cells.Color value)
           Get or set this DataBar's Color.
intgetDirection()
voidsetDirection(int value)
           Gets or sets the direction the databar is displayed. The value of the property is TextDirectionType integer constant.
ConditionalFormattingValuegetMaxCfvo()
           Get or set this DataBar's max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.
intgetMaxLength()
voidsetMaxLength(int value)
           Represents the max length of data bar .
ConditionalFormattingValuegetMinCfvo()
           Get or set this DataBar's min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.
intgetMinLength()
voidsetMinLength(int value)
           Represents the min length of data bar .
NegativeBarFormatgetNegativeBarFormat()
           Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.
booleangetShowValue()
voidsetShowValue(boolean value)
           Get or set the flag indicating whether to show the values of the cells on which this data bar is applied. Default value is true.
 

Property Getters/Setters Detail

getAxisColor/setAxisColor

public com.aspose.cells.Color getAxisColor() / public void setAxisColor(com.aspose.cells.Color value)
Gets the color of the axis for cells with conditional formatting as data bars.

getAxisPosition/setAxisPosition

public int getAxisPosition() / public void setAxisPosition(int value)
Gets or sets the position of the axis of the data bars specified by a conditional formatting rule. The value of the property is DataBarAxisPosition integer constant.

getBarFillType/setBarFillType

public int getBarFillType() / public void setBarFillType(int value)
Gets or sets how a data bar is filled with color. The value of the property is DataBarFillType integer constant.

getDirection/setDirection

public int getDirection() / public void setDirection(int value)
Gets or sets the direction the databar is displayed. The value of the property is TextDirectionType integer constant.

getBarBorder

public DataBarBorder getBarBorder()
Gets an object that specifies the border of a data bar.

getNegativeBarFormat

public NegativeBarFormat getNegativeBarFormat()
Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.

getMinCfvo

public ConditionalFormattingValue getMinCfvo()
Get or set this DataBar's min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.

getMaxCfvo

public ConditionalFormattingValue getMaxCfvo()
Get or set this DataBar's max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.

getColor/setColor

public com.aspose.cells.Color getColor() / public void setColor(com.aspose.cells.Color value)
Get or set this DataBar's Color.

getMinLength/setMinLength

public int getMinLength() / public void setMinLength(int value)
Represents the min length of data bar .

getMaxLength/setMaxLength

public int getMaxLength() / public void setMaxLength(int value)
Represents the max length of data bar .

getShowValue/setShowValue

public boolean getShowValue() / public void setShowValue(boolean value)
Get or set the flag indicating whether to show the values of the cells on which this data bar is applied. Default value is true.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.