Class RangeList

RangeList

Es una colección de una o más instancias de Range en la misma hoja. Puedes usar esta clase para aplicar operaciones en colecciones de rangos o celdas no adyacentes.

Métodos

MétodoTipo de datos que se devuelveDescripción breve
activate()RangeListSelecciona la lista de instancias de Range.
breakApart()RangeListVuelve a dividir todas las celdas combinadas horizontal o verticalmente que se encuentran dentro de la lista de rangos en celdas individuales.
check()RangeListCambia el estado de las casillas de verificación del rango a “checked”.
clear()RangeListBorra el rango de contenido, los formatos y las reglas de validación de datos para cada Range en la lista de rangos.
clear(options)RangeListBorra el rango de contenido, formato, reglas de validación de datos y comentarios, según se especifica con las opciones proporcionadas.
clearContent()RangeListBorra el contenido de cada Range de la lista de rangos y deja el formato intacto.
clearDataValidations()RangeListBorra las reglas de validación de datos para cada Range de la lista de rangos.
clearFormat()RangeListBorra el formato de texto de cada Range en la lista de rangos.
clearNote()RangeListBorra la nota de cada Range en la lista de rangos.
getRanges()Range[]Devuelve una lista de una o más instancias de Range en la misma hoja.
insertCheckboxes()RangeListInserta casillas de verificación en cada celda del rango, configuradas con true para marcar y false para desmarcar.
insertCheckboxes(checkedValue)RangeListInserta casillas de verificación en cada celda del rango, configuradas con un valor personalizado para la opción marcada y la cadena vacía para la opción desmarcada.
insertCheckboxes(checkedValue, uncheckedValue)RangeListInserta casillas de verificación en cada celda del rango, configuradas con valores personalizados para los estados de marcado y desmarcado.
removeCheckboxes()RangeListQuita todas las casillas de verificación del rango.
setBackground(color)RangeListEstablece el color de fondo para cada Range en la lista de rangos.
setBackgroundRGB(red, green, blue)RangeListEstablece el fondo en el color RGB determinado.
setBorder(top, left, bottom, right, vertical, horizontal)RangeListEstablece la propiedad de borde para cada Range en la lista de rangos.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeListEstablece la propiedad de borde con color o estilo para cada Range en la lista de rangos.
setFontColor(color)RangeListEstablece el color de fuente para cada Range en la lista de rangos.
setFontFamily(fontFamily)RangeListEstablece la familia de fuentes para cada Range en la lista de rangos.
setFontLine(fontLine)RangeListEstablece el estilo de línea de la fuente para cada Range de la lista de rangos.
setFontSize(size)RangeListEstablece el tamaño de fuente (en puntos) para cada Range de la lista de rangos.
setFontStyle(fontStyle)RangeListEstablece el estilo de fuente para cada Range en la lista de rangos.
setFontWeight(fontWeight)RangeListEstablece el grosor de la fuente para cada Range en la lista de rangos.
setFormula(formula)RangeListActualiza la fórmula para cada Range de la lista de rangos.
setFormulaR1C1(formula)RangeListActualiza la fórmula para cada Range de la lista de rangos.
setHorizontalAlignment(alignment)RangeListEstablece la alineación horizontal para cada Range en la lista de rangos.
setNote(note)RangeListEstablece el texto de la nota para cada Range en la lista de rangos.
setNumberFormat(numberFormat)RangeListEstablece el formato de número o fecha para cada Range en la lista de rangos.
setShowHyperlink(showHyperlink)RangeListEstablece si cada Range de la lista de rangos debe mostrar hipervínculos.
setTextDirection(direction)RangeListEstablece la dirección del texto para las celdas de cada Range en la lista de rangos.
setTextRotation(degrees)RangeListEstablece la configuración de rotación del texto para las celdas de cada Range en la lista de rangos.
setValue(value)RangeListEstablece el valor para cada Range en la lista de rangos.
setVerticalAlignment(alignment)RangeListEstablece la alineación vertical para cada Range en la lista de rangos.
setVerticalText(isVertical)RangeListEstablece si se debe apilar el texto de las celdas para cada Range de la lista de rangos.
setWrap(isWrapEnabled)RangeListEstablece el ajuste de texto para cada Range de la lista de rangos.
setWrapStrategy(strategy)RangeListEstablece la estrategia de ajuste de texto para cada Range de la lista de rangos.
trimWhitespace()RangeListQuita los espacios en blanco (como espacios, tabulaciones o líneas nuevas) de cada celda de esta lista de rangos.
uncheck()RangeListCambia el estado de las casillas de verificación del rango a “sin marcar”.

