Class ConditionalFormatRule

Regradeformatação condicional

Acessar 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.

Métodos

MétodoTipo de retornoBreve descrição
copy()ConditionalFormatRuleBuilderRetorna uma regra predefinida do criador de regras com as configurações dela.
getBooleanCondition()BooleanConditionRecupera as informações BooleanCondition da regra se ela usa critérios de condição booleana.
getGradientCondition()GradientConditionRecupera as informações GradientCondition da regra, se ela usar critérios de condição de gradiente.
getRanges()Range[]Recupera os intervalos em que esta regra de formatação condicional é aplicada.

Documentação detalhada

copy()

Retorna uma regra predefinida do criador de regras com as configurações dela.

Retornar

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

getBooleanCondition()

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

Retornar

BooleanCondition: 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, retorna 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: o objeto de condição de gradiente ou null se a regra não usar uma condição de gradiente.

getRanges()

Recupera os intervalos em 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 em que essa regra de formatação condicional é aplicada.