Class ConditionalFormatRuleBuilder

ConditionalFormatRuleBuilder

Es un compilador para reglas de formato 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étodoTipo de datos que se muestraDescripción breve
build()ConditionalFormatRuleConstruye una regla de formato condicional a partir de la configuración aplicada al compilador.
copy()ConditionalFormatRuleBuilderDevuelve un ajuste predeterminado del compilador de reglas con la configuración de esta regla.
getBooleanCondition()BooleanConditionRecupera la información de BooleanCondition de la regla si esta usa criterios de condición booleana.
getGradientCondition()GradientConditionRecupera la información de GradientCondition de la regla si esta usa criterios de condición de gradiente.
getRanges()Range[]Recupera los rangos a los que se aplica esta regla de formato condicional.
setBackground(color)ConditionalFormatRuleBuilderEstablece el color de fondo para el formato de la regla de formato condicional.
setBackgroundObject(color)ConditionalFormatRuleBuilderEstablece el color de fondo para el formato de la regla de formato condicional.
setBold(bold)ConditionalFormatRuleBuilderEstablece el texto en negrita para el formato de la regla de formato condicional.
setFontColor(color)ConditionalFormatRuleBuilderEstablece el color de fuente para el formato de la regla de formato condicional.
setFontColorObject(color)ConditionalFormatRuleBuilderEstablece el color de fuente para el formato de la regla de formato condicional.
setGradientMaxpoint(color)ConditionalFormatRuleBuilderBorra el valor máximo del punto de gradiente de la regla de formato condicional y, en su lugar, usa el valor máximo de los rangos de la regla.
setGradientMaxpointObject(color)ConditionalFormatRuleBuilderBorra el valor máximo del punto de gradiente de la regla de formato condicional y, en su lugar, usa el valor máximo de los rangos de la regla.
setGradientMaxpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderEstablece los campos de punto máximo del gradiente de la regla de formato condicional.
setGradientMaxpointWithValue(color, type, value)ConditionalFormatRuleBuilderEstablece los campos de punto máximo del gradiente de la regla de formato condicional.
setGradientMidpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderEstablece los campos de punto medio del gradiente de la regla de formato condicional.
setGradientMidpointWithValue(color, type, value)ConditionalFormatRuleBuilderEstablece los campos de punto medio del gradiente de la regla de formato condicional.
setGradientMinpoint(color)ConditionalFormatRuleBuilderBorra el valor del punto mínimo del gradiente de la regla de formato condicional y, en su lugar, usa el valor mínimo de los rangos de la regla.
setGradientMinpointObject(color)ConditionalFormatRuleBuilderBorra el valor del punto mínimo del gradiente de la regla de formato condicional y, en su lugar, usa el valor mínimo de los rangos de la regla.
setGradientMinpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderEstablece los campos de punto mínimo del gradiente de la regla de formato condicional.
setGradientMinpointWithValue(color, type, value)ConditionalFormatRuleBuilderEstablece los campos de punto mínimo del gradiente de la regla de formato condicional.
setItalic(italic)ConditionalFormatRuleBuilderEstablece el texto en cursiva para el formato de la regla de formato condicional.
setRanges(ranges)ConditionalFormatRuleBuilderEstablece uno o más rangos a los que se aplica esta regla de formato condicional.
setStrikethrough(strikethrough)ConditionalFormatRuleBuilderEstablece el tachado del texto para el formato de la regla de formato condicional.
setUnderline(underline)ConditionalFormatRuleBuilderEstablece el subrayado del texto para el formato de la regla de formato condicional.
whenCellEmpty()ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando la celda esté vacía.
whenCellNotEmpty()ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando la celda no esté vacía.
whenDateAfter(date)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando una fecha sea posterior al valor determinado.
whenDateAfter(date)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando una fecha sea posterior a la fecha relativa determinada.
whenDateBefore(date)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando una fecha sea anterior a la fecha determinada.
whenDateBefore(date)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando una fecha sea anterior a la fecha relativa determinada.
whenDateEqualTo(date)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando una fecha sea igual a la fecha determinada.
whenDateEqualTo(date)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando una fecha sea igual a la fecha relativa determinada.
whenFormulaSatisfied(formula)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando la fórmula determinada se evalúe como true.
whenNumberBetween(start, end)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando un número se encuentre entre dos valores especificados o sea igual a cualquiera de ellos.
whenNumberEqualTo(number)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando un número sea igual al valor determinado.
whenNumberGreaterThan(number)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando un número sea mayor que el valor determinado.
whenNumberGreaterThanOrEqualTo(number)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando un número sea mayor o igual que el valor determinado.
whenNumberLessThan(number)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando un número sea menor que el valor determinado.
whenNumberLessThanOrEqualTo(number)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando un número sea menor o igual que el valor determinado.
whenNumberNotBetween(start, end)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando un número no se encuentre entre dos valores especificados ni sea igual a ninguno de ellos.
whenNumberNotEqualTo(number)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando un número no sea igual al valor determinado.
whenTextContains(text)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando la entrada contenga el valor determinado.
whenTextDoesNotContain(text)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando la entrada no contenga el valor determinado.
whenTextEndsWith(text)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando la entrada termine con el valor determinado.
whenTextEqualTo(text)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando la entrada sea igual al valor determinado.
whenTextStartsWith(text)ConditionalFormatRuleBuilderEstablece la regla de formato condicional para que se active cuando la entrada comience con el valor determinado.
withCriteria(criteria, args)ConditionalFormatRuleBuilderEstablece la regla de formato condicional según los criterios definidos por los valores de BooleanCriteria, que suelen tomarse de los valores de criteria y arguments de una regla existente.