Documentación detallada

activate()

Selecciona la lista de instancias de Range. El último rango de la lista se establece como active range.

Nota: Esto proporciona una forma de seleccionar varios rangos.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.activate();

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

Volver

RangeList: Es la lista de rangos activos para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

breakApart()

Vuelve a dividir todas las celdas combinadas horizontal o verticalmente que se encuentran dentro de la lista de rangos en celdas individuales.

Llamar a esta función en una lista de rangos equivale a seleccionar un conjunto de rangos y, luego, el elemento de menú Formato > Combinar > Descombinar de Hojas de cálculo.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.breakApart();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

check()

Cambia el estado de las casillas de verificación del rango a “marcado”. Ignora las celdas del rango que actualmente no contienen el valor marcado o desmarcado configurado.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'checked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.check();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clear()

Borra el rango de contenido, los formatos y las reglas de validación de datos para cada Range en la lista de rangos.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clear(options)

Borra el rango de contenido, formato, reglas de validación de datos y comentarios, según se especifica con las opciones proporcionadas. De forma predeterminada, se borran todos los datos.

// The code below clears the contents of the following ranges A:A and C:C in the
// active sheet, but preserves the format, data validation rules, and comments.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear({contentsOnly: true});

Parámetros

NombreTipoDescripción
optionsObjectEs un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
commentsOnlyBooleanIndica si solo se borrarán los comentarios.
contentsOnlyBooleanIndica si solo se borrará el contenido.
formatOnlyBooleanIndica si se debe borrar solo el formato. Ten en cuenta que borrar el formato también borra las reglas de validación de datos.
validationsOnlyBooleanIndica si se deben borrar solo las reglas de validación de datos.
skipFilteredRowsBooleanIndica si se deben evitar las filas filtradas.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearContent()

Borra el contenido de cada Range de la lista de rangos y deja el formato intacto.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearContent();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearDataValidations()

Borra las reglas de validación de datos para cada Range de la lista de rangos.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearDataValidations();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearFormat()

Borra el formato de texto de cada Range en la lista de rangos.

Esto borra el formato de texto de cada rango, pero no restablece ninguna regla de formato de número.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearFormat();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearNote()

Borra la nota de cada Range en la lista de rangos.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearNote();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRanges()

Devuelve una lista de una o más instancias de Range en la misma hoja.

Volver

Range[]: Es la lista de rangos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertCheckboxes()

Inserta casillas de verificación en cada celda del rango, configuradas con true para marcar y false para desmarcar. Establece el valor de todas las celdas del rango en false.

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'true' for checked and 'false' for unchecked. Also, sets the value of each
// cell in the ranges D4 and E6 to 'false'.
rangeList.insertCheckboxes();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertCheckboxes(checkedValue)

Inserta casillas de verificación en cada celda del rango, configuradas con un valor personalizado para la opción marcada y la cadena vacía para la opción desmarcada. Establece el valor de cada celda del rango en la cadena vacía.

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and the empty string for unchecked. Also, sets the value of
// each cell in the ranges D4 and E6 to the empty string.
rangeList.insertCheckboxes('yes');

Parámetros

NombreTipoDescripción
checkedValueObjectEs el valor seleccionado para la validación de datos de la casilla de verificación.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertCheckboxes(checkedValue, uncheckedValue)

