Class ConditionalFormatRule

ConditionalFormatRule

Acesse as regras de formatação condicional. Para criar uma regra, use SpreadsheetApp.newConditionalFormatRule() e ConditionalFormatRuleBuilder. É possível usar Sheet.setConditionalFormatRules(rules) para definir as regras de uma determinada planilha.

Para regras que usam critérios de condição booleana, acesse as configurações de formatação chamando getBooleanCondition() e usando os métodos no objeto BooleanCondition retornado.

Métodos

Método	Tipo de retorno	Breve descrição
copy()	ConditionalFormatRuleBuilder	Retorna uma predefinição do criador de regras com as configurações dessa regra.
getBooleanCondition()	BooleanCondition|null	Recupera as informações de BooleanCondition da regra se ela usa critérios de condição booleana.
getGradientCondition()	GradientCondition|null	Recupera as informações GradientCondition da regra, se ela usar critérios de condição de gradiente.
getRanges()	Range[]	Recupera os intervalos a que esta regra de formatação condicional é aplicada.

Documentação detalhada

copy()

Retorna uma predefinição do criador de regras com as configurações dessa regra.

Retornar

ConditionalFormatRuleBuilder: um builder com base nas configurações desta regra.

---

getBooleanCondition()

Recupera as informações de BooleanCondition da regra se ela usa critérios de condição booleana. Caso contrário, retornará null. As condições booleanas contêm configurações de formatação, como peso, cor da fonte e cor de plano de fundo.

// 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());
}

Retornar

BooleanCondition|null: o objeto de condição booleana ou null se a regra não usar uma condição booleana.

---

getGradientCondition()

Recupera as informações GradientCondition da regra, se ela usar critérios de condição de gradiente. Caso contrário, retornará 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());
}

Retornar

GradientCondition|null: o objeto de condição de gradiente ou null se a regra não usar uma condição de gradiente.

---

getRanges()

Recupera os intervalos a que esta regra de formatação condicional é aplicada.

// 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());
}

Retornar

Range[]: os intervalos a que essa regra de formatação condicional é aplicada.