Package com.grapecity.documents.excel

Interface IColorScaleCriterion

public interface IColorScaleCriterion
Represents the criteria for the minimum, midpoint, or maximum thresholds for a color format conditional format.

  • Method Summary

    Modifier and Type
    Method
    Description
    IFormatColor
    getFormatColor()
    Returns a FormatColor object, which specifies the color assigned to the threshold of a color scale conditional format.
    int
    getIndex()
    Returns an Integer value that indicates which threshold the criteria represents.
    ConditionValueTypes
    getType()
    Returns one of the constants of the ConditionValueTypes enumeration, which specifies how the threshold values for a data bar or color scale conditional format are determined.
    Object
    getValue()
    Returns the minimum, midpoint, or maximum threshold value for a color scale conditional format.
    void
    setType(ConditionValueTypes value)
    Sets one of the constants of the ConditionValueTypes enumeration, which specifies how the threshold values for a data bar or color scale conditional format are determined.
    void
    setValue(Object value)
    Sets the minimum, midpoint, or maximum threshold value for a color scale conditional format.

  • Method Details

    • getFormatColor

      IFormatColor getFormatColor()
      Returns a FormatColor object, which specifies the color assigned to the threshold of a color scale conditional format.

    • getIndex

      int getIndex()
      Returns an Integer value that indicates which threshold the criteria represents.

    • getType

      ConditionValueTypes getType()
      Returns one of the constants of the ConditionValueTypes enumeration, which specifies how the threshold values for a data bar or color scale conditional format are determined.

    • setType

      void setType(ConditionValueTypes value)
      Sets one of the constants of the ConditionValueTypes enumeration, which specifies how the threshold values for a data bar or color scale conditional format are determined.

    • getValue

      Object getValue()
      Returns the minimum, midpoint, or maximum threshold value for a color scale conditional format.

      You can set the value only if the ColorScaleCriterion.Type property for the conditional format is set to one of the following constants: ConditionValueNumber, ConditionValuePercent, ConditionValuePercentile, or ConditionValueFormula. If the type of threshold is a formula, you can set the formula as a String. The formula must return a single number.

    • setValue

      void setValue(Object value)
      Sets the minimum, midpoint, or maximum threshold value for a color scale conditional format.

      You can set the value only if the ColorScaleCriterion.Type property for the conditional format is set to one of the following constants: ConditionValueNumber, ConditionValuePercent, ConditionValuePercentile, or ConditionValueFormula. If the type of threshold is a formula, you can set the formula as a String. The formula must return a single number.