Class GradientCondition

梯度条件

在 ConditionalFormatRuleApis 中访问梯度（颜色）条件。 每个条件格式规则只能包含一个渐变条件。梯度条件由数值刻度上的三个点（最小值、中间值和最大值）定义，每个点都有颜色、值和 InterpolationType。系统会将单元格的内容与数字比例中的值进行比较，并根据单元格内容与梯度条件最小值、中间值和最大值的接近程度，对应用于单元格的颜色进行插值。 

// Logs all the information inside gradient conditional format rules on a sheet.
// The below snippet assumes all colors have ColorType.RGB.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
  const gradient = rules[i].getGradientCondition();

  const minColor = gradient.getMinColorObject().asRgbColor().asHexString();
  const minType = gradient.getMinType();
  const minValue = gradient.getMinValue();
  const midColor = gradient.getMidColorObject().asRgbColor().asHexString();
  const midType = gradient.getMidType();
  const midValue = gradient.getMidValue();
  const maxColor = gradient.getMaxColorObject().asRgbColor().asHexString();
  const maxType = gradient.getMaxType();
  const maxValue = gradient.getMaxValue();

  Logger.log(`The conditional format gradient information for rule ${i}:
    MinColor ${minColor}, MinType ${minType}, MinValue ${minValue},
    MidColor ${midColor}, MidType ${midType}, MidValue ${midValue},
    MaxColor ${maxColor}, MaxType ${maxType}, MaxValue ${maxValue}`);
}

方法

方法返回类型简介
getMaxColorObject()Color获取为此梯度条件的最高值设置的颜色。
getMaxType()InterpolationType获取相应梯度条件的最高值的插值类型。
getMaxValue()String获取相应梯度条件的最大值。
getMidColorObject()Color获取为此梯度条件的中点值设置的颜色。
getMidType()InterpolationType获取相应梯度条件的中间点值的插值类型。
getMidValue()String获取此梯度条件的中间值。
getMinColorObject()Color获取为此梯度条件设置的最小值颜色。
getMinType()InterpolationType获取相应梯度条件的最小值的插值类型。
getMinValue()String获取相应梯度条件的最小值。

详细文档

getMaxColorObject()

获取为此梯度条件的最大值设置的颜色。如果尚未设置颜色，则返回 null。

返回

Color - 为此梯度条件的最高值设置的颜色或 null。

getMaxType()

获取相应梯度条件的最高值的插值类型。如果未设置梯度最大类型，则返回 null。

返回

InterpolationType - 此梯度条件或 null 的最大值的插值类型。

getMaxValue()

获取相应梯度条件的最大值。如果 InterpolationType 为 MAX 或未设置最大值，则返回空字符串。

返回

String - 如果指定了最大值，则为该值；否则为空字符串。

getMidColorObject()

获取为此梯度条件的中点值设置的颜色。如果尚未设置颜色，则返回 null。

返回

Color - 为此梯度条件的中点值设置的颜色或 null。

getMidType()

获取相应梯度条件的中间点值的插值类型。如果尚未设置渐变中间类型，则返回 null。

返回

InterpolationType - 此梯度条件的中点值的插值类型，或 null。

getMidValue()

获取此梯度条件的中间值。如果尚未设置梯度中间值，则返回空字符串。

返回

String - 中点值或空字符串。

getMinColorObject()

获取为此梯度条件的最小值设置的颜色。如果尚未设置颜色，则返回 null。

返回

Color - 为此梯度条件的最小值或 null 设置的颜色。

getMinType()

获取相应梯度条件的最小值的插值类型。如果尚未设置梯度最小值类型，则返回 null。

返回

InterpolationType - 此梯度条件的最小值或 null 的插值类型。

getMinValue()

获取相应梯度条件的最小值。如果 InterpolationType 为 MIN 或未设置最小值，则返回空字符串。

返回

String - 如果指定了最小值，则为该最小值；否则为空字符串。

已弃用的方法