Inserta casillas de verificación en cada celda del rango, configuradas con valores personalizados para los estados de marcado y desmarcado. Establece el valor de cada celda del rango en el valor personalizado sin marcar.

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and 'no' for unchecked. Also, sets the value of each cell
// in the ranges D4 and E6 to 'no'.
rangeList.insertCheckboxes('yes', 'no');

Parámetros

NombreTipoDescripción
checkedValueObjectEs el valor seleccionado para la validación de datos de la casilla de verificación.
uncheckedValueObjectEs el valor sin seleccionar para la validación de datos de la casilla de verificación.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeCheckboxes()

Quita todas las casillas de verificación del rango. Borra la validación de datos de cada celda y, además, borra su valor si la celda contiene el valor marcado o desmarcado.

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

const rangeList1 = SpreadsheetApp.getActive().getRangeList(['A1', 'A3']);
rangeList1.setValue('yes');
// Removes the checkbox data validation in cells A1 and A3 and clears their
// value.
rangeList1.removeCheckboxes();

const rangeList2 = SpreadsheetApp.getActive().getRangeList(['A5', 'A7']);
rangeList2.setValue('random');
// Removes the checkbox data validation in cells A5 and A7 but does not clear
// their value.
rangeList2.removeCheckboxes();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBackground(color)

Establece el color de fondo para cada Range en la lista de rangos. El color se representa en notación CSS; por ejemplo, '#ffffff' o 'white'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setBackground('red');

Parámetros

NombreTipoDescripción
colorStringEl código de color de fondo en notación CSS, como '#ffffff' o 'white'. Un valor null restablece el color.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBackgroundRGB(red, green, blue)

Establece el fondo en el color RGB determinado. Este es un wrapper de conveniencia alrededor de una llamada a setBackground(color).

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
// Sets the background to red for each range in the range list.
rangeList.setBackgroundRGB(255, 0, 0);

Parámetros

NombreTipoDescripción
redIntegerValor del rojo en notación RGB.
greenIntegerEs el valor de verde en la notación RGB.
blueIntegerEs el valor de azul en la notación RGB.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBorder(top, left, bottom, right, vertical, horizontal)

Establece la propiedad de borde para cada Range en la lista de rangos. Los valores válidos son true (activado), false (desactivado) y null (sin cambios).

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom of the ranges A2:B4 and C1:D4, but leaves
// the left and right unchanged.
rangeList.setBorder(true, null, true, null, false, false);

Parámetros

NombreTipoDescripción
topBooleantrue para borde, false para ninguno y null para sin cambios.
leftBooleantrue para borde, false para ninguno y null para sin cambios.
bottomBooleantrue para borde, false para ninguno y null para sin cambios.
rightBooleantrue para borde, false para ninguno y null para sin cambios.
verticalBooleantrue para bordes verticales internos, false para ninguno y null para sin cambios.
horizontalBooleantrue para los bordes horizontales internos, false para ninguno y null para sin cambios.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBorder(top, left, bottom, right, vertical, horizontal, color, style)

Establece la propiedad de borde con color o estilo para cada Range en la lista de rangos. Los valores válidos son true (activado), false (desactivado) y null (sin cambios). El color se representa en notación CSS; por ejemplo, '#ffffff' o 'white'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom, but leaves the left and right unchanged
// of the ranges A2:B4 and C1:D4. Also sets the color to 'red', and the border
// to 'DASHED'.
rangeList.setBorder(
    true,
    null,
    true,
    null,
    false,
    false,
    'red',
    SpreadsheetApp.BorderStyle.DASHED,
);

Parámetros

NombreTipoDescripción
topBooleantrue para borde, false para ninguno y null para sin cambios.
leftBooleantrue para borde, false para ninguno y null para sin cambios.
bottomBooleantrue para borde, false para ninguno y null para sin cambios.
rightBooleantrue para borde, false para ninguno y null para sin cambios.
verticalBooleantrue para bordes verticales internos, false para ninguno y null para sin cambios.
horizontalBooleantrue para los bordes horizontales internos, false para ninguno y null para sin cambios.
colorStringColor del borde en notación CSS, como '#ffffff' o 'white', null para el color predeterminado (negro).
styleBorderStyleEs el estilo de los bordes, null para el estilo predeterminado (sólido).

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontColor(color)

