Class GradientCondition

  • Gradient conditions in Google Sheets allow you to apply color scales to cells based on their values, interpolating colors between minimum, midpoint, and maximum points.

  • Each gradient condition is defined by three points (min, mid, max), each having a color, value, and interpolation type.

  • You can access and manipulate gradient conditions programmatically using Apps Script methods like getMinColorObject(), getMidValue(), and getMaxType().

  • Deprecated methods like getMinColor(), getMidColor(), and getMaxColor() have been replaced by object-based alternatives for color retrieval.
GradientCondition

Access gradient (color) conditions in ConditionalFormatRuleApis . Each conditional format rule may contain a single gradient condition. A gradient condition is defined by three points along a number scale (min, mid, and max), each of which has a color, a value, and a InterpolationType . The content of a cell is compared to the values in the number scale and the color applied to the cell is interpolated based on the cell content's proximity to the gradient condition min, mid, and max points. 

// Logs all the information inside gradient conditional format rules on a sheet.
// The below snippet assumes all colors have ColorType.RGB.
constsheet=SpreadsheetApp.getActiveSheet();
construles=sheet.getConditionalFormatRules();
for(leti=0;i < rules.length;i++){
constgradient=rules[i].getGradientCondition();
constminColor=gradient.getMinColorObject().asRgbColor().asHexString();
constminType=gradient.getMinType();
constminValue=gradient.getMinValue();
constmidColor=gradient.getMidColorObject().asRgbColor().asHexString();
constmidType=gradient.getMidType();
constmidValue=gradient.getMidValue();
constmaxColor=gradient.getMaxColorObject().asRgbColor().asHexString();
constmaxType=gradient.getMaxType();
constmaxValue=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}`);
}

Methods

MethodReturn typeBrief description
getMaxColorObject() Color Gets the color set for the maximum value of this gradient condition.
getMaxType() InterpolationType Gets the interpolation type for the maximum value of this gradient condition.
getMaxValue() StringGets the max value of this gradient condition.
getMidColorObject() Color Gets the color set for the midpoint value of this gradient condition.
getMidType() InterpolationType Gets the interpolation type for the midpoint value of this gradient condition.
getMidValue() StringGets the midpoint value of this gradient condition.
getMinColorObject() Color Gets the color set for the minimum value of this gradient condition.
getMinType() InterpolationType Gets the interpolation type for the minimum value of this gradient condition.
getMinValue() StringGets the minimum value of this gradient condition.

Deprecated methods

MethodReturn typeBrief description
(削除) getMaxColor() (削除ここまで)StringGets the color set for the maximum value of this gradient condition.
(削除) getMidColor() (削除ここまで)StringGets the color set for the midpoint value of this gradient condition.
(削除) getMinColor() (削除ここまで)StringGets the color set for the minimum value of this gradient condition.

Detailed documentation

getMaxColorObject()

Gets the color set for the maximum value of this gradient condition. Returns null if the color hasn't been set.

Return

Color — The color set for the maximum value of this gradient condition or null.

getMaxType()

Gets the interpolation type for the maximum value of this gradient condition. Returns null if the gradient max type hasn't been set.

Return

InterpolationType — The interpolation type for the maximum value of this gradient condition or null.

getMaxValue()

Gets the max value of this gradient condition. Returns an empty string if the InterpolationType is MAX or if the max value hasn't been set.

Return

String — The maximum value if specified or an empty string.

getMidColorObject()

Gets the color set for the midpoint value of this gradient condition. Returns null if the color hasn't been set.

Return

Color — The color set for the midpoint value of this gradient condition or null.

getMidType()

Gets the interpolation type for the midpoint value of this gradient condition. Returns null if the gradient mid type hasn't been set.

Return

InterpolationType — The interpolation type for the midpoint value of this gradient condition or null.

getMidValue()

Gets the midpoint value of this gradient condition. Returns an empty string if the gradient mid value hasn't been set.

Return

String — The midpoint value or an empty string.

getMinColorObject()

Gets the color set for the minimum value of this gradient condition. Returns null if the color hasn't been set.

Return

Color — The color set for the minimum value of this gradient condition or null.

getMinType()

Gets the interpolation type for the minimum value of this gradient condition. Returns null if the gradient min type hasn't been set.

Return

InterpolationType — The interpolation type for the minimum value of this gradient condition or null.

getMinValue()

Gets the minimum value of this gradient condition. Returns an empty string if the InterpolationType is MIN or if the min value hasn't been set.

Return

String — The minimum value if specified or an empty string.

Deprecated methods

(削除) getMaxColor() (削除ここまで)

Deprecated. Replaced by getMaxColorObject()

Gets the color set for the maximum value of this gradient condition. Returns an empty string if the color hasn't been set.

Return

String — The color set for the maximum value of this gradient condition or an empty string.

(削除) getMidColor() (削除ここまで)

Deprecated. Replaced by getMidColorObject()

Gets the color set for the midpoint value of this gradient condition. Returns an empty string if the color hasn't been set.

Return

String — The color set for the midpoint value of this gradient condition or an empty string.

(削除) getMinColor() (削除ここまで)

Deprecated. Replaced by getMinColorObject()

Gets the color set for the minimum value of this gradient condition. Returns an empty string if the color hasn't been set.

Return

String — The color set for the minimum value of this gradient condition or an empty string.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年08月04日 UTC.