Class X14DataBar
java.lang.Object
com.independentsoft.office.spreadsheet.extensions.X14DataBar
Represents a data bar rule definition (x14:dataBar element).
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Gets the axis color.Gets the axis position ("automatic", "middle" or "none").Gets whether the data bar has a border.Gets the border color.Gets the bar direction ("context", "leftToRight" or "rightToLeft").Gets whether the data bar uses a gradient fill.Gets the maximum bar length as a percentage of the cell width.Gets the minimum bar length as a percentage of the cell width.Gets whether negative bars use the positive border color.Gets whether negative bars use the positive fill color.Gets the border color for negative values.Gets the fill color for negative values.Gets the value objects defining the minimum and maximum thresholds.voidsetAxisColor(X14Color axisColor)Sets the axis color.voidsetAxisPosition(String axisPosition)Sets the axis position ("automatic", "middle" or "none").voidSets whether the data bar has a border.voidsetBorderColor(X14Color borderColor)Sets the border color.voidsetDirection(String direction)Sets the bar direction ("context", "leftToRight" or "rightToLeft").voidsetGradient(Boolean gradient)Sets whether the data bar uses a gradient fill.voidsetMaxLength(Integer maxLength)Sets the maximum bar length as a percentage of the cell width.voidsetMinLength(Integer minLength)Sets the minimum bar length as a percentage of the cell width.voidsetNegativeBarBorderColorSameAsPositive(Boolean negativeBarBorderColorSameAsPositive)Sets whether negative bars use the positive border color.voidsetNegativeBarColorSameAsPositive(Boolean negativeBarColorSameAsPositive)Sets whether negative bars use the positive fill color.voidsetNegativeBorderColor(X14Color negativeBorderColor)Sets the border color for negative values.voidsetNegativeFillColor(X14Color negativeFillColor)Sets the fill color for negative values.toString()
-
Constructor Details
-
X14DataBar
public X14DataBar()Instantiates a new x14 data bar.
-
-
Method Details
-
clone
-
toString
-
getMinLength
Gets the minimum bar length as a percentage of the cell width.- Returns:
- the minimum bar length
-
setMinLength
Sets the minimum bar length as a percentage of the cell width.- Parameters:
minLength- the new minimum bar length
-
getMaxLength
Gets the maximum bar length as a percentage of the cell width.- Returns:
- the maximum bar length
-
setMaxLength
Sets the maximum bar length as a percentage of the cell width.- Parameters:
maxLength- the new maximum bar length
-
getBorder
Gets whether the data bar has a border.- Returns:
- whether the data bar has a border
-
setBorder
Sets whether the data bar has a border.- Parameters:
border- the new border flag
-
getGradient
Gets whether the data bar uses a gradient fill.- Returns:
- whether the data bar uses a gradient fill
-
setGradient
Sets whether the data bar uses a gradient fill.- Parameters:
gradient- the new gradient flag
-
getDirection
Gets the bar direction ("context", "leftToRight" or "rightToLeft").- Returns:
- the bar direction
-
setDirection
Sets the bar direction ("context", "leftToRight" or "rightToLeft").- Parameters:
direction- the new bar direction
-
getNegativeBarColorSameAsPositive
Gets whether negative bars use the positive fill color.- Returns:
- whether negative bars use the positive fill color
-
setNegativeBarColorSameAsPositive
Sets whether negative bars use the positive fill color.- Parameters:
negativeBarColorSameAsPositive- the new negative bar color same as positive flag
-
getNegativeBarBorderColorSameAsPositive
Gets whether negative bars use the positive border color.- Returns:
- whether negative bars use the positive border color
-
setNegativeBarBorderColorSameAsPositive
Sets whether negative bars use the positive border color.- Parameters:
negativeBarBorderColorSameAsPositive- the new negative bar border color same as positive flag
-
getAxisPosition
Gets the axis position ("automatic", "middle" or "none").- Returns:
- the axis position
-
setAxisPosition
Sets the axis position ("automatic", "middle" or "none").- Parameters:
axisPosition- the new axis position
-
getValueObjects
Gets the value objects defining the minimum and maximum thresholds.- Returns:
- the value objects
-
getBorderColor
Gets the border color.- Returns:
- the border color
-
setBorderColor
Sets the border color.- Parameters:
borderColor- the new border color
-
getNegativeFillColor
Gets the fill color for negative values.- Returns:
- the fill color for negative values
-
setNegativeFillColor
Sets the fill color for negative values.- Parameters:
negativeFillColor- the new fill color for negative values
-
getNegativeBorderColor
Gets the border color for negative values.- Returns:
- the border color for negative values
-
setNegativeBorderColor
Sets the border color for negative values.- Parameters:
negativeBorderColor- the new border color for negative values
-
getAxisColor
Gets the axis color.- Returns:
- the axis color
-
setAxisColor
Sets the axis color.- Parameters:
axisColor- the new axis color
-