Class RangeList

RangeList

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 muestraDescripción breve
activate()RangeListSelecciona la lista de Range instancias.
breakApart()RangeListVuelve a dividir todas las celdas combinadas de forma horizontal o vertical dentro de la lista de rangos en celdas individuales.
check()RangeListCambia el estado de las casillas del rango a "marcado".
clear()RangeListBorra el rango de contenidos, formatos y reglas de validación de datos para cada Range de la lista de rangos.
clear(options)RangeListBorra el rango de contenidos, el formato, las reglas de validación de datos y los comentarios, como se especifica con las opciones determinadas.
clearContent()RangeListBorra el contenido de cada Range en la lista de rangos y deja intacto el formato.
clearDataValidations()RangeListBorra las reglas de validación de datos para cada Range de la lista de rangos.
clearFormat()RangeListBorra el formato de texto para cada Range en la lista de rangos.
clearNote()RangeListBorra la nota para cada Range en la lista de rangos.
getRanges()Range[]Muestra 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 marcada y false para desmarcada.
insertCheckboxes(checkedValue)RangeListInserta casillas de verificación en cada celda del rango, configuradas con un valor personalizado para el marcado y una cadena vacía para la desmarcada.
insertCheckboxes(checkedValue, uncheckedValue)RangeListInserta casillas de verificación en cada celda del rango, configuradas con valores personalizados para los estados marcados y desmarcados.
removeCheckboxes()RangeListQuita todas las casillas del rango.
setBackground(color)RangeListEstablece el color de fondo de 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 del borde para cada Range de la lista de rangos.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeListEstablece la propiedad del borde con color o estilo para cada Range de la lista de rangos.
setFontColor(color)RangeListEstablece el color de fuente para cada Range de la lista de rangos.
setFontFamily(fontFamily)RangeListEstablece la familia de fuentes para cada Range de la lista de rangos.
setFontLine(fontLine)RangeListEstablece el estilo de línea de 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)RangeListConfigura el grosor de la fuente para cada Range en la lista de rangos.
setFormula(formula)RangeListActualiza la fórmula para cada Range en la lista de rangos.
setFormulaR1C1(formula)RangeListActualiza la fórmula para cada Range en la lista de rangos.
setHorizontalAlignment(alignment)RangeListEstablece la alineación horizontal para cada Range de la lista de rangos.
setNote(note)RangeListEstablece el texto de la nota para cada Range de la lista de rangos.
setNumberFormat(numberFormat)RangeListEstablece el formato de número o fecha para cada Range de la lista de rangos.
setShowHyperlink(showHyperlink)RangeListDetermina si cada Range de la lista de rangos debe mostrar hipervínculos o no.
setTextDirection(direction)RangeListEstablece la dirección del texto de las celdas en cada Range de la lista de rangos.
setTextRotation(degrees)RangeListEstablece la configuración de rotación de texto para las celdas en cada Range de la lista de rangos.
setValue(value)RangeListEstablece el valor de cada Range en la lista de rangos.
setVerticalAlignment(alignment)RangeListEstablece la alineación vertical para cada Range de la lista de rangos.
setVerticalText(isVertical)RangeListEstablece si se debe apilar o no el texto de las celdas de cada Range en la lista de rangos.
setWrap(isWrapEnabled)RangeListConfigura 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()RangeListCorta los espacios en blanco (como espacios, tabulaciones o nuevas líneas) de todas las celdas de esta lista de rangos.
uncheck()RangeListCambia el estado de las casillas del rango a "Desmarcado".

Documentación detallada

activate()

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

Nota: Esto proporciona una manera de seleccionar múltiples rangos.

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

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

Devolvedor

RangeList: Es la lista de rangos activos para el encadenamiento.

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 de forma horizontal o vertical dentro de la lista de rangos en celdas individuales.

Llamar a esta función en una lista de rangos es equivalente a seleccionar un conjunto de rangos y seleccionar el elemento de menú Formato > Combinar > Separar de Hojas de cálculo.

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 configurado que está marcado o desmarcado.

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 contenidos, formatos y reglas de validación de datos para cada Range de la lista de rangos.

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 contenidos, el formato, las reglas de validación de datos y los comentarios, como se especifica con las opciones determinadas. 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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear({contentsOnly: true});

Parámetros

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

Parámetros avanzados

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 en la lista de rangos y deja intacto el formato.

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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.

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 para cada Range en la lista de rangos.

Esta acción borrará el formato de texto de cada rango, pero no restablecerá ninguna regla de formato numérico.

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 para cada Range en la lista de rangos.

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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

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

Devolvedor

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 marcada y false para desmarcada. Establece el valor de todas las celdas en el rango en false.

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 el marcado y una cadena vacía para la desmarcada. Fija el valor de cada celda en el rango a la cadena vacía.

var 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
checkedValueObjectEl valor marcado para la validación de datos en la casilla de verificación.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 marcados y desmarcados. Establece el valor de cada celda en el rango en el valor personalizado desmarcado.

var 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
checkedValueObjectEl valor marcado para la validación de datos en la casilla de verificación.
uncheckedValueObjectEl valor sin marcar de la casilla de verificación de validación de datos.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 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 no marcado.

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

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

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

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de cada Range en la lista de rangos. El color se representa en la notación CSS, por ejemplo, '#ffffff' o 'white'.

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

Parámetros

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 para una llamada a setBackground(color).