Establece el color de fuente para cada Range en la lista de rangos. El color se representa en notación CSS; por ejemplo, '#ffffff' o 'white'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontColor('red');

Parámetros

NombreTipoDescripción
colorStringEl color de la fuente en notación CSS, como '#ffffff' o 'white'. Un valor null restablece el color.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontFamily(fontFamily)

Establece la familia de fuentes para cada Range en la lista de rangos. La familia de fuentes se describe con un identificador de cadena, como Arial o Roboto.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontFamily('Roboto');

Parámetros

NombreTipoDescripción
fontFamilyStringFamilia de fuentes que se establecerá. Un valor de null restablece la familia de fuentes.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontLine(fontLine)

Establece el estilo de línea de la fuente para cada Range de la lista de rangos. Las opciones de estilo de línea son 'underline', 'line-through' o 'none'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontLine('line-through');

Parámetros

NombreTipoDescripción
fontLineStringEl estilo de línea de la fuente, que puede ser 'underline', 'line-through' o 'none'. Un valor null restablece el estilo de línea de la fuente.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontSize(size)

Establece el tamaño de fuente (en puntos) para cada Range de la lista de rangos.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontSize(20);

Parámetros

NombreTipoDescripción
sizeIntegerEs el tamaño de fuente en puntos.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontStyle(fontStyle)

Establece el estilo de fuente para cada Range en la lista de rangos. Las opciones de estilo de fuente son 'italic' o 'normal'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontStyle('italic');

Parámetros

NombreTipoDescripción
fontStyleStringEl estilo de fuente, ya sea 'italic' o 'normal'. Un valor null restablece el estilo de fuente.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontWeight(fontWeight)

Establece el grosor de la fuente para cada Range en la lista de rangos. Las opciones de grosor de la fuente son 'normal' o 'bold'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontWeight('bold');

Parámetros

NombreTipoDescripción
fontWeightStringEl grosor de la fuente, ya sea 'bold' o 'normal'; un valor de null restablece el grosor de la fuente.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormula(formula)

Actualiza la fórmula para cada Range de la lista de rangos. La fórmula proporcionada debe estar en notación A1.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
rangeList.setFormula('=SUM(B1:B10)');

Parámetros

NombreTipoDescripción
formulaStringEs una cadena que representa la fórmula que se debe establecer.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormulaR1C1(formula)

Actualiza la fórmula para cada Range de la lista de rangos. La fórmula proporcionada debe estar en notación R1C1.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
// This sets the formula to be the sum of the 3 rows above B5
rangeList.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

Parámetros

NombreTipoDescripción
formulaStringEs una fórmula de cadena.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setHorizontalAlignment(alignment)

Establece la alineación horizontal para cada Range en la lista de rangos. Las opciones de alineación son 'left', 'center' o 'right'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setHorizontalAlignment('center');

Parámetros

NombreTipoDescripción
alignmentStringLa alineación, ya sea 'left', 'center' o 'normal'; un valor null restablece la alineación.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setNote(note)

Establece el texto de la nota para cada Range en la lista de rangos.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setNote('This is a note');

Parámetros

NombreTipoDescripción
noteStringEs el texto de la nota que se establecerá. Un valor de null quita la nota.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setNumberFormat(numberFormat)

Establece el formato de número o fecha para cada Range en la lista de rangos.

Los patrones de formato aceptados se describen en la guía de formato de números y fechas de la API de Sheets.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Always show 3 decimal points for the specified ranges.
rangeList.setNumberFormat('0.000');

Parámetros

NombreTipoDescripción
numberFormatStringEs una cadena de formato de número.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

Establece si cada Range de la lista de rangos debe mostrar hipervínculos.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Show hyperlinks for all the ranges.
rangeList.setShowHyperlink(true);

