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	取得這個漸層條件的最小值。

已淘汰的方法

方法	傳回類型	簡短說明
getMaxColor()	String	取得為這個漸層條件最大值設定的顏色。
getMidColor()	String	取得為這個漸層條件中點值設定的顏色。
getMinColor()	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：如果已指定最小值，則為該值，否則為空字串。

已淘汰的方法

getMaxColor()

已淘汰。已替換為 getMaxColorObject()

取得此漸層條件最大值所設定的顏色。如果尚未設定顏色，則會傳回空字串。

回攻員

String - 這個漸層條件的最大值所設定的顏色，或空白字串。

---

getMidColor()

已淘汰。已替換為 getMidColorObject()

取得為這個漸層條件中點值設定的顏色。如果尚未設定顏色，則傳回空字串。

回攻員

String - 這個漸層條件中點值的顏色集，或空白字串。

---

getMinColor()

已淘汰。已替換為 getMinColorObject()

取得為這個漸層條件最小值設定的顏色。如果尚未設定顏色，則會傳回空字串。

回攻員

String：為這個漸層條件的最小值設定的顏色，或空白字串。