Class ConditionalFormatRuleBuilder

ConditionalFormatRuleBuilder

Builder de regras de formatação condicional.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Métodos

MétodoTipo de retornoBreve descrição
build()ConditionalFormatRuleCria uma regra de formatação condicional a partir das configurações aplicadas ao builder.
copy()ConditionalFormatRuleBuilderRetorna uma predefinição do criador de regras com as configurações dessa regra.
getBooleanCondition()BooleanConditionRecupera as informações do BooleanCondition da regra se esta regra usar critérios de condição booleana.
getGradientCondition()GradientConditionRecupera as informações do GradientCondition da regra se essa regra usa critérios de condição de gradiente.
getRanges()Range[]Recupera os intervalos aos quais esta regra de formatação condicional é aplicada.
setBackground(color)ConditionalFormatRuleBuilderDefine a cor do plano de fundo do formato da regra de formatação condicional.
setBackgroundObject(color)ConditionalFormatRuleBuilderDefine a cor do plano de fundo para o formato da regra de formatação condicional.
setBold(bold)ConditionalFormatRuleBuilderDefine o negrito do texto para o formato da regra de formatação condicional.
setFontColor(color)ConditionalFormatRuleBuilderDefine a cor da fonte para o formato da regra de formatação condicional.
setFontColorObject(color)ConditionalFormatRuleBuilderDefine a cor da fonte para o formato da regra de formatação condicional.
setGradientMaxpoint(color)ConditionalFormatRuleBuilderLimpa o valor do ponto máximo do gradiente da regra de formatação condicional e usa o valor máximo nos intervalos da regra.
setGradientMaxpointObject(color)ConditionalFormatRuleBuilderLimpa o valor do ponto máximo do gradiente da regra de formatação condicional e usa o valor máximo nos intervalos da regra.
setGradientMaxpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto máximo do gradiente da regra de formatação condicional.
setGradientMaxpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto máximo do gradiente da regra de formatação condicional.
setGradientMidpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto médio do gradiente da regra de formatação condicional.
setGradientMidpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto médio do gradiente da regra de formatação condicional.
setGradientMinpoint(color)ConditionalFormatRuleBuilderLimpa o valor mínimo do gradiente da regra de formatação condicional e usa o valor mínimo nos intervalos da regra.
setGradientMinpointObject(color)ConditionalFormatRuleBuilderLimpa o valor mínimo do gradiente da regra de formatação condicional e usa o valor mínimo nos intervalos da regra.
setGradientMinpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos mínimos de pontos de gradiente da regra de formatação condicional.
setGradientMinpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos mínimos de pontos de gradiente da regra de formatação condicional.
setItalic(italic)ConditionalFormatRuleBuilderDefine o itálico do texto para o formato da regra de formatação condicional.
setRanges(ranges)ConditionalFormatRuleBuilderDefine um ou mais intervalos aos quais esta regra de formato condicional é aplicada.
setStrikethrough(strikethrough)ConditionalFormatRuleBuilderDefine o tachado para o formato da regra de formatação condicional.
setUnderline(underline)ConditionalFormatRuleBuilderDefine o sublinhado do texto para o formato da regra de formatação condicional.
whenCellEmpty()ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando a célula estiver vazia.
whenCellNotEmpty()ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando a célula não está vazia.
whenDateAfter(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando uma data for posterior ao valor determinado.
whenDateAfter(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando uma data for posterior à data relativa determinada.
whenDateBefore(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando uma data for anterior à data determinada.
whenDateBefore(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando uma data for anterior à data relativa determinada.
whenDateEqualTo(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando uma data for igual à data especificada.
whenDateEqualTo(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando uma data for igual à data relativa determinada.
whenFormulaSatisfied(formula)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando a fórmula especificada for avaliada como true.
whenNumberBetween(start, end)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando um número estiver entre dois ou for um deles. valores especificados.
whenNumberEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando um número for igual ao valor determinado.
whenNumberGreaterThan(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número for maior que o valor fornecido.
whenNumberGreaterThanOrEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando um número for maior ou igual ao número informado .
whenNumberLessThan(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando um número menor que o especificado .
whenNumberLessThanOrEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando um número menor ou igual ao número fornecido .
whenNumberNotBetween(start, end)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando um número não está entre e não é dois valores especificados.
whenNumberNotEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando um número não for igual ao valor informado.
whenTextContains(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando a entrada contiver o valor determinado.
whenTextDoesNotContain(text)ConditionalFormatRuleBuilderDefine a regra de formato condicional a ser acionada quando a entrada não contiver o .
whenTextEndsWith(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando a entrada terminar com o valor determinado.
whenTextEqualTo(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando a entrada for igual ao valor determinado.
whenTextStartsWith(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional a ser acionada quando a entrada começar com o valor determinado.
withCriteria(criteria, args)ConditionalFormatRuleBuilderDefine a regra de formatação condicional como critérios definidos por valores BooleanCriteria. normalmente retirados dos criteria e arguments de uma regra atual.

Documentação detalhada

build()

Cria uma regra de formatação condicional a partir das configurações aplicadas ao builder.

Retornar

ConditionalFormatRule: uma representação da regra de formatação condicional


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 do BooleanCondition da regra se esta regra usar 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());
}

Retornar

BooleanCondition: o objeto de condição booleana, ou null se a regra não usar um booleano. condição.


getGradientCondition()

Recupera as informações do GradientCondition da regra se essa regra usa 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());
}

Retornar

GradientCondition: o objeto da condição de gradiente, ou null se a regra não usar um gradiente condição.


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

Retornar

Range[]: os intervalos aos quais essa regra de formato condicional é aplicada.


setBackground(color)

Define a cor do plano de fundo do formato da regra de formatação condicional. Transmitindo null remove a configuração de formato de cor do plano de fundo da regra.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color to red if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorStringA cor desejada ou null para limpar.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setBackgroundObject(color)

Define a cor do plano de fundo do formato da regra de formatação condicional. Transmitindo null remove a configuração de formato de cor do plano de fundo da regra.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color to theme background color if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setBackground(color)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorColorO objeto de cor desejado ou null para limpar.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setBold(bold)

Define o negrito do texto para o formato da regra de formatação condicional. Se bold for true, a regra coloca o texto em negrito se a condição é atendida; se for false, a regra remove quaisquer em negrito se a condição for atendida. Transmitir null remove a configuração de formato negrito da a regra.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn their
// text bold if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setBold(true)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
boldBooleanSe o texto deve ou não ficar em negrito se a condição de formato for atendida; null remove essa configuração.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setFontColor(color)

Define a cor da fonte para o formato da regra de formatação condicional. Ao transmitir null, você remove o a configuração de formato de cor da fonte da regra.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their font
// color to red if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setFontColor("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorStringA cor desejada ou null para limpar.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setFontColorObject(color)

Define a cor da fonte para o formato da regra de formatação condicional. Ao transmitir null, você remove o a configuração de formato de cor da fonte da regra.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their font
// color to theme text color if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setFontColor(color)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorColorO objeto de cor desejado ou null para limpar.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMaxpoint(color)

Limpa o valor do ponto máximo do gradiente da regra de formatação condicional e usa o valor máximo nos intervalos da regra. Também define a cor do ponto máximo do gradiente como a cor de entrada.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere between white and red, based on their values in comparison to
// the ranges minimum and maximum values.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpoint("#FF0000")
    .setGradientMinpoint("#FFFFFF")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorStringA cor do ponto máximo a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMaxpointObject(color)

Limpa o valor do ponto máximo do gradiente da regra de formatação condicional e usa o valor máximo nos intervalos da regra. Também define a cor do ponto máximo do gradiente como a cor de entrada.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere between theme text and background colors, based on their values
// in comparison to the ranges minimum and maximum values.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var textColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();
var backgroundColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpoint(textColor)
    .setGradientMinpoint(backgroundColor)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorColorO objeto de cor do ponto máximo a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMaxpointObjectWithValue(color, type, value)

Define os campos de ponto máximo do gradiente da regra de formatação condicional.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from theme accent 1, accent 2 to accent 3 colors, based on their
// values in comparison to the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var color2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var color3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue(color1, SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue(color2, SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue(color3, SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorColorA cor do ponto máximo a ser definido.
typeInterpolationTypeO tipo de interpolação do ponto máximo a ser definido.
valueStringO valor do ponto máximo a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMaxpointWithValue(color, type, value)

Define os campos de ponto máximo do gradiente da regra de formatação condicional.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from red green to blue, based on their values in comparison to
// the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue("#0000FF", SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue("#00FF00", SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue("#FF0000", SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorStringA cor do ponto máximo a ser definido.
typeInterpolationTypeO tipo de interpolação do ponto máximo a ser definido.
valueStringO valor do ponto máximo a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMidpointObjectWithValue(color, type, value)

Define os campos de ponto médio do gradiente da regra de formatação condicional. Limpa todos os campos de ponto médio se o tipo de interpolação transmitido for null.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from theme accent 1 to accent 2 to accent 3 colors, based on
// their values in comparison to the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var color2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var color3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue(color1, SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue(color2, SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue(color3, SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorColorA cor do ponto médio a ser definida.
typeInterpolationTypeO tipo de interpolação do ponto médio a ser definido ou null para limpar.
valueStringO valor médio a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMidpointWithValue(color, type, value)

Define os campos de ponto médio do gradiente da regra de formatação condicional. Limpa todos os campos de ponto médio se o tipo de interpolação transmitido for null.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from red green to blue, based on their values in comparison to
// the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue("#0000FF", SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue("#00FF00", SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue("#FF0000", SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorStringA cor do ponto médio a ser definida.
typeInterpolationTypeO tipo de interpolação do ponto médio a ser definido ou null para limpar.
valueStringO valor médio a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMinpoint(color)

Limpa o valor mínimo do gradiente da regra de formatação condicional e usa o valor mínimo nos intervalos da regra. Também define a cor mínima do gradiente como a cor de entrada.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere between white and red, based on their values in comparison to
// the ranges minimum and maximum values.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpoint("#FF0000")
    .setGradientMinpoint("#FFFFFF")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorStringA cor mínima a ser definida.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMinpointObject(color)

Limpa o valor mínimo do gradiente da regra de formatação condicional e usa o valor mínimo nos intervalos da regra. Também define a cor mínima do gradiente como a cor de entrada.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere between theme text and background colors, based on their values
// in comparison to the ranges minimum and maximum values.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var textColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();
var backgroundColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpoint(textColor)
    .setGradientMinpoint(backgroundColor)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorColorO objeto de cor mínima a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMinpointObjectWithValue(color, type, value)

Define os campos mínimos de pontos de gradiente da regra de formatação condicional.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from theme accent 1 to accent 2 to accent 3 colors, based on
// their values in comparison to the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var color1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var color2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var color3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue(color1, SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue(color2, SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue(color3, SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorColorA cor mínima a ser definida.
typeInterpolationTypeO tipo de interpolação de minpoint a ser definido.
valueStringO valor mínimo a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setGradientMinpointWithValue(color, type, value)

Define os campos mínimos de pontos de gradiente da regra de formatação condicional.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to set their
// background color somewhere from red to green to blue, based on their values in comparison to
// the values 0, 50, and 100.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .setGradientMaxpointWithValue("#0000FF", SpreadsheetApp.InterpolationType.NUMBER, "100")
    .setGradientMidpointWithValue("#00FF00", SpreadsheetApp.InterpolationType.NUMBER, "50")
    .setGradientMinpointWithValue("#FF0000", SpreadsheetApp.InterpolationType.NUMBER, "0")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
colorStringA cor mínima a ser definida.
typeInterpolationTypeO tipo de interpolação de minpoint a ser definido.
valueStringO valor mínimo a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setItalic(italic)

Define o itálico do texto para o formato da regra de formatação condicional. Se italic for true, a regra coloca o texto em itálico se a condição é atendida; se for false, a regra remove qualquer o itálico existente se a condição for atendida. Transmitir null remove o itálico configuração de formato da regra.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn their
// text italic if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setItalic(true)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
italicBooleanSe o texto deve ou não ficar em itálico se a condição de formato for atendida. null remove essa configuração.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setRanges(ranges)

Define um ou mais intervalos aos quais esta regra de formato condicional é aplicada. Essa operação substitui os intervalos existentes. Definir uma matriz vazia limpa todos os intervalos existentes. Uma regra deve ter pelo menos um intervalo.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 and range D4:F6
// to turn red if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeOne = sheet.getRange("A1:B3");
var rangeTwo = sheet.getRange("D4:F6");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([rangeOne, rangeTwo])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
rangesRange[]Os intervalos aos quais esta regra de formatação condicional é aplicada.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setStrikethrough(strikethrough)

Define o tachado para o formato da regra de formatação condicional. Se strikethrough for true, a regra vai exibir o texto se a condição for atendida. se for false, a regra remove qualquer formatação tachada existente se a condição for atendida. Transmitindo null remove a configuração de formato tachado da regra.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to strikethrough
// their text if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setStrikethrough(true)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
strikethroughBooleanSe o texto deve ou não ser riscado se a condição de formato for met; null remove essa configuração.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


setUnderline(underline)

Define o sublinhado do texto para o formato da regra de formatação condicional. Se underline for true, a regra sublinha o texto se a condição for atendida. se for false, a regra remove qualquer sublinhados existentes se a condição for atendida. Transmitir null remove o sublinhado configuração de formato da regra.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to underline
// their text if the cell has text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setUnderline(true)
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
underlineBooleanSe o texto deve ou não ser sublinhado se a condição de formato for atendida. null remove essa configuração.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenCellEmpty()

Define a regra de formatação condicional a ser acionada quando a célula estiver vazia.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they are empty.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenCellEmpty()
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenCellNotEmpty()

Define a regra de formatação condicional a ser acionada quando a célula não está vazia.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they are not empty.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenCellNotEmpty()
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenDateAfter(date)

Define a regra de formatação condicional a ser acionada quando uma data for posterior ao valor determinado.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a date after 11/4/1993.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateAfter(new Date("11/4/1993"))
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
dateDateA data mais recente.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenDateAfter(date)

Define a regra de formatação condicional para ser acionada quando uma data for posterior à data relativa determinada.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a date after today.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateAfter(SpreadsheetApp.RelativeDate.TODAY)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
dateRelativeDateA data mais recente em relação ao tipo de data selecionado.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenDateBefore(date)

Define a regra de formatação condicional para ser acionada quando uma data for anterior à data determinada.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a date before 11/4/1993.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateBefore(new Date("11/4/1993"))
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
dateDateA data inaceitável mais antiga.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenDateBefore(date)

Define a regra de formatação condicional para ser acionada quando uma data for anterior à data relativa determinada.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a date before today.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateBefore(SpreadsheetApp.RelativeDate.TODAY)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
dateRelativeDateA data mais recente em relação ao tipo de data selecionado.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenDateEqualTo(date)

Define a regra de formatação condicional a ser acionada quando uma data for igual à data especificada.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain the date 11/4/1993.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateEqualTo(new Date("11/4/1993"))
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
dateDateA única data aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenDateEqualTo(date)

Define a regra de formatação condicional a ser acionada quando uma data for igual à data relativa determinada.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain todays date.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenDateEqualTo(SpreadsheetApp.RelativeDate.TODAY)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
dateRelativeDateA data mais recente em relação ao tipo de data selecionado.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenFormulaSatisfied(formula)

Define a regra de formatação condicional a ser acionada quando a fórmula especificada for avaliada como true.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they satisfy the condition "=EQ(B4, C3)".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenFormulaSatisfied("=EQ(B4, C3)")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
formulaStringUma fórmula personalizada que muda para true se a entrada for válida.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenNumberBetween(start, end)

Define a regra de formatação condicional a ser acionada quando um número estiver entre dois ou for um deles. valores especificados.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number between 1 and 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
startNumberO menor valor aceitável.
endNumberO maior valor aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenNumberEqualTo(number)

Define a regra de formatação condicional a ser acionada quando um número for igual ao valor determinado.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain the number 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberEqualTo(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
numberNumberO único valor aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenNumberGreaterThan(number)

Define o acionamento da regra de formatação condicional quando um número é maior que o valor fornecido.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red
// if they contain a number greater than 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberGreaterThan(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
numberNumberO maior valor inaceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenNumberGreaterThanOrEqualTo(number)

Define a regra de formatação condicional a ser acionada quando um número for maior ou igual ao número informado .

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number greater than or equal to 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberGreaterThanOrEqualTo(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
numberNumberO menor valor aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenNumberLessThan(number)

Define a regra de formatação condicional a ser acionada quando um número menor que o especificado .

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number less than 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberLessThan(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
numberNumberO menor valor inaceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenNumberLessThanOrEqualTo(number)

Define a regra de formatação condicional a ser acionada quando um número menor ou igual ao número fornecido .

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number less than or equal to 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberLessThanOrEqualTo(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
numberNumberO maior valor aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenNumberNotBetween(start, end)

Define a regra de formatação condicional a ser acionada quando um número não está entre e não é dois valores especificados.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain a number not between 1 and 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberNotBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
startNumberO menor valor inaceitável.
endNumberO maior valor inaceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenNumberNotEqualTo(number)

Define a regra de formatação condicional para ser acionada quando um número não for igual ao valor informado.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they don't contain the number 10.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberNotEqualTo(10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
numberNumberO único valor inaceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenTextContains(text)

Define a regra de formatação condicional a ser acionada quando a entrada contiver o valor determinado.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they contain the text "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextContains("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
textStringO valor que a entrada precisa conter.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenTextDoesNotContain(text)

Define a regra de formato condicional a ser acionada quando a entrada não contiver o .

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they don't contain the text "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextDoesNotContain("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
textStringO valor que a entrada não pode conter.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenTextEndsWith(text)

Define a regra de formatação condicional a ser acionada quando a entrada terminar com o valor determinado.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they end with the text "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEndsWith("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
textStringTexto a ser comparado com o fim da string.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenTextEqualTo(text)

Define a regra de formatação condicional a ser acionada quando a entrada for igual ao valor determinado.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they have text equal to "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextEqualTo("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
textStringO único valor aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


whenTextStartsWith(text)

Define a regra de formatação condicional a ser acionada quando a entrada começar com o valor determinado.

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if
// they start with the text "hello".

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B3");
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenTextStartsWith("hello")
    .setBackground("#FF0000")
    .setRanges([range])
    .build();
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
textStringTexto a ser comparado com o início da string.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.


withCriteria(criteria, args)

Define a regra de formatação condicional como critérios definidos por valores BooleanCriteria. normalmente retirados dos criteria e arguments de uma regra atual.

// Adds a new conditional format rule that is a copy of the first active
// conditional format rule, except it instead sets its cells to have a black
// background color.

var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
var booleanCondition = rules[0].getBooleanCondition();
if (booleanCondition != null) {
  var rule = SpreadsheetApp.newConditionalFormatRule()
      .withCriteria(booleanCondition.getCriteriaType(),
         booleanCondition.getCriteriaValues())
      .setBackground("#000000")
      .setRanges(rule.getRanges())
      .build();
  rules.push(rule);
}
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
criteriaBooleanCriteriaO tipo de critérios do formato condicional.
argsObject[]Uma matriz de argumentos apropriados para o tipo de critério. o número de argumentos e os tipos deles correspondem ao método when...() correspondente acima.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.