IDataBar

Interface IDataBar

public interface IDataBar

表示数据条条件格式规则。

将数据条应用于区域，有助于直观显示每个单元格值相对于同一区域中其他值的关系。使用此接口可以配置数据条规则的外观和行为，例如其填充、颜色、坐标轴、方向和值显示。


 worksheet.getRange("A1:A5").setValue(new Object[][] {
     {1}, {2}, {3}, {4}, {5}
 });
 IDataBar dataBar = worksheet.getRange("A1:A5").getFormatConditions().addDatabar();
 dataBar.setBarFillType(DataBarFillType.Solid);
 dataBar.getBarColor().setColor(Color.GetGreen());
 dataBar.setShowValue(false);

Method Summary

Modifier and Type

Method

Description

void

delete()

删除此数据条条件格式规则。

void

fromJson(String json)

从 JSON 字符串加载数据条条件格式。

IRange

getAppliesTo()

获取此数据条条件格式规则所应用的单元格区域。

IFormatColor

getAxisColor()

获取具有数据条条件格式的单元格的坐标轴颜色。

DataBarAxisPosition

getAxisPosition()

获取此条件格式规则中数据条的坐标轴位置。

IDataBarBorder

getBarBorder()

获取一个指定数据条边框的对象。

IFormatColor

getBarColor()

获取此数据条条件格式规则中条形的颜色。

DataBarFillType

getBarFillType()

获取数据条如何用颜色填充。

DataBarDirection

getDirection()

获取数据条的显示方向。

IConditionValue

getMaxPoint()

获取指定如何计算数据条条件格式中最长条的 IConditionValue。

IConditionValue

getMinPoint()

获取 IConditionValue，该对象指定如何评估数据条条件格式的最短条。

INegativeBarFormat

getNegativeBarFormat()

获取此数据条条件格式规则的负条格式设置。

int

getPercentMax()

获取最长数据条的长度，以单元格宽度的百分比表示。

int

getPercentMin()

获取最短数据条的长度，以单元格宽度的百分比表示。

int

getPriority()

获取条件格式规则的优先级值。

boolean

getShowValue()

获取应用数据条条件格式时是否显示单元格值。

boolean

getStopIfTrue()

获取在此数据条规则计算结果为 true 后，是否继续计算单元格上的其他条件格式规则。

FormatConditionType

getType()

获取此条件格式的类型。

void

setAppliesTo(IRange value)

设置此数据条条件格式规则所应用的单元格区域。

void

setAxisPosition(DataBarAxisPosition value)

设置此条件格式规则中数据条的坐标轴位置。

void

setBarFillType(DataBarFillType value)

设置数据条如何用颜色填充。

void

setDirection(DataBarDirection value)

设置数据条的显示方向。

void

setFirstPriority()

将此条件格式规则的优先级值设置为 1，使其先于工作表上的所有其他规则进行评估。

void

setLastPriority()

设置此数据条规则的评估顺序，使其在工作表上的所有其他规则之后进行评估。

void

setPercentMax(int value)

设置一个 Integer 值，该值指定最长数据条的长度占单元格宽度的百分比。

void

setPercentMin(int value)

设置一个 Integer 值，该值指定最短数据条的长度占单元格宽度的百分比。

void

setPriority(int value)

设置条件格式规则的优先级值。

void

setShowValue(boolean value)

设置应用数据条条件格式时是否显示单元格值。

String

toJson()

从数据条规则生成 JSON 字符串。

Method Details
- getAppliesTo
  
  IRange getAppliesTo()
  获取此数据条条件格式规则所应用的单元格区域。
  使用此方法可以检索与当前数据条规则关联的 IRange。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); IRange appliesTo = dataBar.getAppliesTo(); String address = appliesTo.getAddress();
  Returns:
  
  此数据条规则所应用到的 IRange。
- setAppliesTo
  
  void setAppliesTo(IRange value)
  设置此数据条条件格式规则所应用的单元格区域。
  使用此方法可以更改与当前数据条规则关联的 IRange。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setAppliesTo(worksheet.getRange("B1:B3")); IRange appliesTo = dataBar.getAppliesTo();
  Parameters:
  
  value - 此数据条规则所应用到的 IRange。不得为 null。
- getAxisColor
  
  IFormatColor getAxisColor()
  获取具有数据条条件格式的单元格的坐标轴颜色。
  返回 IFormatColor 对象，可用于读取或修改数据条规则的坐标轴颜色。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{-10}, {0}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setAxisPosition(DataBarAxisPosition.Automatic); IFormatColor axisColor = dataBar.getAxisColor(); axisColor.setColor(Color.GetBlue());
  Returns:
  
  表示数据条规则坐标轴颜色的 IFormatColor 对象。