Documentación detallada

build()

Construye una regla de formato condicional a partir de la configuración aplicada al compilador.

Volver

ConditionalFormatRule: Es una representación de la regla de formato condicional.


copy()

Devuelve un ajuste predeterminado del compilador de reglas con la configuración de esta regla.

Volver

ConditionalFormatRuleBuilder: Es un compilador basado en la configuración de esta regla.


getBooleanCondition()

Recupera la información de BooleanCondition de la regla si esta usa criterios de condición booleana. De lo contrario, devuelve 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());
}

Volver

BooleanCondition: Es el objeto de condición booleana o null si la regla no usa una condición booleana.


getGradientCondition()

Recupera la información de GradientCondition de la regla si esta usa criterios de condición de gradiente. De lo contrario, devuelve 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());
}

Volver

GradientCondition: Es el objeto de condición de gradiente o null si la regla no usa una condición de gradiente.


getRanges()

Recupera los rangos a los que se aplica esta regla de formato condicional.

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

Volver

Range[]: Son los rangos a los que se aplica esta regla de formato condicional.


setBackground(color)

Establece el color de fondo para el formato de la regla de formato condicional. Si pasas null, se quitará el parámetro de configuración del formato de color de fondo de la regla.

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

NombreTipoDescripción
colorStringEl color deseado o null para borrarlo

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setBackgroundObject(color)

Establece el color de fondo para el formato de la regla de formato condicional. Si pasas null, se quitará el parámetro de configuración del formato de color de fondo de la regla.

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

NombreTipoDescripción
colorColorEs el objeto de color deseado o null para borrar.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setBold(bold)

Establece el texto en negrita para el formato de la regla de formato condicional. Si bold es true, la regla aplica negrita al texto si se cumple la condición; si es false, la regla quita cualquier negrita existente si se cumple la condición. Si pasas null, se quitará el parámetro de configuración de formato en negrita de la regla.

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

NombreTipoDescripción
boldBooleanIndica si el texto debe estar en negrita si se cumple la condición de formato. null quita este parámetro de configuración.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setFontColor(color)

Establece el color de fuente para el formato de la regla de formato condicional. Si pasas null, se quitará el parámetro de configuración del formato de color de la fuente de la regla.

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

NombreTipoDescripción
colorStringEl color deseado o null para borrarlo

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setFontColorObject(color)

Establece el color de fuente para el formato de la regla de formato condicional. Si pasas null, se quitará el parámetro de configuración del formato de color de la fuente de la regla.

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

NombreTipoDescripción
colorColorEs el objeto de color deseado o null para borrar.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMaxpoint(color)

Borra el valor máximo del punto de gradiente de la regla de formato condicional y, en su lugar, usa el valor máximo de los rangos de la regla. También establece el color del punto máximo del gradiente en el color 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

NombreTipoDescripción
colorStringEs el color del punto máximo que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMaxpointObject(color)

Borra el valor máximo del punto de gradiente de la regla de formato condicional y, en su lugar, usa el valor máximo de los rangos de la regla. También establece el color del punto máximo del gradiente en el color 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.

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

NombreTipoDescripción
colorColorEs el objeto de color de punto máximo que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMaxpointObjectWithValue(color, type, value)

Establece los campos de punto máximo del gradiente de la regla de formato 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

NombreTipoDescripción
colorColorEs el color del punto máximo que se establecerá.
typeInterpolationTypeEs el tipo de interpolación de punto máximo que se configurará.
valueStringEs el valor de maxpoint que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMaxpointWithValue(color, type, value)

