DataBar (Aspose.Cells for Java)

java.lang.Object
- 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.addCondition(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);
 
         dataBar.getBarBorder().setType(DataBarBorderType.SOLID);
 
         dataBar.getBarBorder().setColor(Color.getPlum());
 
          dataBar.setBarFillType(DataBarFillType.SOLID);
 
          dataBar.setAxisColor(Color.getRed());
 
          dataBar.setAxisPosition(DataBarAxisPosition.MIDPOINT);
 
          dataBar.getNegativeBarFormat().setColorType(DataBarNegativeColorType.COLOR);
 
          dataBar.getNegativeBarFormat().setColor(Color.getWhite());
 
          dataBar.getNegativeBarFormat().setBorderColorType(DataBarNegativeColorType.COLOR);
 
          dataBar.getNegativeBarFormat().setBorderColor(Color.getYellow());
 
         //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("book1.xlsx");

Method Summary

Methods
Modifier and Type	Method and Description
`Color`	`getAxisColor()` Gets the color of the axis for cells with conditional formatting as data bars.
`int`	`getAxisPosition()` Gets the position of the axis of the data bars specified by a conditional formatting rule.
`DataBarBorder`	`getBarBorder()` Gets an object that specifies the border of a data bar.
`int`	`getBarFillType()` Gets how a data bar is filled with color.
`Color`	`getColor()` Gets this DataBar's Color.
`int`	`getDirection()` Gets the direction the databar is displayed.
`ConditionalFormattingValue`	`getMaxCfvo()` Gets this DataBar's max value object.
`int`	`getMaxLength()` Represents the max length of data bar .
`ConditionalFormattingValue`	`getMinCfvo()` Gets this DataBar's min value object.
`int`	`getMinLength()` Represents the min length of data bar .
`NegativeBarFormat`	`getNegativeBarFormat()` Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.
`boolean`	`getShowValue()` Gets the flag indicating whether to show the values of the cells on which this data bar is applied.
`void`	`setAxisColor(Color value)` Gets the color of the axis for cells with conditional formatting as data bars.
`void`	`setAxisPosition(int value)` Sets the position of the axis of the data bars specified by a conditional formatting rule.
`void`	`setBarFillType(int value)` Sets how a data bar is filled with color.
`void`	`setColor(Color value)` Sets this DataBar's Color.
`void`	`setDirection(int value)` Sets the direction the databar is displayed.
`void`	`setMaxLength(int value)` Represents the max length of data bar .
`void`	`setMinLength(int value)` Represents the min length of data bar .
`void`	`setShowValue(boolean value)` Sets the flag indicating whether to show the values of the cells on which this data bar is applied.
`byte[]`	`toImage(Cell cell, ImageOrPrintOptions imgOpts)` Render data bar in cell to image byte array.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAxisColor
```
public Color getAxisColor()
```
    Gets the color of the axis for cells with conditional formatting as data bars.
  - setAxisColor
```
public void setAxisColor(Color value)
```
    Gets the color of the axis for cells with conditional formatting as data bars.
  - getAxisPosition
```
public int getAxisPosition()
```
    Gets the position of the axis of the data bars specified by a conditional formatting rule.
    See DataBarAxisPosition.
  - setAxisPosition
```
public void setAxisPosition(int value)
```
    Sets the position of the axis of the data bars specified by a conditional formatting rule.
    See DataBarAxisPosition.
  - getBarFillType
```
public int getBarFillType()
```
    Gets how a data bar is filled with color.
    See DataBarFillType.
  - setBarFillType
```
public void setBarFillType(int value)
```
    Sets how a data bar is filled with color.
    See DataBarFillType.
  - getDirection
```
public int getDirection()
```
    Gets the direction the databar is displayed.
    See TextDirectionType.
  - setDirection
```
public void setDirection(int value)
```
    Sets the direction the databar is displayed.
    See TextDirectionType.
  - 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()
```
    Gets this DataBar's min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.
  - getMaxCfvo
```
public ConditionalFormattingValue getMaxCfvo()
```
    Gets this DataBar's max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.
  - getColor
```
public Color getColor()
```
    Gets this DataBar's Color.
  - setColor
```
public void setColor(Color value)
```
    Sets this DataBar's Color.
  - getMinLength
```
public int getMinLength()
```
    Represents the min length of data bar .
  - setMinLength
```
public void setMinLength(int value)
```
    Represents the min length of data bar .
  - getMaxLength
```
public int getMaxLength()
```
    Represents the max length of data bar .
  - setMaxLength
```
public void setMaxLength(int value)
```
    Represents the max length of data bar .
  - getShowValue
```
public boolean getShowValue()
```
    Gets the flag indicating whether to show the values of the cells on which this data bar is applied. Default value is true.
  - setShowValue
```
public void setShowValue(boolean value)
```
    Sets the flag indicating whether to show the values of the cells on which this data bar is applied. Default value is true.
  - toImage
```
public byte[] toImage(Cell cell,
             ImageOrPrintOptions imgOpts)
```
    Render data bar in cell to image byte array.
    
    Parameters:
    cell - Indicate the data bar in which cell to be rendered
    imgOpts - ImageOrPrintOptions contains some property of output image
    
    Returns:

Class DataBar

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAxisColor

setAxisColor

getAxisPosition

setAxisPosition

getBarFillType

setBarFillType

getDirection

setDirection

getBarBorder

getNegativeBarFormat

getMinCfvo

getMaxCfvo

getColor

setColor

getMinLength

setMinLength

getMaxLength

setMaxLength

getShowValue

setShowValue

toImage