Package com.grapecity.documents.excel

Interface IDataBar

public interface IDataBar
表示一个数据条条件格式规则。将数据条应用于一个范围可以帮助你查看单元格值与其他单元格的相对关系。

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
    删除此条件格式。
    void
    fromJson(String json)
    从JSON字符串生成条件格式。
    IRange
    getAppliesTo()
    返回一个指定了格式规则应用到的单元格范围的 Range 对象。
    IFormatColor
    getAxisColor()
    获取具有数据条条件格式的单元格的坐标轴颜色。
    DataBarAxisPosition
    getAxisPosition()
    获取或设置由条件格式规则指定的数据条轴的位置。
    IDataBarBorder
    getBarBorder()
    获取一个指定数据条边框的对象。
    IFormatColor
    getBarColor()
    返回一个 FormatColor 对象，您可以使用它来修改数据条条件格式中条形的颜色。
    DataBarFillType
    getBarFillType()
    获取数据条如何用颜色填充。
    DataBarDirection
    getDirection()
    获取数据条显示的方向。
    IConditionValue
    getMaxPoint()
    返回一个IConditionValue对象，该对象指定如何评估数据条条件格式的最长条。
    IConditionValue
    getMinPoint()
    返回一个ConditionValue对象，该对象指定如何评估数据条条件格式的最短条。
    INegativeBarFormat
    getNegativeBarFormat()
    获取与数据条条件格式规则关联的负条格式对象。
    int
    getPercentMax()
    返回一个整数值，指定最长数据条的长度占单元格宽度的百分比。
    int
    getPercentMin()
    返回一个整数值，指定最短数据条的长度占单元格宽度的百分比。
    int
    getPriority()
    返回条件格式规则优先级的值。优先级决定了当工作表中存在多个条件格式规则时，它们的评估顺序。
    boolean
    getShowValue()
    返回一个布尔值，指定如果数据条条件格式应用于范围时，单元格中的值是否显示。
    boolean
    getStopIfTrue()
    返回一个布尔值，以确定如果当前规则计算结果为true，是否应该评估单元格上的附加格式规则。
    FormatConditionType
    getType()
    返回此条件格式的类型。
    void
    setAppliesTo(IRange value)
    设置一个Range对象，指定要应用格式规则的单元格范围。
    void
    setAxisPosition(DataBarAxisPosition value)
    设置由条件格式规则指定的数据条轴的位置。
    void
    setBarFillType(DataBarFillType value)
    设置数据条如何用颜色填充。
    void
    setDirection(DataBarDirection value)
    设置数据条显示的方向。
    void
    setFirstPriority()
    设置此条件格式规则优先级值为"1"，以便在所有工作表上的其他规则之前进行评估。
    void
    setLastPriority()
    设置此条件格式规则的评价顺序，使其在所有工作表上的其他规则之后进行评估。
    void
    setPercentMax(int value)
    设置一个整数值，指定最长数据条的长度占单元格宽度的百分比。
    void
    setPercentMin(int value)
    设置一个整数值，指定最短数据条的长度占单元格宽度的百分比。
    void
    setPriority(int value)
    设置条件格式规则的重叠值。优先级决定了当工作表中存在多个条件格式规则时评估的顺序。
    void
    setShowValue(boolean value)
    设置一个布尔值，指定如果数据条条件格式应用于该范围时，单元格中的值是否显示。
    String
    toJson()
    生成一个从条件格式转换而来的JSON字符串。

  • Method Details

    • getAppliesTo

      IRange getAppliesTo()
      返回一个指定了格式规则应用到的单元格范围的 Range 对象。

    • setAppliesTo

      void setAppliesTo(IRange value)
      设置一个Range对象，指定要应用格式规则的单元格范围。

    • getAxisColor

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

    • getAxisPosition

      DataBarAxisPosition getAxisPosition()
      获取或设置由条件格式规则指定的数据条轴的位置。

    • setAxisPosition

      void setAxisPosition(DataBarAxisPosition value)
      设置由条件格式规则指定的数据条轴的位置。

    • getBarBorder

      IDataBarBorder getBarBorder()
      获取一个指定数据条边框的对象。

    • getBarColor

      IFormatColor getBarColor()
      返回一个 FormatColor 对象，您可以使用它来修改数据条条件格式中条形的颜色。

    • getBarFillType

      DataBarFillType getBarFillType()
      获取数据条如何用颜色填充。

    • setBarFillType

      void setBarFillType(DataBarFillType value)
      设置数据条如何用颜色填充。

    • getDirection

      DataBarDirection getDirection()
      获取数据条显示的方向。

    • setDirection

      void setDirection(DataBarDirection value)
      设置数据条显示的方向。

    • getMaxPoint

      IConditionValue getMaxPoint()
      返回一个IConditionValue对象，该对象指定如何评估数据条条件格式的最长条。

    • getMinPoint

      IConditionValue getMinPoint()
      返回一个ConditionValue对象，该对象指定如何评估数据条条件格式的最短条。

    • getNegativeBarFormat

      INegativeBarFormat getNegativeBarFormat()
      获取与数据条条件格式规则关联的负条格式对象。

    • getPercentMax

      int getPercentMax()
      返回一个整数值，指定最长数据条的长度占单元格宽度的百分比。

    • setPercentMax

      void setPercentMax(int value)
      设置一个整数值，指定最长数据条的长度占单元格宽度的百分比。

    • getPercentMin

      int getPercentMin()
      返回一个整数值，指定最短数据条的长度占单元格宽度的百分比。

    • setPercentMin

      void setPercentMin(int value)
      设置一个整数值，指定最短数据条的长度占单元格宽度的百分比。

    • getPriority

      int getPriority()
      返回条件格式规则优先级的值。优先级决定了当工作表中存在多个条件格式规则时，它们的评估顺序。

      设置优先级时，值必须是一个正整数，介于1和工在工作表上的条件格式规则总数之间。优先级必须在工作表上所有规则中是唯一的，因此更改指定条件格式规则的优先级可能会导致工作表上其他规则的优先级值发生变动。

    • setPriority

      void setPriority(int value)
      设置条件格式规则的重叠值。优先级决定了当工作表中存在多个条件格式规则时评估的顺序。

      设置优先级时，值必须是一个正整数，介于1与工作表上条件格式规则的总数之间。对于工作表上的所有规则来说，优先级必须是唯一的值，因此更改指定条件格式规则的优先级可能会导致工作表上其他规则的优先级值发生变动。

    • getShowValue

      boolean getShowValue()
      返回一个布尔值，指定如果数据条条件格式应用于范围时，单元格中的值是否显示。

    • setShowValue

      void setShowValue(boolean value)
      设置一个布尔值，指定如果数据条条件格式应用于该范围时，单元格中的值是否显示。

    • getStopIfTrue

      boolean getStopIfTrue()
      返回一个布尔值，以确定如果当前规则计算结果为true，是否应该评估单元格上的附加格式规则。

    • getType

      FormatConditionType getType()
      返回此条件格式的类型。

    • delete

      void delete()
      删除此条件格式。

    • setFirstPriority

      void setFirstPriority()
      设置此条件格式规则优先级值为"1"，以便在所有工作表上的其他规则之前进行评估。

    • setLastPriority

      void setLastPriority()
      设置此条件格式规则的评价顺序，使其在所有工作表上的其他规则之后进行评估。

    • fromJson

      void fromJson(String json)
      从JSON字符串生成条件格式。
      Parameters:
      json - JSON字符串。

    • toJson

      String toJson()
      生成一个从条件格式转换而来的JSON字符串。
      Returns:
      条件格式的JSON字符串。