com.spire.xls
Class DataBar

java.lang.Object
  com.spire.xls.DataBar

public class DataBar
extends java.lang.Object

Represents a data bar conditional formating rule.

Constructor Summary

DataBar(IDataBar dataBar)

Method Summary

DataBarAxisPosition	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.
java.awt.Color	getBarColor() Gets the color of the bar in a data bar condition format.
DataBarFillType	getBarFillType() Gets an object that specifies the border of a data bar.
TextDirectionType	getDirection() Gets the direction the databar is displayed.
ConditionValue	getMaxPoint() The longest bar is evaluated for a data bar conditional format.
ConditionValue	getMinPoint() The shortest bar is evaluated for a data bar conditional format.
NegativeBarFormat	getNegativeBarFormat() Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.
int	getPercentMax() Gets a value that specifies the length of the longest data bar as a percentage of cell width.
int	getPercentMin() Gets a value that specifies the length of the shortest data bar as a percentage of cell width.
boolean	getShowValue() Gets a boolean value that specifies if the value in the cell is displayed.
void	setAxisPosition(DataBarAxisPosition value) Sets the position of the axis of the data bars specified by a conditional formatting rule.
void	setBarColor(java.awt.Color barColor) Sets the color of the bar in a data bar condition format.
void	setDirection(TextDirectionType value) Sets the direction the databar is displayed.
void	setPercentMax(int value) Sets a value that specifies the length of the longest data bar as a percentage of cell width.
void	setPercentMin(int value) Sets a value that specifies the length of the shortest data bar as a percentage of cell width.
void	setShowValue(boolean value) Sets a Boolean value that specifies if the value in the cell is displayed.

Constructor Detail

DataBar

public DataBar(IDataBar dataBar)

Method Detail

getMinPoint

public ConditionValue getMinPoint()

The shortest bar is evaluated for a data bar conditional format.

Returns:

getMaxPoint

public ConditionValue getMaxPoint()

The longest bar is evaluated for a data bar conditional format.

getBarColor

public java.awt.Color getBarColor()

Gets the color of the bar in a data bar condition format.

Returns:

setBarColor

public void setBarColor(java.awt.Color barColor)

Sets the color of the bar in a data bar condition format.

getPercentMax

public int getPercentMax()

Gets a value that specifies the length of the longest data bar as a percentage of cell width.

setPercentMax

public void setPercentMax(int value)

Sets a value that specifies the length of the longest data bar as a percentage of cell width.

getPercentMin

public int getPercentMin()

Gets a value that specifies the length of the shortest data bar as a percentage of cell width.

setPercentMin

public void setPercentMin(int value)

Sets a value that specifies the length of the shortest data bar as a percentage of cell width.

getShowValue

public boolean getShowValue()

Gets a boolean value that specifies if the value in the cell is displayed.

setShowValue

public void setShowValue(boolean value)

Sets a Boolean value that specifies if the value in the cell is displayed.

getAxisPosition

public DataBarAxisPosition getAxisPosition()

Gets the position of the axis of the data bars specified by a conditional formatting rule.

setAxisPosition

public void setAxisPosition(DataBarAxisPosition value)

Sets the position of the axis of the data bars specified by a conditional formatting rule.

getBarBorder

public DataBarBorder getBarBorder()

Gets an object that specifies the border of a data bar.

getBarFillType

public DataBarFillType getBarFillType()

Gets an object that specifies the border of a data bar.

getDirection

public TextDirectionType getDirection()

Gets the direction the databar is displayed.

setDirection

public void setDirection(TextDirectionType value)

Sets the direction the databar is displayed.

getNegativeBarFormat

public NegativeBarFormat getNegativeBarFormat()

Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.