var sheet = SpreadsheetApp.getActiveSheet();
var 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
redIntegerEs el valor rojo en la notación RGB.
greenIntegerEl valor verde en la notación RGB.
blueIntegerEs el valor azul en la notación RGB.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 del borde para cada Range de la lista de rangos. Los valores válidos son true (activado), false (apagado) y null (sin cambios).

var sheet = SpreadsheetApp.getActiveSheet();
var 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 el borde, false para ninguno y null para sin cambios.
leftBooleantrue para el borde, false para ninguno y null para sin cambios.
bottomBooleantrue para el borde, false para ninguno y null para sin cambios.
rightBooleantrue para el borde, false para ninguno y null para sin cambios.
verticalBooleantrue para bordes verticales internos, false para ninguno y null para ningún cambio.
horizontalBooleantrue para los bordes horizontales internos, false para ninguno y null para sin cambio.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 del borde con color o estilo para cada Range de la lista de rangos. Los valores válidos son true (activado), false (desactivado) y null (sin cambios). El color se representa en la notación CSS (por ejemplo, '#ffffff' o 'white').

var sheet = SpreadsheetApp.getActiveSheet();
var 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 el borde, false para ninguno y null para sin cambios.
leftBooleantrue para el borde, false para ninguno y null para sin cambios.
bottomBooleantrue para el borde, false para ninguno y null para sin cambios.
rightBooleantrue para el borde, false para ninguno y null para sin cambios.
verticalBooleantrue para bordes verticales internos, false para ninguno y null para ningún cambio.
horizontalBooleantrue para los bordes horizontales internos, false para ninguno y null para sin cambio.
colorStringEl color del borde en la notación CSS, como '#ffffff' o 'white', y null para el color predeterminado (negro).
styleBorderStyleEl estilo de los bordes, null para el estilo predeterminado (sólido).

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de la lista de rangos. El color se representa en la notación CSS, por ejemplo, '#ffffff' o 'white'.

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

Parámetros

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de la lista de rangos. La familia de fuentes se describe con un identificador de cadena, como Arial o Roboto.

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

Parámetros

NombreTipoDescripción
fontFamilyStringEs la familia de fuentes que se establecerá. Con un valor null, se restablecerá la familia de fuentes.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 fuente para cada Range de la lista de rangos. Las opciones de diseño de línea son 'underline', 'line-through' o 'none'.

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

Parámetros

NombreTipoDescripción
fontLineStringEl estilo de línea de fuente, ya sea 'underline', 'line-through' o 'none'; un valor null restablece el estilo de línea de fuente.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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.

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

Parámetros

NombreTipoDescripción
sizeIntegerUn tamaño de punto de la fuente.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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

var sheet = SpreadsheetApp.getActiveSheet();
var 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 la fuente.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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)

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

var sheet = SpreadsheetApp.getActiveSheet();
var 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 null restablece el grosor de la fuente.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 en la lista de rangos. La fórmula dada debe estar en notación A1.

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

Parámetros

NombreTipoDescripción
formulaStringUna cadena que representa la fórmula que se establecerá.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 en la lista de rangos. La fórmula dada debe estar en notación R1C1.

var sheet = SpreadsheetApp.getActiveSheet();
var 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
formulaStringUna fórmula de cadena.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de la lista de rangos. Las opciones de alineación son 'left', 'center' o 'right'.

var sheet = SpreadsheetApp.getActiveSheet();
var 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 la restablece.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de la lista de rangos.

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

Parámetros

NombreTipoDescripción
noteStringEl texto de la nota que se establecerá; un valor de null quita la nota.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de la lista de rangos.

Los patrones de formato aceptados se describen en la guía de formato de fecha y número de la API de Hojas de cálculo.

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

Parámetros

NombreTipoDescripción
numberFormatStringUna string de formato numérico.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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

Determina si cada Range de la lista de rangos debe mostrar hipervínculos o no.

var sheet = SpreadsheetApp.getActiveSheet();
var 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 o no.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de las celdas en cada Range de la lista de rangos. Si una dirección especificada es null, se infiere y, luego, se establece.

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

Parámetros

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de texto para las celdas en cada Range de 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 se estableció en la orientación estándar.

Para la dirección de texto de izquierda a derecha, los ángulos positivos se encuentran en el sentido contrario al de las manecillas del reloj, mientras que 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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextRotation(45);

Parámetros

NombreTipoDescripción
degreesIntegerEl á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 sentido antihorario.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de cada Range en la lista de rangos. El valor puede ser numérico, string, booleano o fecha. Si comienza con “=”, se interpreta como una fórmula.

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

Parámetros

NombreTipoDescripción
valueObjectEs el valor del rango.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 de 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.
var sheet = SpreadsheetApp.getActiveSheet();
var 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 la restablece.

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 o no el texto de las celdas de cada Range en la lista de rangos. Si el texto se apila verticalmente, se ignora la configuración de rotación de los grados de texto.

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

Parámetros

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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)

Configura el ajuste de texto para cada Range de la lista de rangos. Se puede cambiar el tamaño de las celdas con la unión habilitada para mostrar todo su contenido. Las celdas con ajuste inhabilitada se muestran tanto como sea posible en la celda sin cambiar el tamaño ni ejecutar varias líneas.

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

Parámetros

NombreTipoDescripción
isWrapEnabledBooleanAjustar texto o no

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Parámetros

NombreTipoDescripción
strategyWrapStrategyLa estrategia de ajuste deseada

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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

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

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

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

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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 configurado que está marcado o desmarcado.

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

Devolvedor

RangeList: Esta lista de rangos para el encadenamiento.

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