Class GradientCondition

GradientCondition

ConditionalFormatRuleApis でグラデーション（色）条件にアクセスします。各条件付き書式ルールには、1 つのグラデーション条件を含めることができます。グラデーション条件は、数値スケール上の 3 つのポイント（最小、中間、最大）で定義されます。各ポイントには、色、値、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|nullこのグラデーション条件の最大値に設定された色を取得します。
getMaxType()InterpolationType|nullこのグラデーション条件の最大値の補間タイプを取得します。
getMaxValue()Stringこのグラデーション条件の最大値を取得します。
getMidColorObject()Color|nullこのグラデーション条件の中間値に設定された色を取得します。
getMidType()InterpolationType|nullこのグラデーション条件の中間値の補間タイプを取得します。
getMidValue()Stringこのグラデーション条件の中間値を取得します。
getMinColorObject()Color|nullこのグラデーション条件の最小値に設定された色を取得します。
getMinType()InterpolationType|nullこのグラデーション条件の最小値の補間タイプを取得します。
getMinValue()Stringこのグラデーション条件の最小値を取得します。

詳細なドキュメント

getMaxColorObject()

このグラデーション条件の最大値に設定された色を取得します。色が設定されていない場合は null を返します。

戻る

Color|null - このグラデーション条件の最大値に設定された色、または null。

getMaxType()

このグラデーション条件の最大値の補間タイプを取得します。グラデーションの最大タイプが設定されていない場合は null を返します。

戻る

InterpolationType|null - このグラデーション条件の最大値の補間タイプ、または null。

getMaxValue()

このグラデーション条件の最大値を取得します。InterpolationType が MAX の場合、または最大値が設定されていない場合は、空の文字列を返します。

戻る

String - 指定されている場合は最大値、指定されていない場合は空の文字列。

getMidColorObject()

このグラデーション条件の中間値に設定された色を取得します。色が設定されていない場合は null を返します。

戻る

Color|null - このグラデーション条件の中間値に設定された色、または null。

getMidType()

このグラデーション条件の中間値の補間タイプを取得します。グラデーションの中間タイプが設定されていない場合は null を返します。

戻る

InterpolationType|null - このグラデーション条件の中間値の補間タイプ、または null。

getMidValue()

このグラデーション条件の中間値を取得します。グラデーションの中間値が設定されていない場合は、空の文字列を返します。

戻る

String - 中間値、または空の文字列。

getMinColorObject()

このグラデーション条件の最小値に設定された色を取得します。色が設定されていない場合は null を返します。

戻る

Color|null - このグラデーション条件の最小値に設定された色、または null。

getMinType()

このグラデーション条件の最小値の補間タイプを取得します。グラデーションの最小タイプが設定されていない場合は null を返します。

戻る

InterpolationType|null - このグラデーション条件の最小値の補間タイプ、または null。

getMinValue()

このグラデーション条件の最小値を取得します。InterpolationType が MIN の場合、または最小値が設定されていない場合は、空の文字列を返します。

戻る

String - 指定されている場合は最小値、指定されていない場合は空の文字列。

サポート終了のメソッド