- getAxisPosition
  
  DataBarAxisPosition getAxisPosition()
  获取此条件格式规则中数据条的坐标轴位置。
  坐标轴位置控制每个单元格内正值和负值数据条的分隔方式。使用 DataBarAxisPosition.Automatic 可根据区域中的值放置坐标轴，使用 DataBarAxisPosition.Midpoint 可使坐标轴居中，使用 DataBarAxisPosition.None 可隐藏坐标轴。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{-10}, {0}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setAxisPosition(DataBarAxisPosition.Automatic); DataBarAxisPosition axisPosition = dataBar.getAxisPosition();
  Returns:
  
  指示数据条坐标轴显示位置的 DataBarAxisPosition 值。
- setAxisPosition
  
  void setAxisPosition(DataBarAxisPosition value)
  设置此条件格式规则中数据条的坐标轴位置。
  坐标轴位置控制每个单元格中正值和负值数据条的分隔方式。使用 DataBarAxisPosition.Automatic 可根据区域中的值放置坐标轴，使用 DataBarAxisPosition.Midpoint 可使坐标轴保持居中，或使用 DataBarAxisPosition.None 隐藏坐标轴。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{-10}, {0}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setAxisPosition(DataBarAxisPosition.Midpoint); DataBarAxisPosition axisPosition = dataBar.getAxisPosition();
  Parameters:
  
  value - 指定数据条坐标轴显示位置的 DataBarAxisPosition 值。
- getBarBorder
  
  IDataBarBorder getBarBorder()
  获取一个指定数据条边框的对象。
  使用返回的 IDataBarBorder 对象可以配置当前数据条的边框外观，例如边框类型和颜色。
  
  worksheet.getRange("A1:A5").setValue(new Object[][] {{1}, {2}, {3}, {4}, {5}}); IDataBar dataBar = worksheet.getRange("A1:A5").getFormatConditions().addDatabar(); IDataBarBorder border = dataBar.getBarBorder(); border.setType(DataBarBorderType.Solid);
  Returns:
  
  指定数据条边框的 IDataBarBorder 对象。
- getBarColor
  
  IFormatColor getBarColor()
  获取此数据条条件格式规则中条形的颜色。
  返回 IFormatColor 对象，可用于读取或修改应用于数据条的填充颜色。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); IFormatColor barColor = dataBar.getBarColor(); barColor.setColor(Color.GetRed());
  Returns:
  
  表示此数据条条件格式规则中条形颜色的 IFormatColor 对象。
- getBarFillType
  
  DataBarFillType getBarFillType()
  获取数据条如何用颜色填充。
  返回 DataBarFillType 值，该值指示数据条使用纯色填充还是渐变填充。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setBarFillType(DataBarFillType.Gradient); DataBarFillType fillType = dataBar.getBarFillType();
  Returns:
  
  指定数据条填充方式的 DataBarFillType 值。
- setBarFillType
  
  void setBarFillType(DataBarFillType value)
  设置数据条如何用颜色填充。
  使用 DataBarFillType 值可以指定数据条使用纯色填充还是渐变填充。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setBarFillType(DataBarFillType.Gradient);
  Parameters:
  
  value - 数据条填充类型。
- getDirection
  
  DataBarDirection getDirection()
  获取数据条的显示方向。
  返回的 DataBarDirection 值确定数据条是遵循当前上下文、从左到右显示，还是从右到左显示。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {20}, {30}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setDirection(DataBarDirection.RightToLeft); DataBarDirection direction = dataBar.getDirection();
  Returns:
  
  指定数据条显示方向的 DataBarDirection 值。
- setDirection
  
  void setDirection(DataBarDirection value)
  设置数据条的显示方向。
  使用此方法可控制数据条是从左到右呈现、从右到左呈现，还是根据工作表上下文呈现。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setDirection(DataBarDirection.RightToLeft); DataBarDirection direction = dataBar.getDirection();
  Parameters:
  
  value - 要应用的数据条方向。必须是有效的 DataBarDirection 值。
- getMaxPoint
  
  IConditionValue getMaxPoint()
  获取指定如何计算数据条条件格式中最长条的 IConditionValue。
  使用返回的对象可以配置数据条的最大阈值，例如数值限制或其他受支持的条件值类型。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {20}, {30}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); IConditionValue maxPoint = dataBar.getMaxPoint(); maxPoint.setType(ConditionValueTypes.Number); maxPoint.setValue(30);
  Returns:
  
  指定如何计算数据条条件格式中最长数据条的 IConditionValue 对象。
