public interface IDataBar
| Modifier and Type | Method and Description |
|---|---|
void |
delete()
Deletes this conditional format.
|
void |
fromJson(java.lang.String json)
Generates the conditional format from the json string.
|
IRange |
getAppliesTo()
Returns a Range object that specifies the cell range to which the formatting
rule is applied.
|
IFormatColor |
getAxisColor()
Gets the color of the axis for cells with conditional formatting as data
bars.
|
DataBarAxisPosition |
getAxisPosition()
Gets or sets the position of the axis of the data bars specified by a
conditional formatting rule.
|
IDataBarBorder |
getBarBorder()
Gets an object that specifies the border of a data bar.
|
IFormatColor |
getBarColor()
Returns a FormatColor object that you can use to modify the color of the bars
in a data bar conditional format.
|
DataBarFillType |
getBarFillType()
Gets how a data bar is filled with color.
|
DataBarDirection |
getDirection()
Gets the direction the data bar is displayed.
|
IConditionValue |
getMaxPoint()
Returns a
IConditionValue object that specifies how the longest bar
is evaluated for a data bar conditional format. |
IConditionValue |
getMinPoint()
Returns a ConditionValue object that specifies how the shortest bar is
evaluated for a data bar conditional format.
|
INegativeBarFormat |
getNegativeBarFormat()
Gets the NegativeBarFormat object associated with a data bar conditional
formatting rule.
|
int |
getPercentMax()
Returns an Integer value that specifies the length of the longest data bar as
a percentage of cell width.
|
int |
getPercentMin()
Returns an Integer value that specifies the length of the shortest data bar
as a percentage of cell width.
|
int |
getPriority()
Returns the priority value of the conditional formatting rule.
|
boolean |
getShowValue()
Returns a Boolean value that specifies if the value in the cell is displayed
if the data bar conditional format is applied to the range.
|
boolean |
getStopIfTrue()
Returns a Boolean value that determines if additional formatting rules on the
cell should be evaluated if the current rule evaluates to True.
|
FormatConditionType |
getType()
Returns the type of this conditional format.
|
void |
setAppliesTo(IRange value)
Sets a Range object that specifies the cell range to which the formatting
rule is applied.
|
void |
setAxisPosition(DataBarAxisPosition value)
Sets the position of the axis of the data bars specified by a conditional
formatting rule.
|
void |
setBarFillType(DataBarFillType value)
Sets how a data bar is filled with color.
|
void |
setDirection(DataBarDirection value)
Sets the direction the data bar is displayed.
|
void |
setFirstPriority()
Sets the priority value for this conditional formatting rule to "1" so that
it will be evaluated before all other rules on the worksheet.
|
void |
setLastPriority()
Sets the evaluation order for this conditional formatting rule so it is
evaluated after all other rules on the worksheet.
|
void |
setPercentMax(int value)
Sets an Integer value that specifies the length of the longest data bar as a
percentage of cell width.
|
void |
setPercentMin(int value)
Sets an Integer value that specifies the length of the shortest data bar as a
percentage of cell width.
|
void |
setPriority(int value)
Sets the priority value of the conditional formatting rule.
|
void |
setShowValue(boolean value)
Sets a Boolean value that specifies if the value in the cell is displayed if
the data bar conditional format is applied to the range.
|
java.lang.String |
toJson()
Generates a json string from the conditional format.
|
IRange getAppliesTo()
void setAppliesTo(IRange value)
IFormatColor getAxisColor()
DataBarAxisPosition getAxisPosition()
void setAxisPosition(DataBarAxisPosition value)
IDataBarBorder getBarBorder()
IFormatColor getBarColor()
DataBarFillType getBarFillType()
void setBarFillType(DataBarFillType value)
DataBarDirection getDirection()
void setDirection(DataBarDirection value)
IConditionValue getMaxPoint()
IConditionValue object that specifies how the longest bar
is evaluated for a data bar conditional format.IConditionValue getMinPoint()
INegativeBarFormat getNegativeBarFormat()
int getPercentMax()
void setPercentMax(int value)
int getPercentMin()
void setPercentMin(int value)
int getPriority()
When setting the priority, the value must be a positive integer between 1 and the total number of conditional formatting rules on the worksheet. The priority must be a unique value for all rules on the worksheet, so changing the priority for the specified conditional formatting rule may cause the priority value of the other rules on the worksheet to be shifted.
void setPriority(int value)
When setting the priority, the value must be a positive integer between 1 and the total number of conditional formatting rules on the worksheet. The priority must be a unique value for all rules on the worksheet, so changing the priority for the specified conditional formatting rule may cause the priority value of the other rules on the worksheet to be shifted.
boolean getShowValue()
void setShowValue(boolean value)
boolean getStopIfTrue()
FormatConditionType getType()
void delete()
void setFirstPriority()
void setLastPriority()
void fromJson(java.lang.String json)
json - the json stringjava.lang.String toJson()