Esta página foi traduzida pela API Cloud Translation.

Class ConditionalFormatRuleBuilder

Builder para 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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Métodos

Método	Tipo de retorno	Breve descrição
`build()`	`ConditionalFormatRule`	Cria uma regra de formatação condicional com base nas configurações aplicadas ao construtor.
`copy()`	`ConditionalFormatRuleBuilder`	Retorna uma regra predefinida do criador de regras com as configurações dela.
`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 em que esta regra de formatação condicional é aplicada.
`setBackground(color)`	`ConditionalFormatRuleBuilder`	Define a cor de plano de fundo para a regra de formatação condicional.
`setBackgroundObject(color)`	`ConditionalFormatRuleBuilder`	Define a cor de plano de fundo para a regra de formatação condicional.
`setBold(bold)`	`ConditionalFormatRuleBuilder`	Define o negrito do texto para a regra de formatação condicional.
`setFontColor(color)`	`ConditionalFormatRuleBuilder`	Define a cor da fonte para a formatação condicional.
`setFontColorObject(color)`	`ConditionalFormatRuleBuilder`	Define a cor da fonte para a formatação condicional.
`setGradientMaxpoint(color)`	`ConditionalFormatRuleBuilder`	Limpa o valor de ponto máximo do gradiente da regra de formatação condicional e usa o valor máximo nos intervalos da regra.
`setGradientMaxpointObject(color)`	`ConditionalFormatRuleBuilder`	Limpa o valor de 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)`	`ConditionalFormatRuleBuilder`	Define os campos de ponto máximo do gradiente da regra de formatação condicional.
`setGradientMaxpointWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	Define os campos de ponto máximo do gradiente da regra de formatação condicional.
`setGradientMidpointObjectWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	Define os campos de ponto médio do gradiente da regra de formatação condicional.
`setGradientMidpointWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	Define os campos de ponto médio do gradiente da regra de formatação condicional.
`setGradientMinpoint(color)`	`ConditionalFormatRuleBuilder`	Limpa o valor de ponto mínimo do gradiente da regra de formatação condicional e usa o valor mínimo nos intervalos da regra.
`setGradientMinpointObject(color)`	`ConditionalFormatRuleBuilder`	Limpa o valor de ponto mínimo do gradiente da regra de formatação condicional e usa o valor mínimo nos intervalos da regra.
`setGradientMinpointObjectWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	Define os campos de ponto mínimo do gradiente da regra de formatação condicional.
`setGradientMinpointWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	Define os campos de ponto mínimo do gradiente da regra de formatação condicional.
`setItalic(italic)`	`ConditionalFormatRuleBuilder`	Define o texto em itálico para o formato da regra de formatação condicional.
`setRanges(ranges)`	`ConditionalFormatRuleBuilder`	Define um ou mais intervalos em que essa regra de formatação condicional é aplicada.
`setStrikethrough(strikethrough)`	`ConditionalFormatRuleBuilder`	Define o sublinhado do texto para o formato da regra de formatação condicional.
`setUnderline(underline)`	`ConditionalFormatRuleBuilder`	Define o sublinhado de texto para o formato da regra de formatação condicional.
`whenCellEmpty()`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando a célula estiver vazia.
`whenCellNotEmpty()`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando a célula não estiver vazia.
`whenDateAfter(date)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando uma data for posterior ao valor fornecido.
`whenDateAfter(date)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando uma data for posterior à data relativa especificada.
`whenDateBefore(date)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando uma data estiver antes da data especificada.
`whenDateBefore(date)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando uma data estiver antes da data relativa especificada.
`whenDateEqualTo(date)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando uma data for igual à data especificada.
`whenDateEqualTo(date)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando uma data for igual à data relativa especificada.
`whenFormulaSatisfied(formula)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando a fórmula for avaliada como `true`.
`whenNumberBetween(start, end)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando um número estiver entre dois valores especificados ou for um deles.
`whenNumberEqualTo(number)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando um número for igual ao valor fornecido.
`whenNumberGreaterThan(number)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando um número for maior que o valor fornecido.
`whenNumberGreaterThanOrEqualTo(number)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando um número for maior ou igual ao valor especificado.
`whenNumberLessThan(number)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando um número for menor que o valor fornecido.
`whenNumberLessThanOrEqualTo(number)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando um número for menor ou igual ao valor especificado.
`whenNumberNotBetween(start, end)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando um número não estiver entre dois valores especificados e não for igual a nenhum deles.
`whenNumberNotEqualTo(number)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando um número não for igual ao valor fornecido.
`whenTextContains(text)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando a entrada contém o valor fornecido.
`whenTextDoesNotContain(text)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando a entrada não contém o valor especificado.
`whenTextEndsWith(text)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando a entrada terminar com o valor fornecido.
`whenTextEqualTo(text)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando a entrada for igual ao valor fornecido.
`whenTextStartsWith(text)`	`ConditionalFormatRuleBuilder`	Define a regra de formatação condicional para acionar quando a entrada começar com o valor fornecido.
`withCriteria(criteria, args)`	`ConditionalFormatRuleBuilder`	Define a regra de formato condicional para critérios definidos por valores `BooleanCriteria`, normalmente retirados do `criteria` e `arguments` de uma regra existente.

