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.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var gradient = rules[i].getGradientCondition();
  Logger.log("The conditional format gradient information for rule %d:\n
    MinColor %s, MinType %s, MinValue %s, \n
    MidColor %s, MidType %s, MidValue %s, \n
    MaxColor %s, MaxType %s, MaxValue %s \n", i,
    gradient.getMinColorObject().asRgbColor().asHexString(),
    gradient.getMinType(), gradient.getMinValue(),
    gradient.getMidColorObject().asRgbColor().asHexString(),
    gradient.getMidType(), gradient.getMidValue(),
    gradient.getMaxColorObject().asRgbColor().asHexString(),
    gradient.getMaxType(), gradient.getMaxValue());
}

Methods

メソッド戻り値の型概要
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 - 最小値(指定されている場合)または空の文字列

サポート終了のメソッド