Establece los campos de punto máximo del gradiente de la regla de formato 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

NombreTipoDescripción
colorStringEs el color del punto máximo que se establecerá.
typeInterpolationTypeEs el tipo de interpolación de punto máximo que se configurará.
valueStringEs el valor de maxpoint que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMidpointObjectWithValue(color, type, value)

Establece los campos de punto medio del gradiente de la regla de formato condicional. Borra todos los campos de punto medio si el tipo de interpolación que se pasó es 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

NombreTipoDescripción
colorColorEs el color del punto medio que se establecerá.
typeInterpolationTypeEs el tipo de interpolación del punto medio que se establecerá o null para borrar.
valueStringEs el valor del punto medio que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMidpointWithValue(color, type, value)

Establece los campos de punto medio del gradiente de la regla de formato condicional. Borra todos los campos de punto medio si el tipo de interpolación que se pasó es 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

NombreTipoDescripción
colorStringEs el color del punto medio que se establecerá.
typeInterpolationTypeEs el tipo de interpolación del punto medio que se establecerá o null para borrar.
valueStringEs el valor del punto medio que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMinpoint(color)

Borra el valor del punto mínimo del gradiente de la regla de formato condicional y, en su lugar, usa el valor mínimo de los rangos de la regla. También establece el color del punto mínimo del gradiente en el color 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

NombreTipoDescripción
colorStringEs el color del punto mínimo que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMinpointObject(color)

Borra el valor del punto mínimo del gradiente de la regla de formato condicional y, en su lugar, usa el valor mínimo de los rangos de la regla. También establece el color del punto mínimo del gradiente en el color 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.

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

NombreTipoDescripción
colorColorEs el objeto de color de punto mínimo que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMinpointObjectWithValue(color, type, value)

Establece los campos de punto mínimo del gradiente de la regla de formato 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

NombreTipoDescripción
colorColorEs el color del punto mínimo que se establecerá.
typeInterpolationTypeEs el tipo de interpolación del punto mínimo que se establecerá.
valueStringEs el valor del punto mínimo que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setGradientMinpointWithValue(color, type, value)

Establece los campos de punto mínimo del gradiente de la regla de formato 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

NombreTipoDescripción
colorStringEs el color del punto mínimo que se establecerá.
typeInterpolationTypeEs el tipo de interpolación del punto mínimo que se establecerá.
valueStringEs el valor del punto mínimo que se establecerá.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setItalic(italic)

Establece el texto en cursiva para el formato de la regla de formato condicional. Si italic es true, la regla aplica cursiva al texto si se cumple la condición; si es false, la regla quita cualquier cursiva existente si se cumple la condición. Si pasas null, se quita el parámetro de configuración de formato en cursiva de la regla.

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

NombreTipoDescripción
italicBooleanIndica si el texto debe estar en cursiva si se cumple la condición de formato. null quita este parámetro de configuración.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setRanges(ranges)

Establece uno o más rangos a los que se aplica esta regla de formato condicional. Esta operación reemplaza cualquier rango existente. Si se establece un array vacío, se borrarán los rangos existentes. Una regla debe tener al menos un rango.

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

NombreTipoDescripción
rangesRange[]Son los rangos a los que se aplica esta regla de formato condicional.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setStrikethrough(strikethrough)

Establece el tachado del texto para el formato de la regla de formato condicional. Si strikethrough es true, la regla tacha el texto si se cumple la condición; si es false, la regla quita cualquier formato de tachado existente si se cumple la condición. Si pasas null, se quita el parámetro de configuración de formato de tachado de la regla.

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

NombreTipoDescripción
strikethroughBooleanIndica si el texto debe aparecer tachado si se cumple la condición de formato. null quita este parámetro de configuración.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


setUnderline(underline)

Establece el subrayado del texto para el formato de la regla de formato condicional. Si underline es true, la regla subraya el texto si se cumple la condición; si es false, la regla quita los subrayados existentes si se cumple la condición. Si pasas null, se quita el parámetro de configuración de formato de subrayado de la regla.

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

NombreTipoDescripción
underlineBooleanIndica si el texto debe subrayarse cuando se cumple la condición de formato. null quita este parámetro de configuración.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenCellEmpty()

Establece la regla de formato condicional para que se active cuando la celda esté vacía.

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

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenCellNotEmpty()

Establece la regla de formato condicional para que se active cuando la celda no esté vacía.

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

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenDateAfter(date)

Establece la regla de formato condicional para que se active cuando una fecha sea posterior al 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.

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

NombreTipoDescripción
dateDateEs la fecha más reciente.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenDateAfter(date)