Documentação detalhada

`build()`

Cria uma regra de formatação condicional com base nas configurações aplicadas ao construtor.

Retornar

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

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

`setBackground(color)`

Define a cor de plano de fundo para a regra de formatação condicional. A transmissão de null remove a configuração de formato de cor de 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".

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

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	A cor desejada ou `null` para limpar.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setBackgroundObject(color)`

Define a cor de plano de fundo para a regra de formatação condicional. A transmissão de null remove a configuração de formato de cor de 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".

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

Parâmetros

Nome	Tipo	Descrição
`color`	`Color`	O objeto de cor desejado ou `null` para limpar.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setBold(bold)`

Define o negrito do texto para a regra de formatação condicional. Se bold for true, a regra vai destacar o texto em negrito se a condição for atendida. Se false, a regra vai remover qualquer negrito existente se a condição for atendida. A transmissão de null remove a configuração de formato em negrito da 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".

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

Parâmetros

Nome	Tipo	Descrição
`bold`	`Boolean`	Define se o texto precisa ou não ser 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 a formatação condicional. A transmissão de null remove 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".

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

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	A cor desejada ou `null` para limpar.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setFontColorObject(color)`

Define a cor da fonte para a formatação condicional. A transmissão de null remove 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".

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

Parâmetros

Nome	Tipo	Descrição
`color`	`Color`	O objeto de cor desejado ou `null` para limpar.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setGradientMaxpoint(color)`

Limpa o valor de 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.

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

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	A cor do ponto máximo a ser definida.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setGradientMaxpointObject(color)`

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

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

Parâmetros

Nome	Tipo	Descrição
`color`	`Color`	O objeto de cor de 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.

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

Parâmetros

Nome	Tipo	Descrição
`color`	`Color`	A cor do ponto máximo a ser definida.
`type`	`InterpolationType`	O tipo de interpolação de ponto máximo a ser definido.
`value`	`String`	O valor 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.

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

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	A cor do ponto máximo a ser definida.
`type`	`InterpolationType`	O tipo de interpolação de ponto máximo a ser definido.
`value`	`String`	O valor 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.

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

Parâmetros

Nome	Tipo	Descrição
`color`	`Color`	A cor do ponto médio a ser definida.
`type`	`InterpolationType`	O tipo de interpolação de ponto médio a ser definido ou `null` para limpar.
`value`	`String`	O valor do ponto 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.

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

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	A cor do ponto médio a ser definida.
`type`	`InterpolationType`	O tipo de interpolação de ponto médio a ser definido ou `null` para limpar.
`value`	`String`	O valor do ponto médio a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setGradientMinpoint(color)`

Limpa o valor de ponto 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 do ponto mínimo 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.

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

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	A cor do ponto mínimo a ser definida.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setGradientMinpointObject(color)`

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

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

Parâmetros

Nome	Tipo	Descrição
`color`	`Color`	O objeto de cor mínimo a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setGradientMinpointObjectWithValue(color, type, value)`

Define os campos de ponto mínimo 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 to accent 2 to
// accent 3 colors, based on their values in comparison to the values 0, 50, and
// 100.

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

Parâmetros

Nome	Tipo	Descrição
`color`	`Color`	A cor do ponto mínimo a ser definida.
`type`	`InterpolationType`	O tipo de interpolação de ponto mínimo a ser definido.
`value`	`String`	O valor de ponto mínimo a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setGradientMinpointWithValue(color, type, value)`

Define os campos de ponto mínimo 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 to green to blue, based on
// their values in comparison to the values 0, 50, and 100.

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

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	A cor do ponto mínimo a ser definida.
`type`	`InterpolationType`	O tipo de interpolação de ponto mínimo a ser definido.
`value`	`String`	O valor de ponto mínimo a ser definido.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setItalic(italic)`

Define o texto em itálico para o formato da regra de formatação condicional. Se italic for true, a regra vai italizar o texto se a condição for atendida. Se for false, a regra vai remover qualquer itálico existente se a condição for atendida. A transmissão de null remove a configuração de formatação em itálico 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".

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

Parâmetros

Nome	Tipo	Descrição
`italic`	`Boolean`	Define se o texto precisa ou não ser em itálico quando a condição de formato é atendida. `null` remove essa configuração.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setRanges(ranges)`

Define um ou mais intervalos em que essa regra de formatação condicional é aplicada. Essa operação substitui todos os intervalos existentes. A definição de uma matriz vazia limpa todos os intervalos existentes. Uma regra precisa 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.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeOne = sheet.getRange('A1:B3');
const rangeTwo = sheet.getRange('D4:F6');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([rangeOne, rangeTwo])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Parâmetros

Nome	Tipo	Descrição
`ranges`	`Range[]`	Os intervalos em que essa regra de formatação condicional é aplicada.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setStrikethrough(strikethrough)`