- getMinPoint
  
  IConditionValue getMinPoint()
  获取 IConditionValue，该对象指定如何评估数据条条件格式的最短条。
  使用返回的对象可以配置数据条的最小阈值，例如数值限制或其他受支持的条件值类型。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {20}, {30}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); IConditionValue minPoint = dataBar.getMinPoint(); minPoint.setType(ConditionValueTypes.Number); minPoint.setValue(10);
  Returns:
  
  指定如何计算数据条条件格式中最短数据条的 IConditionValue 对象。
- getNegativeBarFormat
  
  INegativeBarFormat getNegativeBarFormat()
  获取此数据条条件格式规则的负条格式设置。
  使用返回的 INegativeBarFormat 对象可以配置数据条中负值的填充颜色和边框颜色行为。
  
  worksheet.getRange("A1:A4").setValue(new Object[][] {{-10}, {-5}, {0}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A4").getFormatConditions().addDatabar(); INegativeBarFormat negativeBarFormat = dataBar.getNegativeBarFormat(); negativeBarFormat.setColorType(DataBarNegativeColorType.Color); negativeBarFormat.getColor().setColor(Color.GetRed());
  Returns:
  
  此数据条条件格式规则的 INegativeBarFormat 设置。
- getPercentMax
  
  int getPercentMax()
  获取最长数据条的长度，以单元格宽度的百分比表示。
  使用此属性可以确定条件格式规则中应用于数据条的最大可视长度。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setPercentMax(80); int percentMax = dataBar.getPercentMax();
  Returns:
  
  最长数据条的长度，以单元格宽度的百分比表示。使用此属性可以确定条件格式规则中应用于数据条的最大可视长度。
- setPercentMax
  
  void setPercentMax(int value)
  设置一个 Integer 值，该值指定最长数据条的长度占单元格宽度的百分比。
  使用此属性可以控制条件格式规则中数据条的最大可视长度。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setPercentMax(80);
  Parameters:
  
  value - 最长数据条所使用的单元格宽度百分比。
- getPercentMin
  
  int getPercentMin()
  获取最短数据条的长度，以单元格宽度的百分比表示。
  使用此属性可以确定条件格式规则中应用于数据条的最小可视长度。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setPercentMin(15); int percentMin = dataBar.getPercentMin();
  Returns:
  
  最短数据条的长度，以单元格宽度的百分比表示。使用此属性可以确定条件格式规则中应用于数据条的最小可视长度。
- setPercentMin
  
  void setPercentMin(int value)
  设置一个 Integer 值，该值指定最短数据条的长度占单元格宽度的百分比。
  使用此方法可以控制条件格式规则中数据条的最小可见长度。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setPercentMin(15); int percentMin = dataBar.getPercentMin();
  Parameters:
  
  value - 最短数据条的长度，以单元格宽度的百分比表示。
- getPriority
  
  int getPriority()
  获取条件格式规则的优先级值。
  当工作表上存在多个条件格式规则时，优先级决定这些规则的计算顺序。优先级值在工作表内是唯一的，因此更改一个规则的优先级可能会移动其他规则的优先级值。
  
  worksheet.getRange("A1:B3").setValue(new Object[][] {{10, 5}, {30, 15}, {20, 25}}); IDataBar firstDataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); IDataBar secondDataBar = worksheet.getRange("B1:B3").getFormatConditions().addDatabar(); secondDataBar.setPriority(1); int priority = secondDataBar.getPriority();
  Returns:
  
  条件格式规则的优先级值。当工作表上存在多个条件格式规则时，优先级决定这些规则的计算顺序。优先级值在工作表内是唯一的，因此更改一个规则的优先级可能会移动其他规则的优先级值。
- setPriority
  
  void setPriority(int value)
  设置条件格式规则的优先级值。
  当工作表上存在多个条件格式规则时，优先级决定计算顺序。该值必须是介于 1 和工作表上条件格式规则总数之间的正整数。由于每个规则都必须具有唯一的优先级，更改此规则的优先级可能会移动工作表上其他规则的优先级值。
  
  worksheet.getRange("A1:B3").setValue(new Object[][] {{10, 5}, {30, 15}, {20, 25}}); IDataBar firstDataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); IDataBar secondDataBar = worksheet.getRange("B1:B3").getFormatConditions().addDatabar(); secondDataBar.setPriority(1);
  Parameters:
  
  value - 条件格式规则的优先级值。必须是介于 1 和工作表上条件格式规则总数之间的正整数。
- getShowValue
  
  boolean getShowValue()
  获取应用数据条条件格式时是否显示单元格值。
  此属性指示原始单元格值是否与数据条一起保持可见。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setShowValue(false); boolean showValue = dataBar.getShowValue();
  Returns:
  
  如果 Show Value 为真，则为 true；否则为 false。