Establece la regla de formato condicional para que se active cuando una fecha sea posterior a la fecha 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.

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

NombreTipoDescripción
dateRelativeDateEs la fecha más reciente en relación con el tipo de fecha seleccionado.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenDateBefore(date)

Establece la regla de formato condicional para que se active cuando una fecha sea anterior a la fecha 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.

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

NombreTipoDescripción
dateDateEs la fecha más temprana inaceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenDateBefore(date)

Establece la regla de formato condicional para que se active cuando una fecha sea anterior a la fecha 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.

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

NombreTipoDescripción
dateRelativeDateEs la fecha más reciente en relación con el tipo de fecha seleccionado.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenDateEqualTo(date)

Establece la regla de formato condicional para que se active cuando una fecha sea igual a la fecha determinada.

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

NombreTipoDescripción
dateDateEs la única fecha aceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenDateEqualTo(date)

Establece la regla de formato condicional para que se active cuando una fecha sea igual a la fecha 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.

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

NombreTipoDescripción
dateRelativeDateEs la fecha más reciente en relación con el tipo de fecha seleccionado.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenFormulaSatisfied(formula)

Establece la regla de formato condicional para que se active cuando la fórmula determinada se evalúe 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

NombreTipoDescripción
formulaStringEs una fórmula personalizada que se evalúa como true si la entrada es válida.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenNumberBetween(start, end)

Establece la regla de formato condicional para que se active cuando un número se encuentre entre dos valores especificados o sea igual a cualquiera de ellos.

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

NombreTipoDescripción
startNumberEs el valor más bajo aceptable.
endNumberEs el valor más alto aceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenNumberEqualTo(number)

Establece la regla de formato condicional para que se active cuando un número sea igual al 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.

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

NombreTipoDescripción
numberNumberEs el único valor aceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenNumberGreaterThan(number)

Establece la regla de formato condicional para que se active cuando un número sea mayor que el valor determinado.

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

NombreTipoDescripción
numberNumberEs el valor más alto inaceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenNumberGreaterThanOrEqualTo(number)

Establece la regla de formato condicional para que se active cuando un número sea mayor o igual que el valor determinado.

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

NombreTipoDescripción
numberNumberEs el valor más bajo aceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenNumberLessThan(number)

Establece la regla de formato condicional para que se active cuando un número sea menor que el valor determinado.

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

NombreTipoDescripción
numberNumberEs el valor más bajo inaceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenNumberLessThanOrEqualTo(number)

Establece la regla de formato condicional para que se active cuando un número sea menor o igual que el valor determinado.

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

NombreTipoDescripción
numberNumberEs el valor más alto aceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenNumberNotBetween(start, end)

Establece la regla de formato condicional para que se active cuando un número no se encuentre entre dos valores especificados ni sea igual a ninguno de ellos.

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

NombreTipoDescripción
startNumberEs el valor más bajo inaceptable.
endNumberEs el valor más alto inaceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenNumberNotEqualTo(number)

Establece la regla de formato condicional para que se active cuando un número no sea igual al valor determinado.

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

NombreTipoDescripción
numberNumberEs el único valor inaceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenTextContains(text)

Establece la regla de formato condicional para que se active cuando la entrada contenga el 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".

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

NombreTipoDescripción
textStringEs el valor que debe contener la entrada.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenTextDoesNotContain(text)

Establece la regla de formato condicional para que se active cuando la entrada no contenga el valor determinado.

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

NombreTipoDescripción
textStringValor que no debe contener la entrada.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenTextEndsWith(text)

Establece la regla de formato condicional para que se active cuando la entrada termine con el 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".

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

NombreTipoDescripción
textStringTexto para comparar con el final de la cadena.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenTextEqualTo(text)

Establece la regla de formato condicional para que se active cuando la entrada sea igual al 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".

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

NombreTipoDescripción
textStringEs el único valor aceptable.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


whenTextStartsWith(text)

Establece la regla de formato condicional para que se active cuando la entrada comience con el 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".

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

NombreTipoDescripción
textStringTexto para comparar con el comienzo de la cadena.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.


withCriteria(criteria, args)

Establece la regla de formato condicional según los criterios definidos por los valores de BooleanCriteria, que suelen tomarse de los valores de criteria y arguments de una regla 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

NombreTipoDescripción
criteriaBooleanCriteriaEs el tipo de criterio de formato condicional.
argsObject[]Es un array de argumentos adecuados para el tipo de criterio. La cantidad de argumentos y su tipo coinciden con el método when...() correspondiente anterior.

Volver

ConditionalFormatRuleBuilder: Es el compilador, para encadenar.