Define o sublinhado do texto para o formato da regra de formatação condicional. Se strikethrough for true, a regra vai sublinhar o texto se a condição for atendida. Se for false, a regra removerá qualquer formatação de sublinhado existente se a condição for atendida. A transmissão de null remove a configuração de formato de 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".

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

Parâmetros

Nome	Tipo	Descrição
`strikethrough`	`Boolean`	Define se o texto precisa ser tachado quando a condição de formato é atendida. `null` remove essa configuração.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`setUnderline(underline)`

Define o sublinhado de texto para o formato da regra de formatação condicional. Se underline for true, a regra sublinhará o texto se a condição for atendida. Se false, a regra removerá todos os sublinhados existentes se a condição for atendida. A transmissão de null remove a configuração de formato de sublinhado 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".

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

Parâmetros

Nome	Tipo	Descrição
`underline`	`Boolean`	Define se o texto precisa ou não ser sublinhado quando a condição de formato é atendida. `null` remove essa configuração.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenCellEmpty()`

Define a regra de formatação condicional para acionar 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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenCellEmpty()
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenCellNotEmpty()`

Define a regra de formatação condicional para acionar quando a célula não estiver vazia.

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

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenDateAfter(date)`

Define a regra de formatação condicional para acionar quando uma data for posterior ao valor fornecido.

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

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

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	A data mais recente.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenDateAfter(date)`

Define a regra de formatação condicional para acionar quando uma data for posterior à data relativa especificada.

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

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

Parâmetros

Nome	Tipo	Descrição
`date`	`RelativeDate`	A 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 acionar quando uma data estiver antes da data especificada.

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

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

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	A data mais antiga inaceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenDateBefore(date)`

Define a regra de formatação condicional para acionar quando uma data estiver antes da data relativa especificada.

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

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

Parâmetros

Nome	Tipo	Descrição
`date`	`RelativeDate`	A 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 para acionar 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.

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

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	A única data aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenDateEqualTo(date)`

Define a regra de formatação condicional para acionar quando uma data for igual à data relativa especificada.

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

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

Parâmetros

Nome	Tipo	Descrição
`date`	`RelativeDate`	A 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 para acionar quando a fórmula 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)".

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

Parâmetros

Nome	Tipo	Descrição
`formula`	`String`	Uma fórmula personalizada que é avaliada como `true` se a entrada for válida.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenNumberBetween(start, end)`

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

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

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

Parâmetros

Nome	Tipo	Descrição
`start`	`Number`	O valor mínimo aceitável.
`end`	`Number`	O valor mais alto aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenNumberEqualTo(number)`

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

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

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

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O único valor aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenNumberGreaterThan(number)`

Define a regra de formatação condicional para acionar quando um número for 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.

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

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O valor mais alto inaceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenNumberGreaterThanOrEqualTo(number)`

Define a regra de formatação condicional para acionar quando um número for maior ou igual ao valor especificado.

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

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

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O valor mínimo aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenNumberLessThan(number)`

Define a regra de formatação condicional para acionar quando um número for menor 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 less than 10.

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

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O menor valor inaceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenNumberLessThanOrEqualTo(number)`

Define a regra de formatação condicional para acionar quando um número for menor ou igual ao valor 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 or equal to 10.

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

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O valor mais alto aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenNumberNotBetween(start, end)`

Define a regra de formatação condicional para acionar quando um número não estiver entre dois valores especificados e não for igual a nenhum deles.

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

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

Parâmetros

Nome	Tipo	Descrição
`start`	`Number`	O menor valor inaceitável.
`end`	`Number`	O valor mais alto inaceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenNumberNotEqualTo(number)`

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

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

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

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O único valor inaceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenTextContains(text)`

Define a regra de formatação condicional para acionar quando a entrada contém o valor fornecido.

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

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

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O valor que a entrada precisa conter.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenTextDoesNotContain(text)`

Define a regra de formatação condicional para acionar quando a entrada não contém o valor especificado.

// 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".

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

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O valor que a entrada não pode conter.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenTextEndsWith(text)`

Define a regra de formatação condicional para acionar quando a entrada terminar com o valor fornecido.

// 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".

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

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	Texto a ser comparado com o final da string.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenTextEqualTo(text)`

Define a regra de formatação condicional para acionar quando a entrada for igual ao valor fornecido.

// 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".

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

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O único valor aceitável.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`whenTextStartsWith(text)`

Define a regra de formatação condicional para acionar quando a entrada começar com o valor fornecido.

// 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".

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

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	Texto a ser comparado com o início da string.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.

`withCriteria(criteria, args)`

Define a regra de formato condicional para critérios definidos por valores BooleanCriteria, normalmente retirados do criteria e arguments de uma regra existente.

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

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

Parâmetros

Nome	Tipo	Descrição
`criteria`	`BooleanCriteria`	O tipo de critérios de formatação condicional.
`args`	`Object[]`	Uma matriz de argumentos apropriados ao tipo de critério. O número de argumentos e seus tipos correspondem ao método `when...()` correspondente acima.

Retornar

ConditionalFormatRuleBuilder: o builder para encadeamento.