- setShowValue
  
  void setShowValue(boolean value)
  设置应用数据条条件格式时是否显示单元格值。
  使用此属性可以在保持数据条可见的同时显示或隐藏原始单元格值。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setShowValue(false);
  Parameters:
  
  value - true 表示将单元格值与数据条一起显示；否则为 false。
- getStopIfTrue
  
  boolean getStopIfTrue()
  获取在此数据条规则计算结果为 true 后，是否继续计算单元格上的其他条件格式规则。
  如果此属性为 true，则会继续为此数据条应用到的单元格计算较低优先级的条件格式规则。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); boolean stopIfTrue = dataBar.getStopIfTrue();
  Returns:
  
  如果 Stop If True 为真，则为 true；否则为 false。
- getType
  
  FormatConditionType getType()
  获取此条件格式的类型。
  对于数据条条件格式规则，此方法返回对应的 FormatConditionType 值，例如FormatConditionType.Databar。
  
  worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {20}, {40}, {25}}); IDataBar dataBar = worksheet.getRange("A1:A5").getFormatConditions().addDatabar(); FormatConditionType type = dataBar.getType();
  Returns:
  
  此条件格式的类型。对于数据条条件格式规则，此方法返回对应的值，例如。
- delete
  
  void delete()
  删除此数据条条件格式规则。
  调用此方法后，数据条将从其应用的区域中移除。
  
  worksheet.getRange("A1:A5").setValue(new Object[][] {{1}, {2}, {3}, {4}, {5}}); IDataBar dataBar = worksheet.getRange("A1:A5").getFormatConditions().addDatabar(); dataBar.delete();
- setFirstPriority
  
  void setFirstPriority()
  将此条件格式规则的优先级值设置为 1，使其先于工作表上的所有其他规则进行评估。
  使用此方法可以将数据条规则移动到同一工作表上条件格式规则中的最高评估优先级。
  
  worksheet.getRange("A1:B3").setValue(new Object[][] {{10, 5}, {30, 15}, {20, 25}}); IDataBar firstDataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); IDataBar secondDataBar = worksheet.getRange("B1:B3").getFormatConditions().addDatabar(); firstDataBar.setFirstPriority();
- setLastPriority
  
  void setLastPriority()
  设置此数据条规则的评估顺序，使其在工作表上的所有其他规则之后进行评估。
  使用此方法可将当前数据条规则移动到工作表规则优先级列表的末尾。
  
  worksheet.getRange("A1:B3").setValue(new Object[][] {{10, 5}, {30, 15}, {20, 25}}); IDataBar firstDataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); IDataBar secondDataBar = worksheet.getRange("B1:B3").getFormatConditions().addDatabar(); secondDataBar.setLastPriority();
- fromJson
  
  void fromJson(String json)
  从 JSON 字符串加载数据条条件格式。
  此方法会将当前数据条规则替换为指定 JSON 字符串中定义的规则。JSON 内容通常由 toJson() 生成。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] {{10}, {30}, {20}}); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); dataBar.setBarFillType(DataBarFillType.Solid); dataBar.getBarColor().setColor(Color.GetGreen()); dataBar.setShowValue(false); String json = dataBar.toJson(); IDataBar copiedDataBar = worksheet.getRange("B1:B3").getFormatConditions().addDatabar(); copiedDataBar.fromJson(json);
  Parameters:
  
  json - 定义数据条条件格式的 JSON 字符串。
  
  Throws:
  
  IllegalStateException - 如果指定的 JSON 字符串未描述数据条条件格式。
- toJson
  
  String toJson()
  从数据条规则生成 JSON 字符串。
  使用此方法可以序列化当前数据条设置，以便通过 fromJson(String) 重用或存储以供以后使用。
  
  worksheet.getRange("A1:A3").setValue(new Object[][] { {10}, {30}, {20} }); IDataBar dataBar = worksheet.getRange("A1:A3").getFormatConditions().addDatabar(); String json = dataBar.toJson();
  Returns:
  
  表示当前数据条规则的 JSON 字符串。

IDataBar

Interface IDataBar

Method Summary

Method Details

getAppliesTo

setAppliesTo

getAxisColor

getAxisPosition

setAxisPosition

getBarBorder

getBarColor

getBarFillType

setBarFillType

getDirection

setDirection

getMaxPoint

getMinPoint

getNegativeBarFormat

getPercentMax

setPercentMax

getPercentMin

setPercentMin

getPriority

setPriority

getShowValue

setShowValue

getStopIfTrue

getType

delete

setFirstPriority

setLastPriority

fromJson

toJson