Acessar regras de formatação condicional. Para criar uma nova regra, use SpreadsheetApp.newConditionalFormatRule()
e ConditionalFormatRuleBuilder
.
Você pode usar Sheet.setConditionalFormatRules(rules)
para definir as
regras de uma determinada página.
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 | Recupera as informações BooleanCondition da regra se ela usa
critérios de condição booleana. |
getGradientCondition() | GradientCondition | Recupera as informações GradientCondition da regra se ela
usar critérios de condição de gradiente. |
getRanges() | Range[] | Recupera os intervalos aos quais 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.
Retorno
ConditionalFormatRuleBuilder
: um builder com base nas configurações desta 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. var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0]; var booleanCondition = rule.getBooleanCondition(); if (booleanCondition != null) { Logger.log(booleanCondition.getCriteriaType()); }
Retorno
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. var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0]; var gradientCondition = rule.getGradientCondition(); if (gradientCondition != null) { // Assume the color has ColorType.RGB. Logger.log(gradientCondition.getMinColorObject().asRgbColor().asHexString()); }
Retorno
GradientCondition
: o objeto de condição de gradiente, ou null
se a regra não usa uma condição de gradiente.
getRanges()
Recupera os intervalos aos quais esta regra de formatação condicional é aplicada.
// Log each range of the first conditional format rule of a sheet. var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0]; var ranges = rule.getRanges(); for (var i = 0; i < ranges.length; i++) { Logger.log(ranges[i].getA1Notation()); }
Retorno
Range[]
: os intervalos aos quais esta regra de formatação condicional é aplicada.