Class ConditionalFormatRule
-
Use
SpreadsheetApp.newConditionalFormatRule()andConditionalFormatRuleBuilderto create new conditional formatting rules. -
You can set conditional format rules for a sheet using
Sheet.setConditionalFormatRules(). -
Methods available for
ConditionalFormatRuleincludecopy(),getBooleanCondition(),getGradientCondition(), andgetRanges(). -
copy()returns a builder preset with the current rule's settings. -
getBooleanCondition()andgetGradientCondition()retrieve condition details if applicable, otherwise returnnull. -
getRanges()returns the ranges where the conditional format rule is applied.
Detailed documentation
copy()
getBooleanCondition()
Retrieves the rule's Boolean information if this rule uses
boolean condition criteria. Otherwise returns null.
// Log the boolean criteria type of the first conditional format rules of a // sheet. const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0]; const booleanCondition = rule.getBooleanCondition(); if (booleanCondition != null) { Logger.log(booleanCondition.getCriteriaType()); }
Return
Boolean — The boolean condition object, or null if the rule does not use a boolean
condition.
getGradientCondition()
Retrieves the rule's Gradient information, if this rule
uses gradient condition criteria. Otherwise returns null.
// Log the gradient minimum color of the first conditional format rule of a // sheet. const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0]; const gradientCondition = rule.getGradientCondition(); if (gradientCondition != null) { // Assume the color has ColorType.RGB. Logger.log(gradientCondition.getMinColorObject().asRgbColor().asHexString()); }
Return
Gradient — The gradient condition object, or null if the rule does not use a gradient
condition.
getRanges()
Retrieves the ranges to which this conditional format rule is applied.
// Log each range of the first conditional format rule of a sheet. const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0]; const ranges = rule.getRanges(); for (let i = 0; i < ranges.length; i++) { Logger.log(ranges[i].getA1Notation()); }
Return
Range[] — The ranges to which this conditional format rule is applied.