Parámetros

NombreTipoDescripción
showHyperlinkBooleanIndica si se debe mostrar el hipervínculo.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextDirection(direction)

Establece la dirección del texto para las celdas de cada Range en la lista de rangos. Si la dirección especificada es null, se infiere y, luego, se establece.

// Sets right-to-left text direction each range in the range list.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Parámetros

NombreTipoDescripción
directionTextDirectionEs la dirección de texto deseada. Si es null, la dirección se infiere antes de la configuración.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotation(degrees)

Establece la configuración de rotación del texto para las celdas de cada Range en la lista de rangos. La entrada corresponde al ángulo entre la orientación de texto estándar y la orientación deseada. Una entrada de cero indica que el texto está configurado en la orientación estándar.

Para la dirección del texto de izquierda a derecha, los ángulos positivos se encuentran en el sentido contrario a las manecillas del reloj, mientras que, para la dirección de derecha a izquierda, se encuentran en el sentido de las manecillas del reloj.

// Sets the cells in the ranges A1:A10 and C1:C10 to have text rotated up 45
// degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextRotation(45);

Parámetros

NombreTipoDescripción
degreesIntegerÁngulo deseado entre la orientación estándar y la orientación deseada. Para el texto de izquierda a derecha, los ángulos positivos se encuentran en el sentido contrario a las agujas del reloj.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValue(value)

Establece el valor para cada Range en la lista de rangos. El valor puede ser numérico, de cadena, booleano o de fecha. Si comienza con "=", se interpreta como una fórmula.

const sheet = SpreadsheetApp.getActiveSheet();
// Set value of 100 to each range in the range list.
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setValue(100);

Parámetros

NombreTipoDescripción
valueObjectEs el valor del rango.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVerticalAlignment(alignment)

Establece la alineación vertical para cada Range en la lista de rangos. Las opciones de alineación son 'top', 'middle' o 'bottom'.

// Sets the vertical alignment to middle for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalAlignment('middle');

Parámetros

NombreTipoDescripción
alignmentStringLa alineación, ya sea 'top', 'middle' o 'bottom'; un valor null restablece la alineación.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVerticalText(isVertical)

Establece si se debe apilar el texto de las celdas para cada Range de la lista de rangos. Si el texto se apila verticalmente, se ignora el parámetro de configuración de rotación del texto en grados.

// Sets all cell's in ranges D4 and B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalText(true);

Parámetros

NombreTipoDescripción
isVerticalBooleanIndica si se apilará el texto o no.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrap(isWrapEnabled)

Establece el ajuste de texto para cada Range de la lista de rangos. Las celdas con ajuste habilitado cambian de tamaño para mostrar todo su contenido. Las celdas con el ajuste desactivado muestran la mayor cantidad posible de contenido sin cambiar de tamaño ni ocupar varias líneas.

// Enable text wrap for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrap(true);

Parámetros

NombreTipoDescripción
isWrapEnabledBooleanIndica si se debe ajustar el texto o no.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrapStrategy(strategy)

Establece la estrategia de ajuste de texto para cada Range de la lista de rangos.

// Sets the list of ranges to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Parámetros

NombreTipoDescripción
strategyWrapStrategyEs la estrategia de ajuste deseada.

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

trimWhitespace()

Quita los espacios en blanco (como espacios, tabulaciones o líneas nuevas) de cada celda de esta lista de rangos. Quita todos los espacios en blanco del principio y el final del texto de cada celda, y reduce cualquier subsecuencia de caracteres de espacio en blanco restantes a un solo espacio.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

const rangeList = sheet.getRangeList(['A1', 'A2', 'A3', 'A4']);
rangeList.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

Consulta también


uncheck()

Cambia el estado de las casillas de verificación del rango a "sin marcar". Ignora las celdas del rango que actualmente no contienen el valor marcado o sin marcar configurado.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'unchecked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.uncheck();

Volver

RangeList: Es esta lista de rangos, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets