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()

取得此漸層條件中的最大值。如果 InterpolationTypeMAX,或未設定最大值,則會傳回空字串。

回攻員

String:指定的最大值或空字串


getMidColorObject()

取得此漸層條件中點值的顏色集合。如果未設定顏色,則會傳回 null

回攻員

Color:為此漸層條件的中點值或 null 設定的顏色。


getMidType()

取得此漸層條件的中點值插補類型。如果未設定漸層中間類型,則會傳回 null

回攻員

InterpolationType:這個漸層條件或 null 中點值的插補類型


getMidValue()

取得此漸層條件的中間點值。如果未設定漸層中間值,則會傳回空字串。

回攻員

String:中點值或空字串


getMinColorObject()

取得此漸層條件最小值的顏色集。如果未設定顏色,則會傳回 null

回攻員

Color:為此漸層條件或 null 的最低值設定的顏色。


getMinType()

取得此漸層條件最小值的插補類型。如果未設定漸層最小值類型,則會傳回 null

回攻員

InterpolationType:此漸層條件或 null 的最小值插補類型


getMinValue()

取得此漸層條件最小值。如果 InterpolationTypeMIN,或未設定最小值,則會傳回空字串。

回攻員

String:指定的最小值或空字串

已淘汰的方法