Class Range

Rango

Accede a los rangos de las hojas de cálculo y modifícalos. Un rango puede ser una sola celda en una hoja o un grupo de celdas adyacentes en una hoja.

Métodos

MétodoTipo de datos que se muestraDescripción breve
activate()RangeEstablece el rango especificado como active range, con la celda superior izquierda en el rango como current cell.
activateAsCurrentCell()RangeEstablece la celda especificada como current cell.
addDeveloperMetadata(key)RangeAgrega metadatos del desarrollador con la clave especificada al rango.
addDeveloperMetadata(key, visibility)RangeAgrega metadatos del desarrollador con la clave y la visibilidad especificadas al rango.
addDeveloperMetadata(key, value)RangeAgrega metadatos del desarrollador con la clave y el valor especificados al rango.
addDeveloperMetadata(key, value, visibility)RangeAgrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados al rango.
applyColumnBanding()BandingAplica un tema de bandas de columnas predeterminado al rango.
applyColumnBanding(bandingTheme)BandingAplica un tema de bandas de columnas específico al rango.
applyColumnBanding(bandingTheme, showHeader, showFooter)BandingAplica un tema de bandas de columnas al rango con la configuración especificada de encabezado y pie de página.
applyRowBanding()BandingAplica un tema de bandas de filas predeterminado al rango.
applyRowBanding(bandingTheme)BandingAplica un tema de bandas de filas específico al rango.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingAplica un tema de bandas de filas determinado al rango con la configuración especificada de encabezado y pie de página.
autoFill(destination, series)voidCompleta la destinationRange con datos basados en los datos de este rango.
autoFillToNeighbor(series)voidCalcula un rango para rellenar con datos nuevos según las celdas vecinas y, automáticamente, rellena ese rango con valores nuevos en función de los datos contenidos en este rango.
breakApart()RangeVuelve a dividir las celdas de varias columnas del rango en celdas individuales.
canEdit()BooleanDetermina si el usuario tiene permiso para editar todas las celdas del rango.
check()RangeCambia el estado de las casillas del rango a "marcado".
clear()RangeBorra el rango de contenidos y formatos.
clear(options)RangeBorra el rango de contenidos, el formato, las reglas de validación de datos o los comentarios, como se especifica con las opciones avanzadas que se proporcionan.
clearContent()RangeBorra el contenido del rango y no modifica el formato.
clearDataValidations()RangeBorra las reglas de validación de datos del rango.
clearFormat()RangeBorra el formato de este rango.
clearNote()RangeBorra la nota en la celda o en las celdas indicadas.
collapseGroups()RangeContrae todos los grupos que están contenidos en su totalidad dentro del rango.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidCopia el formato del rango en la ubicación determinada.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidCopia el formato del rango en la ubicación determinada.
copyTo(destination)voidCopia los datos de un rango de celdas a otro rango de celdas.
copyTo(destination, copyPasteType, transposed)voidCopia los datos de un rango de celdas a otro rango de celdas.
copyTo(destination, options)voidCopia los datos de un rango de celdas a otro rango de celdas.
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)voidCopia el contenido del rango en la ubicación determinada.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidCopia el contenido del rango en la ubicación determinada.
createDataSourcePivotTable(dataSource)DataSourcePivotTableCrea una tabla dinámica de fuente de datos vacía a partir de la fuente de datos, anclada en la primera celda de este rango.
createDataSourceTable(dataSource)DataSourceTableCrea una tabla de fuente de datos vacía a partir de la fuente de datos, anclada en la primera celda de este rango.
createDeveloperMetadataFinder()DeveloperMetadataFinderMuestra una DeveloperMetadataFinderApi para encontrar metadatos del desarrollador dentro del alcance de este rango.
createFilter()FilterCrea un filtro y lo aplica al rango especificado en la hoja.
createPivotTable(sourceData)PivotTableCrea una tabla dinámica vacía a partir del sourceData especificado anclado en la primera celda de este rango.
createTextFinder(findText)TextFinderCrea un buscador de texto para el rango, que puede buscar y reemplazar texto en este rango.
deleteCells(shiftDimension)voidBorra este rango de celdas.
expandGroups()RangeExpande los grupos contraídos cuyo rango o botón de activación se cruza con este rango.
getA1Notation()StringMuestra una descripción de cadena del rango, en notación A1.
getBackground()StringMuestra el color de fondo de la celda superior izquierda del rango (por ejemplo, '#ffffff').
getBackgroundObject()ColorMuestra el color de fondo de la celda superior izquierda del rango.
getBackgroundObjects()Color[][]Muestra los colores de fondo de las celdas en el rango.
getBackgrounds()String[][]Muestra los colores de fondo de las celdas en el rango (por ejemplo, '#ffffff').
getBandings()Banding[]Muestra todas las bandas que se aplican a cualquier celda en este rango.
getCell(row, column)RangeMuestra una celda determinada dentro de un rango.
getColumn()IntegerMuestra la posición inicial de la columna para este rango.
getDataRegion()RangeMuestra una copia del rango expandido en los cuatro Direction cardinales para abarcar todas las celdas adyacentes con datos.
getDataRegion(dimension)RangeMuestra una copia del rango expandido Direction.UP y Direction.DOWN si la dimensión especificada es Dimension.ROWS, o bien Direction.NEXT y Direction.PREVIOUS si la dimensión es Dimension.COLUMNS.
getDataSourceFormula()DataSourceFormulaMuestra DataSourceFormula para la primera celda del rango o null si la celda no contiene una fórmula de fuente de datos.
getDataSourceFormulas()DataSourceFormula[]Muestra los DataSourceFormula de las celdas en el rango.
getDataSourcePivotTables()DataSourcePivotTable[]Obtiene todas las tablas dinámicas de la fuente de datos que se cruzan con el rango.
getDataSourceTables()DataSourceTable[]Obtiene todas las tablas de fuente de datos que se cruzan con el rango.
getDataSourceUrl()StringMuestra una URL para los datos en este rango, que se puede usar para crear gráficos y consultas.
getDataTable()DataTableMuestra los datos dentro de este objeto como una DataTable.
getDataTable(firstRowIsHeader)DataTableMuestra los datos dentro de este rango como una tabla de datos.
getDataValidation()DataValidationMuestra la regla de validación de datos para la celda superior izquierda del rango.
getDataValidations()DataValidation[][]Muestra las reglas de validación de datos para todas las celdas del rango.
getDeveloperMetadata()DeveloperMetadata[]Obtiene los metadatos del desarrollador asociados con este rango.
getDisplayValue()StringMuestra el valor de la celda superior izquierda del rango.
getDisplayValues()String[][]Muestra la cuadrícula rectangular de valores para este rango.
getFilter()FilterMuestra el filtro en la hoja a la que pertenece este rango o null si no hay ningún filtro en la hoja.
getFontColorObject()ColorMuestra el color de fuente de la celda en la esquina superior izquierda del rango.
getFontColorObjects()Color[][]Muestra los colores de fuente de las celdas en el rango.
getFontFamilies()String[][]Muestra las familias de fuentes de las celdas en el rango.
getFontFamily()StringMuestra la familia de fuentes de la celda en la esquina superior izquierda del rango.
getFontLine()StringObtiene el estilo de línea de la celda en la esquina superior izquierda del rango ('underline', 'line-through' o 'none').
getFontLines()String[][]Obtiene el estilo de línea de las celdas en el rango ('underline', 'line-through' o 'none').
getFontSize()IntegerMuestra el tamaño de fuente en tamaño de punto de la celda en la esquina superior izquierda del rango.
getFontSizes()Integer[][]Muestra los tamaños de fuente de las celdas en el rango.
getFontStyle()StringMuestra el estilo de fuente ('italic' o 'normal') de la celda en la esquina superior izquierda del rango.
getFontStyles()String[][]Muestra los estilos de fuente de las celdas en el rango.
getFontWeight()StringMuestra el grosor de la fuente (normal/negrita) de la celda en la esquina superior izquierda del rango.
getFontWeights()String[][]Muestra los grosores de las fuentes de las celdas en el rango.
getFormula()StringMuestra la fórmula (notación A1) para la celda superior izquierda del rango o una string vacía si la celda está vacía o no contiene una fórmula.
getFormulaR1C1()StringMuestra la fórmula (notación R1C1) para una celda determinada o null si no hay ninguna.
getFormulas()String[][]Muestra las fórmulas (notación A1) para las celdas en el rango.
getFormulasR1C1()String[][]Muestra las fórmulas (notación R1C1) para las celdas en el rango.
getGridId()IntegerMuestra el ID de la cuadrícula de la hoja superior del rango.
getHeight()IntegerMuestra la altura del rango.
getHorizontalAlignment()StringMuestra la alineación horizontal del texto (izquierda/centro/derecha) de la celda en la esquina superior izquierda del rango.
getHorizontalAlignments()String[][]Muestra las alineaciones horizontales de las celdas en el rango.
getLastColumn()IntegerMuestra la posición de la columna final.
getLastRow()IntegerMuestra la posición de la fila final.
getMergedRanges()Range[]Muestra un array de objetos Range que representan celdas combinadas que están completamente dentro del rango actual o contienen al menos una celda en el rango actual.
getNextDataCell(direction)RangeComenzando en la celda de la primera columna y fila del rango, muestra la siguiente celda en la dirección determinada, que es el borde de un rango contiguo de celdas con datos o la celda en el borde de la hoja de cálculo en esa dirección.
getNote()StringMuestra la nota asociada con el rango especificado.
getNotes()String[][]Muestra las notas asociadas con las celdas en el rango.
getNumColumns()IntegerMuestra el número de columnas en este rango.
getNumRows()IntegerMuestra la cantidad de filas en este rango.
getNumberFormat()StringObtén el formato de fecha o número de la celda superior izquierda del rango especificado.
getNumberFormats()String[][]Muestra los formatos de número o fecha para las celdas en el rango.
getRichTextValue()RichTextValueMuestra el valor de texto enriquecido de la celda superior izquierda del rango o null si el valor de la celda no es texto.
getRichTextValues()RichTextValue[][]Muestra los valores de texto enriquecido para las celdas en el rango.
getRow()IntegerMuestra la posición de fila de este rango.
getRowIndex()IntegerMuestra la posición de fila de este rango.
getSheet()SheetMuestra la hoja a la que pertenece este rango.
getTextDirection()TextDirectionMuestra la dirección de texto de la celda superior izquierda del rango.
getTextDirections()TextDirection[][]Muestra las direcciones del texto para las celdas en el rango.
getTextRotation()TextRotationMuestra la configuración de rotación de texto para la celda superior izquierda del rango.
getTextRotations()TextRotation[][]Muestra la configuración de rotación de texto para las celdas en el rango.
getTextStyle()TextStyleMuestra el estilo de texto de la celda superior izquierda del rango.
getTextStyles()TextStyle[][]Muestra los estilos de texto de las celdas en el rango.
getValue()ObjectMuestra el valor de la celda superior izquierda en el rango.
getValues()Object[][]Muestra la cuadrícula rectangular de valores para este rango.
getVerticalAlignment()StringMuestra la alineación vertical (parte superior/central/inferior) de la celda en la esquina superior izquierda del rango.
getVerticalAlignments()String[][]Muestra las alineaciones verticales de las celdas en el rango.
getWidth()IntegerMuestra el ancho del rango en columnas.
getWrap()BooleanMuestra si se ajusta el texto de la celda.
getWrapStrategies()WrapStrategy[][]Muestra las estrategias de ajuste de texto para las celdas en el rango.
getWrapStrategy()WrapStrategyMuestra la estrategia de ajuste de texto para la celda superior izquierda del rango.
getWraps()Boolean[][]Muestra si se ajusta el texto de las celdas.
insertCells(shiftDimension)RangeInserta celdas vacías en este rango.
insertCheckboxes()RangeInserta casillas de verificación en cada celda del rango, configuradas con true para marcada y false para desmarcada.
insertCheckboxes(checkedValue)RangeInserta 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)RangeInserta casillas de verificación en cada celda del rango, configuradas con valores personalizados para los estados marcados y desmarcados.
isBlank()BooleanMuestra true si el rango está completamente en blanco.
isChecked()BooleanMuestra si todas las celdas del rango tienen el estado de casilla de verificación como "marcado".
isEndColumnBounded()BooleanDetermina si el final del rango está vinculado a una columna en particular.
isEndRowBounded()BooleanDetermina si el final del rango está vinculado a una fila en particular.
isPartOfMerge()BooleanMuestra true si las celdas del rango actual se superponen con alguna celda combinada.
isStartColumnBounded()BooleanDetermina si el inicio del rango está vinculado a una columna en particular.
isStartRowBounded()BooleanDetermina si el inicio del rango está vinculado a una fila en particular.
merge()RangeCombina las celdas del rango en un solo bloque.
mergeAcross()RangeCombina las celdas del rango en las columnas del rango.
mergeVertically()RangeCombina las celdas del rango.
moveTo(target)voidCorta y pega (con formato y valores) de este rango en el rango objetivo.
offset(rowOffset, columnOffset)RangeMuestra un rango nuevo que se desplaza desde este rango por la cantidad determinada de filas y columnas (que pueden ser negativas).
offset(rowOffset, columnOffset, numRows)RangeMuestra un rango nuevo relativo al rango actual, cuyo punto superior izquierdo se desplaza del rango actual por las filas y columnas determinadas, y con la altura determinada en las celdas.
offset(rowOffset, columnOffset, numRows, numColumns)RangeMuestra un rango nuevo relativo al rango actual, cuyo punto superior izquierdo se desplaza del rango actual por las filas y columnas determinadas, y con la altura y el ancho dados en las celdas.
protect()ProtectionCrea un objeto que puede evitar que editen el rango, excepto por los usuarios que tengan permiso.
randomize()RangeAleatoriza el orden de las filas en el rango especificado.
removeCheckboxes()RangeQuita todas las casillas del rango.
removeDuplicates()RangeQuita las filas dentro de este rango que contienen valores que son duplicados de los valores en cualquier fila anterior.
removeDuplicates(columnsToCompare)RangeQuita las filas dentro de este rango que contienen valores en las columnas especificadas que son duplicados de valores de cualquier fila anterior.
setBackground(color)RangeEstablece el color de fondo de todas las celdas en el rango en la notación CSS (como '#ffffff' o 'white').
setBackgroundObject(color)RangeEstablece el color de fondo de todas las celdas del rango.
setBackgroundObjects(color)RangeEstablece una cuadrícula rectangular de colores de fondo (debe coincidir con las dimensiones de este rango).
setBackgroundRGB(red, green, blue)RangeEstablece el fondo en el color determinado mediante valores RGB (números enteros entre 0 y 255 inclusive).
setBackgrounds(color)RangeEstablece una cuadrícula rectangular de colores de fondo (debe coincidir con las dimensiones de este rango).
setBorder(top, left, bottom, right, vertical, horizontal)RangeConfigura la propiedad del borde.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeEstablece la propiedad del borde con color o estilo.
setDataValidation(rule)RangeEstablece una regla de validación de datos para todas las celdas del rango.
setDataValidations(rules)RangeEstablece las reglas de validación de datos para todas las celdas del rango.
setFontColor(color)RangeEstablece el color de la fuente en la notación CSS (como '#ffffff' o 'white').
setFontColorObject(color)RangeEstablece el color de la fuente del rango especificado.
setFontColorObjects(colors)RangeEstablece una cuadrícula rectangular de colores de fuente (debe coincidir con las dimensiones de este rango).
setFontColors(colors)RangeEstablece una cuadrícula rectangular de colores de fuente (debe coincidir con las dimensiones de este rango).
setFontFamilies(fontFamilies)RangeEstablece una cuadrícula rectangular de familias de fuentes (debe coincidir con las dimensiones de este rango).
setFontFamily(fontFamily)RangeEstablece la familia de fuentes, como " Arial" o "Helvetica".
setFontLine(fontLine)RangeEstablece el estilo de línea de fuente del rango determinado ('underline', 'line-through' o 'none').
setFontLines(fontLines)RangeEstablece una cuadrícula rectangular de estilos de línea (debe coincidir con las dimensiones de este rango).
setFontSize(size)RangeEstablece el tamaño de la fuente; el tamaño es el tamaño en puntos que se usará.
setFontSizes(sizes)RangeEstablece una cuadrícula rectangular de tamaños de fuente (debe coincidir con las dimensiones de este rango).
setFontStyle(fontStyle)RangeDefine el estilo de fuente para el rango especificado ('italic' o 'normal').
setFontStyles(fontStyles)RangeEstablece una cuadrícula rectangular de estilos de fuente (debe coincidir con las dimensiones de este rango).
setFontWeight(fontWeight)RangeDefine el grosor de la fuente para el rango especificado (normal/negrita).
setFontWeights(fontWeights)RangeEstablece una cuadrícula rectangular de tamaños de fuente (debe coincidir con las dimensiones de este rango).
setFormula(formula)RangeActualiza la fórmula de este rango.
setFormulaR1C1(formula)RangeActualiza la fórmula de este rango.
setFormulas(formulas)RangeEstablece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango).
setFormulasR1C1(formulas)RangeEstablece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango).
setHorizontalAlignment(alignment)RangeEstablece la alineación horizontal (de izquierda a derecha) para el rango dado (izquierda/centro/derecha).
setHorizontalAlignments(alignments)RangeEstablece una cuadrícula rectangular de alineaciones horizontales.
setNote(note)RangeEstablece la nota en el valor especificado.
setNotes(notes)RangeEstablece una cuadrícula rectangular de notas (debe coincidir con las dimensiones de este rango).
setNumberFormat(numberFormat)RangeEstablece el formato de número o fecha en la string de formato determinada.
setNumberFormats(numberFormats)RangeEstablece una cuadrícula rectangular de formatos de número o fecha (debe coincidir con las dimensiones de este período).
setRichTextValue(value)RangeEstablece el valor de texto enriquecido para las celdas en el rango.
setRichTextValues(values)RangeEstablece una cuadrícula rectangular de valores de Texto enriquecido.
setShowHyperlink(showHyperlink)RangeDefine si el rango debe mostrar hipervínculos o no.
setTextDirection(direction)RangeEstablece la dirección del texto para las celdas en el rango.
setTextDirections(directions)RangeEstablece una cuadrícula rectangular de direcciones de texto.
setTextRotation(degrees)RangeEstablece la configuración de rotación de texto para las celdas en el rango.
setTextRotation(rotation)RangeEstablece la configuración de rotación de texto para las celdas en el rango.
setTextRotations(rotations)RangeEstablece una cuadrícula rectangular de rotaciones de texto.
setTextStyle(style)RangeEstablece el estilo de texto de las celdas en el rango.
setTextStyles(styles)RangeEstablece una cuadrícula rectangular de estilos de texto.
setValue(value)RangeEstablece el valor del rango.
setValues(values)RangeEstablece una cuadrícula rectangular de valores (debe coincidir con las dimensiones de este rango).
setVerticalAlignment(alignment)RangeEstablece la alineación vertical (de arriba abajo) para el rango dado (parte superior/central/inferior).
setVerticalAlignments(alignments)RangeEstablece una cuadrícula rectangular de alineaciones verticales (debe coincidir con las dimensiones de este rango).
setVerticalText(isVertical)RangeEstablece si se debe apilar o no el texto de las celdas del rango.
setWrap(isWrapEnabled)RangeEstablece la unión de celdas del rango determinado.
setWrapStrategies(strategies)RangeEstablece una cuadrícula rectangular de estrategias de unión.
setWrapStrategy(strategy)RangeEstablece la estrategia de ajuste de texto para las celdas en el rango.
setWraps(isWrapEnabled)RangeEstablece una cuadrícula rectangular de políticas de ajuste de texto (debe coincidir con las dimensiones de este rango).
shiftColumnGroupDepth(delta)RangeCambia la profundidad de agrupación de columnas del rango según la cantidad especificada.
shiftRowGroupDepth(delta)RangeCambia la profundidad de agrupación de filas del rango según la cantidad especificada.
sort(sortSpecObj)RangeOrdena las celdas en el rango dado, por columna y por orden especificado.
splitTextToColumns()voidDivide una columna de texto en varias columnas en función de un delimitador detectado automáticamente.
splitTextToColumns(delimiter)voidDivide una columna de texto en varias columnas con la string especificada como delimitador personalizado.
splitTextToColumns(delimiter)voidDivide una columna de texto en varias columnas según el delimitador especificado.
trimWhitespace()RangeCorta los espacios en blanco (como espacios, tabulaciones o nuevas líneas) de todas las celdas del rango.
uncheck()RangeCambia el estado de las casillas del rango a "Desmarcado".

Documentación detallada

activate()

Establece el rango especificado como active range, con la celda superior izquierda en el rango como current cell.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:D10');
range.activate();

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D10
var activeRange = selection.getActiveRange();

Devolvedor

Range: Este rango es para el encadenamiento.


activateAsCurrentCell()

Establece la celda especificada como current cell.

Si la celda especificada está presente en un rango existente, ese rango se convierte en el rango activo con la celda como la celda actual.

Si la celda especificada no está presente en ningún rango existente, la selección existente se quita y la celda se convierte en la celda actual y en el rango activo.

Nota: El Range especificado debe constar de una celda; de lo contrario, arrojará una excepción.

// Gets the first sheet of the spreadsheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Gets the cell B5 and sets it as the active cell.
var range = sheet.getRange('B5');
var currentCell = range.activateAsCurrentCell();

// Logs the activated cell.
console.log(currentCell.getA1Notation());

Devolvedor

Range: Este rango es 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

addDeveloperMetadata(key)

Agrega metadatos del desarrollador con la clave especificada al rango.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' to the developer metadata for row 2.
range.addDeveloperMetadata('NAME');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

Parámetros

NombreTipoDescripción
keyStringLa clave de los nuevos metadatos del desarrollador.

Devolvedor

Range: Este rango es 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

addDeveloperMetadata(key, visibility)

Agrega metadatos del desarrollador con la clave y la visibilidad especificadas al rango.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT'
// for row 2 on Sheet1.
range.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

Parámetros

NombreTipoDescripción
keyStringLa clave de los nuevos metadatos del desarrollador.
visibilityDeveloperMetadataVisibilityLa visibilidad de los nuevos metadatos del desarrollador

Devolvedor

Range: Este rango es 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

addDeveloperMetadata(key, value)

Agrega metadatos del desarrollador con la clave y el valor especificados al rango.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 of Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

Parámetros

NombreTipoDescripción
keyStringLa clave de los nuevos metadatos del desarrollador.
valueStringEl valor de los nuevos metadatos del desarrollador.

Devolvedor

Range: Este rango es 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

addDeveloperMetadata(key, value, visibility)

Agrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados al rango.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to PROJECT for row 2 on the sheet.
range.addDeveloperMetadata(
  'NAME',
  'GOOGLE',
  SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

Parámetros

NombreTipoDescripción
keyStringLa clave de los nuevos metadatos del desarrollador.
valueStringEl valor de los nuevos metadatos del desarrollador.
visibilityDeveloperMetadataVisibilityLa visibilidad de los nuevos metadatos del desarrollador

Devolvedor

Range: Este rango es 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

applyColumnBanding()

Aplica un tema de bandas de columnas predeterminado al rango. De forma predeterminada, las bandas tienen color de encabezado y no de pie de página.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies column banding to row 2.
const colBanding = range.applyColumnBanding();

// Gets the first banding on the sheet and logs the color of the header column.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject().asRgbColor().asHexString());

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

Devolvedor

Banding: Las nuevas bandas.

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

applyColumnBanding(bandingTheme)

Aplica un tema de bandas de columnas específico al rango. De forma predeterminada, las bandas tienen color de encabezado y no de pie de página.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies the INDIGO color banding theme to the columns in row 2.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

Parámetros

NombreTipoDescripción
bandingThemeBandingThemeUn tema de color para aplicar a las columnas del rango.

Devolvedor

Banding: Las nuevas bandas.

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

applyColumnBanding(bandingTheme, showHeader, showFooter)

Aplica un tema de bandas de columnas al rango con la configuración especificada de encabezado y pie de página.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 12-22 on the sheet.
const range = sheet.getRange('12:22');

// Applies the BLUE color banding theme to rows 12-22.
// Sets the header visibility to false and the footer visibility to true.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.BLUE, false, true);

// Gets the banding color and logs it to the console.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

// Gets the header color object and logs it to the console. Returns null because the header
// visibility is set to false.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject());

// Gets the footer color and logs it to the console.
console.log(sheet.getBandings()[0].getFooterColumnColorObject().asRgbColor().asHexString());

Parámetros

NombreTipoDescripción
bandingThemeBandingThemeUn tema de color para aplicar a las columnas del rango.
showHeaderBooleanSi es true, el color del encabezado del tema de bandas se aplica a la primera columna.
showFooterBooleanSi es true, el color del pie de página del tema de bandas se aplica a la última columna.

Devolvedor

Banding: Las nuevas bandas.

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

applyRowBanding()

Aplica un tema de bandas de filas predeterminado al rango. De forma predeterminada, las bandas tienen color de encabezado y no de pie de página.

// Opens the spreadsheet by its URL. If you created your script from within a Google Sheets
// spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies row banding to rows 1-30.
range.applyRowBanding();

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

Devolvedor

Banding: Las bandas.

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

applyRowBanding(bandingTheme)

Aplica un tema de bandas de filas específico al rango. De forma predeterminada, las bandas tienen color de encabezado y no de pie de página.

// Opens the spreadsheet by its URL. If you created your script from within a Google Sheets
// spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding theme to rows 1-30.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

Parámetros

NombreTipoDescripción
bandingThemeBandingThemeTema de color para aplicar a las filas del rango

Devolvedor

Banding: Las nuevas bandas.

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

applyRowBanding(bandingTheme, showHeader, showFooter)

Aplica un tema de bandas de filas determinado al rango con la configuración especificada de encabezado y pie de página.

// Opens the spreadsheet by its URL. If you created your script from within a Google Sheets
// spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding to rows 1-30 and
// specifies to hide the header and show the footer.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);

Parámetros

NombreTipoDescripción
bandingThemeBandingThemeTema de color para aplicar a las filas del rango
showHeaderBooleanSi es true, el color del encabezado del tema de bandas se aplica a la primera fila.
showFooterBooleanSi es true, el color del pie de página del tema de bandas se aplica a la última fila.

Devolvedor

Banding: Las nuevas bandas.

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

autoFill(destination, series)

Completa la destinationRange con datos basados en los datos de este rango. Los valores nuevos también están determinados por el tipo series especificado. El rango de destino debe contener este rango y extenderlo en una sola dirección. Por ejemplo, lo siguiente completa la A1:A20 con una serie de números en aumento según los valores actuales en A1:A4:

var sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
var sourceRange = sheet.getRange("A1:A4");
// The range to fill with values.
var destination = sheet.getRange("A1:A20");

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Parámetros

NombreTipoDescripción
destinationRangeRango que se completará automáticamente con valores El rango de destino debe contener este rango y extenderlo en una sola dirección (hacia arriba, hacia abajo, hacia la izquierda o hacia la derecha).
seriesAutoFillSeriesEl tipo de serie de Autocompletar que se debe usar para calcular valores nuevos. El efecto de esta serie difiere según el tipo y la cantidad de datos de origen.

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

autoFillToNeighbor(series)

Calcula un rango para rellenar con datos nuevos según las celdas vecinas y, automáticamente, rellena ese rango con valores nuevos en función de los datos contenidos en este rango. Estos valores nuevos también están determinados por el tipo series especificado.

El rango de destino calculado considera los datos circundantes para determinar dónde se deben insertar los valores nuevos: si hay datos inmediatamente a la izquierda o a la derecha de una columna que se autocompleta, los valores nuevos solo se extienden hasta estos datos adyacentes.

Por ejemplo, si A1:A20 se completa con una serie de números en aumento y se llama a este método en el rango B1:B4 que contiene una serie de fechas, los valores nuevos solo se insertan en B5:B20. De esta manera, estos valores nuevos se "fijan" a las celdas que contienen valores en la columna A.

var sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
var sourceRange = sheet.getRange("B1:B4");

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Parámetros

NombreTipoDescripción
seriesAutoFillSeriesEl tipo de serie de Autocompletar que se debe usar para calcular valores nuevos. El efecto de esta serie difiere según el tipo y la cantidad de datos de origen.

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 las celdas de varias columnas del rango en celdas individuales.

Llamar a esta función sobre un rango equivale a seleccionarlo y hacer clic en Formato > Combinar celdas > Separar.

// Opens the spreadsheet by its URL. If you created your script from within a Google Sheets
// spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Unmerges the range A1:C6 into individual cells.
range.breakApart();

Devolvedor

Range: Este rango es 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

canEdit()

Determina si el usuario tiene permiso para editar todas las celdas del rango. El propietario de la hoja de cálculo siempre puede editar hojas y rangos protegidos.

// Opens the spreadsheet by its URL. If you created your script from within a Google Sheets
// spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Logs whether the user has permission to edit every cell in the range.
console.log(range.canEdit());

Devolvedor

Boolean: Es true si el usuario tiene permiso para editar todas las celdas del rango; de lo contrario, false.

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 range A1:B10 to 'checked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

Devolvedor

Range: Este rango es 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 y formatos.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clear();

Devolvedor

Range: Este rango es 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 o los comentarios, como se especifica con las opciones avanzadas que se proporcionan. De forma predeterminada, se borran todos los datos.

// The code below clears range C2:G7 in the active sheet, but preserves the format,
// data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).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

Range: Este rango es 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 del rango y no modifica el formato.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clearContent();

Devolvedor

Range: Este rango es 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 del rango.

// Clear the data validation rules for cells A1:B5.
var range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

Devolvedor

Range: Este rango es 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 este rango.

Esta acción borrará el formato de texto de la celda o las celdas del rango, pero no restablecerá ninguna regla de formato de número.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clearFormat();

Devolvedor

Range: Este rango es 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 en la celda o en las celdas indicadas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clearNote();

Devolvedor

Range: Este rango es 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

collapseGroups()

Contrae todos los grupos que están contenidos en su totalidad dentro del rango. Si ningún grupo está completamente dentro del rango, se contrae el grupo expandido más profundo que esté parcialmente dentro del rango.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// All row and column groups within the range are collapsed.
range.collapseGroups();

Devolvedor

Range: Este rango es 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

copyFormatToRange(gridId, column, columnEnd, row, rowEnd)

Copia el formato del rango en la ubicación determinada. Si el destino es mayor o menor que el rango de origen, la fuente se repite o se trunca según corresponda. Ten en cuenta que este método solo copia el formato.

Para obtener una descripción detallada del parámetro gridId, consulta getGridId().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

Parámetros

NombreTipoDescripción
gridIdIntegerEl ID único de la hoja dentro de la hoja de cálculo, independientemente de su posición.
columnIntegerPrimera columna del rango objetivo.
columnEndIntegerLa columna final del rango objetivo.
rowIntegerLa fila de inicio del rango objetivo.
rowEndIntegerLa fila final del rango objetivo.

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


copyFormatToRange(sheet, column, columnEnd, row, rowEnd)

Copia el formato del rango en la ubicación determinada. Si el destino es mayor o menor que el rango de origen, la fuente se repite o se trunca según corresponda. Ten en cuenta que este método solo copia el formato.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

Parámetros

NombreTipoDescripción
sheetSheetLa hoja de destino.
columnIntegerPrimera columna del rango objetivo.
columnEndIntegerLa columna final del rango objetivo.
rowIntegerLa fila de inicio del rango objetivo.
rowEndIntegerLa fila final del rango objetivo.

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

copyTo(destination)

Copia los datos de un rango de celdas a otro rango de celdas. Se copian los valores y el formato.

// The code below copies the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

Parámetros

NombreTipoDescripción
destinationRangeUn rango de destino al cual copiar; solo es relevante la posición de la celda superior izquierda.

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

copyTo(destination, copyPasteType, transposed)

Copia los datos de un rango de celdas a otro rango de celdas.

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), SpreadsheetApp.CopyPasteType.PASTE_VALUES,
false);

Parámetros

NombreTipoDescripción
destinationRangeUn rango de destino al cual copiar; solo es relevante la posición de la celda superior izquierda.
copyPasteTypeCopyPasteTypeEs un tipo que especifica cómo se pega el contenido del rango en el destino.
transposedBooleanIndica si el rango debe pegarse en su orientación transpuesta.

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

copyTo(destination, options)

Copia los datos de un rango de celdas a otro rango de celdas. De forma predeterminada, se copian los valores y el formato, pero esto se puede anular con argumentos avanzados.

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), {contentsOnly:true});

Parámetros

NombreTipoDescripción
destinationRangeUn rango de destino al cual copiar; solo es relevante la posición de la celda superior izquierda.
optionsObjectUn objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
formatOnlyBooleandesigna que solo se debe copiar el formato
contentsOnlyBooleandesigna que solo se debe copiar el contenido

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

copyValuesToRange(gridId, column, columnEnd, row, rowEnd)

Copia el contenido del rango en la ubicación determinada. Si el destino es mayor o menor que el rango de origen, la fuente se repite o se trunca según corresponda.

Para obtener una descripción detallada del parámetro gridId, consulta getGridId().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

Parámetros

NombreTipoDescripción
gridIdIntegerEl ID único de la hoja dentro de la hoja de cálculo, independientemente de su posición.
columnIntegerPrimera columna del rango objetivo.
columnEndIntegerLa columna final del rango objetivo.
rowIntegerLa fila de inicio del rango objetivo.
rowEndIntegerLa fila final del rango objetivo.

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


copyValuesToRange(sheet, column, columnEnd, row, rowEnd)

Copia el contenido del rango en la ubicación determinada. Si el destino es mayor o menor que el rango de origen, la fuente se repite o se trunca según corresponda.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

Parámetros

NombreTipoDescripción
sheetSheetLa hoja de destino.
columnIntegerPrimera columna del rango objetivo.
columnEndIntegerLa columna final del rango objetivo.
rowIntegerLa fila de inicio del rango objetivo.
rowEndIntegerLa fila final del rango objetivo.

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

createDataSourcePivotTable(dataSource)

Crea una tabla dinámica de fuente de datos vacía a partir de la fuente de datos, anclada en la primera celda de este rango.

En este ejemplo, se muestra cómo crear y configurar una tabla dinámica de fuente de datos nueva.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue('dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM);
pivotTable.addFilter('dataColumnA',
                     SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build());

Parámetros

NombreTipoDescripción
dataSourceDataSourceLa fuente de datos a partir de la cual se creará la tabla dinámica.

Devolvedor

DataSourcePivotTable: Es la tabla dinámica de la fuente de datos recién creada.

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

createDataSourceTable(dataSource)

Crea una tabla de fuente de datos vacía a partir de la fuente de datos, anclada en la primera celda de este rango.

En este ejemplo, se muestra cómo crear y configurar una tabla de fuente de datos nueva.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var dataSourceTable = anchorCell.createDataSourceTable(dataSource);
    .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
    .addSortSpec('dataColumnA', /* ascending= *\/ true)
    .addSortSpec('dataColumnB', /* ascending= *\/ false);

Parámetros

NombreTipoDescripción
dataSourceDataSourceLa fuente de datos a partir de la cual se creará la tabla dinámica.

Devolvedor

DataSourceTable: Es la tabla de fuente de datos recién creada.

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

createDeveloperMetadataFinder()

Muestra una DeveloperMetadataFinderApi para encontrar metadatos del desarrollador dentro del alcance de este rango. Los metadatos se encuentran dentro del alcance del rango solo si están completamente dentro de ese rango. Por ejemplo, los metadatos asociados con la fila "3:3" no se encuentran dentro del alcance del rango "A1:D5", pero sí dentro del alcance del rango "1:5".

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:C6.
const range = sheet.getRange('A1:C6');

// Creates a developer metadata finder to search for metadata in the scope of this range.
const developerMetaDataFinder = range.createDeveloperMetadataFinder();

// Logs information about the developer metadata finder to the console.
const developerMetaData = developerMetaDataFinder.find()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

Devolvedor

DeveloperMetadataFinder: Es un buscador de metadatos del desarrollador para buscar metadatos en el alcance de este rango.


createFilter()

Crea un filtro y lo aplica al rango especificado en la hoja. No puedes crear más de un filtro en una hoja. Para acceder al filtro y modificarlo después de crearlo, utiliza getFilter() o Sheet.getFilter().

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}
Usa este método a fin de crear filtros para Grid hojas, el tipo de hoja predeterminado. Las hojas de cuadrícula son hojas que no están conectadas a una base de datos. Para crear otros tipos de filtros, consulta los siguientes vínculos:

Devolvedor

Filter: Es el filtro nuevo.

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

createPivotTable(sourceData)

Crea una tabla dinámica vacía a partir del sourceData especificado anclado en la primera celda de este rango.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 as a range in order to place the pivot table.
const range = sheet.getRange('A1');

// Gets the range of the source data for the pivot table.
const dataRange = sheet.getRange('E12:G20');

// Creates an empty pivot table from the specified source data.
const pivotTable = range.createPivotTable(dataRange);

// Logs the values from the pivot table's source data to the console.
console.log(pivotTable.getSourceDataRange().getValues());

Parámetros

NombreTipoDescripción
sourceDataRangeLos datos a partir de los cuales se creará la tabla dinámica.

Devolvedor

PivotTable: Es el PivotTable recién creado.

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

createTextFinder(findText)

Crea un buscador de texto para el rango, que puede buscar y reemplazar texto en este rango.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// Creates  a text finder for the range.
var textFinder = range.createTextFinder('dog');

// Returns the first occurrence of 'dog'.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = textFinder.replaceWith('cat');

Parámetros

NombreTipoDescripción
findTextStringEl texto que se va a buscar.

Devolvedor

TextFinder: Es el TextFinder del rango.


deleteCells(shiftDimension)

Borra este rango de celdas. Los datos existentes en la hoja a lo largo de la dimensión proporcionada se desplazan hacia el rango borrado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

Parámetros

NombreTipoDescripción
shiftDimensionDimensionLa dimensión a la que se desplazan los datos existentes.

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

expandGroups()

Expande los grupos contraídos cuyo rango o botón de activación se cruza con este rango. La ubicación del botón de activación del control es el índice en el que se muestra el botón de activación del control, directamente antes o después del grupo, según la configuración. Si hay más de un grupo en la misma ubicación, se expande el grupo que queda menos abajo.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// All row and column groups within the range are expanded.
range.expandGroups();

Devolvedor

Range: Este rango es 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

getA1Notation()

Muestra una descripción de cadena del rango, en notación A1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

Devolvedor

String: Es la descripción de string del rango en la notación A1.

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

getBackground()

Muestra el color de fondo de la celda superior izquierda del rango (por ejemplo, '#ffffff').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
Logger.log(cell.getBackground());

Devolvedor

String: Es el código de color del fondo.

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

getBackgroundObject()

Muestra el color de fondo de la celda superior izquierda del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

Devolvedor

Color: Indica el color de fondo de la celda superior izquierda del rango.

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

getBackgroundObjects()

Muestra los colores de fondo de las celdas en el rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgroundObjects();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

Devolvedor

Color[][]: Es un array bidimensional de colores de fondo.

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

getBackgrounds()

Muestra los colores de fondo de las celdas en el rango (por ejemplo, '#ffffff').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgrounds();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de códigos de color de los fondos.

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

getBandings()

Muestra todas las bandas que se aplican a cualquier celda en este rango.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets a range.
const range = sheet.getRange('A1:K50');

// Gets the banding info for the range.
const bandings = range.getBandings();

// Logs the second row color for each banding to the console.
for (let banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Devolvedor

Banding[]: Son todas las bandas que se aplican a las celdas de este rango.

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

getCell(row, column)

Muestra una celda determinada dentro de un rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
var cell = range.getCell(1, 1);
Logger.log(cell.getValue());

Parámetros

NombreTipoDescripción
rowIntegerFila de la celda en relación con el rango.
columnIntegerColumna de la celda en relación con el rango.

Devolvedor

Range: Es un rango que contiene una sola celda en las coordenadas especificadas.

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

getColumn()

Muestra la posición inicial de la columna para este rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// Logs "2.0"
Logger.log(range.getColumn());

Devolvedor

Integer: Es la posición de columna inicial del rango en la hoja de cálculo.

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

getDataRegion()

Muestra una copia del rango expandido en los cuatro Direction cardinales para abarcar todas las celdas adyacentes con datos. Si el rango está rodeado de celdas vacías que no incluyen las de las diagonales, se muestra el rango en sí. Esto es similar a seleccionar el rango y escribir Ctrl+A en el editor.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange("C3").getDataRegion().getA1Notation());

Devolvedor

Range: La región de datos del rango o un rango para toda la hoja de cálculo.

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

getDataRegion(dimension)

Muestra una copia del rango expandido Direction.UP y Direction.DOWN si la dimensión especificada es Dimension.ROWS, o bien Direction.NEXT y Direction.PREVIOUS si la dimensión es Dimension.COLUMNS. La expansión del rango se basa en la detección de datos junto al rango que se organiza como una tabla. El rango expandido abarca todas las celdas adyacentes con datos a lo largo de la dimensión especificada, incluidos los límites de la tabla. Si el rango original está rodeado de celdas vacías a lo largo de la dimensión especificada, se muestra el rango en sí. Este método es similar a seleccionar el rango y escribir Ctrl+Space para columnas o Shift+Space para filas en el editor.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "C2:C4"
Logger.log(sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.ROWS).getA1Notation());
// Logs "B3:D3"
Logger.log(
    sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.COLUMNS).getA1Notation());

Parámetros

NombreTipoDescripción
dimensionDimensionLa dimensión en la que se expande el rango.

Devolvedor

Range: La región de datos del rango o un rango que abarca cada columna o cada fila que abarca el rango original.

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

getDataSourceFormula()

Muestra DataSourceFormula para la primera celda del rango o null si la celda no contiene una fórmula de fuente de datos.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1 on Sheet1.
const range = sheet.getRange('A1');

// Gets the data source formula from cell A1.
const dataSourceFormula = range.getDataSourceFormula();

// Gets the formula.
const formula = dataSourceFormula.getFormula();

// Logs the formula.
console.log(formula);

Devolvedor

DataSourceFormula: Es el DataSourceFormula de la celda.

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

getDataSourceFormulas()

Muestra los DataSourceFormula de las celdas en el rango.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:B5 on Sheet1.
const range = sheet.getRange('A1:B5');

// Gets an array of the data source formulas in the range A1:B5.
const dataSourceFormulas = range.getDataSourceFormulas();

// Logs the first formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Devolvedor

DataSourceFormula[]: Es un array de objetos DataSourceFormula.

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

getDataSourcePivotTables()

Obtiene todas las tablas dinámicas de la fuente de datos que se cruzan con el rango.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Devolvedor

DataSourcePivotTable[]: Es una lista de tablas dinámicas de fuente de datos.

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

getDataSourceTables()

Obtiene todas las tablas de fuente de datos que se cruzan con el rango.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets the first data source table in the range A1:G50.
const dataSourceTable = range.getDataSourceTables()[0];

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.getStatus().getLastExecutionTime());

Devolvedor

DataSourceTable[]: Es una lista de tablas de fuente de datos.

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

getDataSourceUrl()

Muestra una URL para los datos en este rango, que se puede usar para crear gráficos y consultas.

Code.gs

function doGet() {
  var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c');
  var sheet = ss.getSheetByName('ContinentData');
  var range = sheet.getRange('A1:B8');

  var template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

piechart.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

Devolvedor

String: Es una URL para este rango como fuente de datos que se puede pasar a otras APIs, como gráficos.

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

getDataTable()

Muestra los datos dentro de este objeto como una DataTable.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:B7 on Sheet1.
const range = sheet.getRange('A1:B7');

// Gets the range A1:B7 as a data table. The values in each column must be of the same type.
const datatable = range.getDataTable();

// Uses the Charts service to build a bar chart from the data table.
// This doesn't build an embedded chart. To do that, use sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Chart Title Here')
                  .build();

Devolvedor

DataTable: Son los datos como una tabla de datos.


getDataTable(firstRowIsHeader)

Muestra los datos dentro de este rango como una tabla de datos.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:B7");

// Calling this method with "true" sets the first line to be the title of the axes
var datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
var chart = Charts.newBarChart()
    .setDataTable(datatable)
    .setOption("title", "Your Title Here")
    .build();

Parámetros

NombreTipoDescripción
firstRowIsHeaderBooleanIndica si se debe tratar la primera fila como un encabezado.

Devolvedor

DataTable: Son los datos como una tabla de datos.

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

getDataValidation()

Muestra la regla de validación de datos para la celda superior izquierda del rango. Si no se configuró la validación de datos en la celda, este método muestra null.

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

Devolvedor

DataValidation: Es la regla de validación de datos de la celda superior izquierda del rango.

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

getDataValidations()

Muestra las reglas de validación de datos para todas las celdas del rango. Si no se configuró la validación de datos en una celda determinada, este método muestra null para la posición de esa celda en el array.

// Change existing data validation rules that require a date in 2013 to require a date in 2014.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var args = rule.getCriteriaValues();

      if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN
          && args[0].getTime() == oldDates[0].getTime()
          && args[1].getTime() == oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

Devolvedor

DataValidation[][]: Es un array bidimensional de reglas de validación de datos asociadas con las celdas del rango.

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

getDeveloperMetadata()

Obtiene los metadatos del desarrollador asociados con este rango.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds metadata to row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Logs the metadata to console.
for (const metadata of range.getDeveloperMetadata()) {
  console.log(`${metadata.getKey()}: ${metadata.getValue()}`);
}

Devolvedor

DeveloperMetadata[]: Son los metadatos del desarrollador asociados con este rango.

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

getDisplayValue()

Muestra el valor de la celda superior izquierda del rango. El valor es String. El valor que se muestra tiene en cuenta el formato de fecha, hora y moneda, incluidos los formatos que se aplican automáticamente mediante la configuración regional de la hoja de cálculo. Las celdas vacías muestran una string vacía.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its value to 'Test code.'
const cell = sheet.getRange('A30');
cell.setValue('Test code');

// Gets the value and logs it to the console.
console.log(cell.getDisplayValue());

Devolvedor

String: Es el valor que se muestra en esta celda.

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

getDisplayValues()

Muestra la cuadrícula rectangular de valores para este rango.

Muestra un array bidimensional de valores mostrados, indexados por fila y, luego, por columna. Los valores son objetos String. El valor que se muestra tiene en cuenta el formato de fecha, hora y moneda, incluidos los formatos que aplica automáticamente la configuración regional de la hoja de cálculo. Las celdas vacías se representan con una cadena vacía en el array. Recuerda que, si bien un índice de rango comienza en 1, 1, el array de JavaScript se indexa desde [0][0].

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

Devolvedor

String[][]: Es un array de valores bidimensional.

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

getFilter()

Muestra el filtro en la hoja a la que pertenece este rango o null si no hay ningún filtro en la hoja.

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.getFilter();

Devolvedor

Filter: Es el filtro.

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

getFontColorObject()

Muestra el color de fuente de la celda en la esquina superior izquierda del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

Devolvedor

Color: Indica el color de fuente de la celda superior izquierda del rango.

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

getFontColorObjects()

Muestra los colores de fuente de las celdas en el rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontColorObjects();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

Devolvedor

Color[][]: Es un array bidimensional de colores de fuentes asociados con celdas en el rango.

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

getFontFamilies()

Muestra las familias de fuentes de las celdas en el rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontFamilies();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de familias de fuentes asociadas con las celdas del rango.

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

getFontFamily()

Muestra la familia de fuentes de la celda en la esquina superior izquierda del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontFamily());

Devolvedor

String: Es la familia de fuentes de la celda.

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

getFontLine()

Obtiene el estilo de línea de la celda en la esquina superior izquierda del rango ('underline', 'line-through' o 'none').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontLine());

Devolvedor

String: Es la línea de fuente.

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

getFontLines()

Obtiene el estilo de línea de las celdas en el rango ('underline', 'line-through' o 'none').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontLines();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de líneas de fuente asociadas con las celdas del rango.

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

getFontSize()

Muestra el tamaño de fuente en tamaño de punto de la celda en la esquina superior izquierda del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontSize());

Devolvedor

Integer: Es el tamaño de la fuente en puntos.

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

getFontSizes()

Muestra los tamaños de fuente de las celdas en el rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontSizes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Devolvedor

Integer[][]: Es un array bidimensional de tamaños de fuente del texto asociado con celdas en el rango.

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

getFontStyle()

Muestra el estilo de fuente ('italic' o 'normal') de la celda en la esquina superior izquierda del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontStyle());

Devolvedor

String: Es el estilo de fuente del texto de la celda.

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

getFontStyles()

Muestra los estilos de fuente de las celdas en el rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontStyles();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de estilos de fuente de texto asociados con celdas del rango.

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

getFontWeight()

Muestra el grosor de la fuente (normal/negrita) de la celda en la esquina superior izquierda del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontWeight());

Devolvedor

String: Es el grosor de la fuente del texto de la celda.

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

getFontWeights()

Muestra los grosores de las fuentes de las celdas en el rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontWeights();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de grosores de fuentes de texto asociados con celdas en el rango.

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

getFormula()

Muestra la fórmula (notación A1) para la celda superior izquierda del rango o una string vacía si la celda está vacía o no contiene una fórmula.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This assumes you have a function in B5 that sums up
// B2:B4
var range = sheet.getRange("B5");

// Logs the calculated value and the formula
Logger.log("Calculated value: %s Formula: %s",
           range.getValue(),
           range.getFormula());

Devolvedor

String: Es la fórmula de la celda.

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

getFormulaR1C1()

Muestra la fórmula (notación R1C1) para una celda determinada o null si no hay ninguna.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5");
var formula = range.getFormulaR1C1();
Logger.log(formula);

Devolvedor

String: Es la fórmula en la notación R1C1.

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

getFormulas()

Muestra las fórmulas (notación A1) para las celdas en el rango. Las entradas del array 2D son cadenas vacías para celdas sin fórmula.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulas();
for (var i in formulas) {
  for (var j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de fórmulas en formato de string.

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

getFormulasR1C1()

Muestra las fórmulas (notación R1C1) para las celdas en el rango. Las entradas del array 2D son null para las celdas sin fórmula.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulasR1C1();
for (var i in formulas) {
  for (var j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

Devolvedor

String[][]: Es un array de fórmulas bidimensional en notación R1C1.

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

getGridId()

Muestra el ID de la cuadrícula de la hoja superior del rango. Los ID son valores int aleatorios no negativos.

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getGridId());

Devolvedor

Integer: Es el ID de la cuadrícula de la hoja superior.

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

getHeight()

Muestra la altura del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// logs 3.0
Logger.log(range.getHeight());

Devolvedor

Integer: Es la altura del rango.

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

getHorizontalAlignment()

Muestra la alineación horizontal del texto (izquierda/centro/derecha) de la celda en la esquina superior izquierda del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getHorizontalAlignment());

Devolvedor

String: Es la alineación horizontal del texto en la celda.

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

getHorizontalAlignments()

Muestra las alineaciones horizontales de las celdas en el rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getHorizontalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de alineaciones horizontales de texto asociados con celdas en el rango.

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

getLastColumn()

Muestra la posición de la columna final.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// Logs "4.0"
Logger.log(range.getLastColumn());

Devolvedor

Integer: Es la posición de la columna final del rango en la hoja de cálculo.

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

getLastRow()

Muestra la posición de la fila final.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// Logs "4.0"
Logger.log(range.getLastRow());

Devolvedor

Integer: Es la posición de la fila final del rango en la hoja de cálculo.

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

getMergedRanges()

Muestra un array de objetos Range que representan celdas combinadas que están completamente dentro del rango actual o contienen al menos una celda en el rango actual.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B3");

var mergedRanges = range.getMergedRanges();
for (var i = 0; i < mergedRanges.length; i++) {
  Logger.log(mergedRanges[i].getA1Notation());
  Logger.log(mergedRanges[i].getDisplayValue());
}

Devolvedor

Range[]: Es un array de objetos Range, que representa celdas combinadas que se superponen con el rango.


getNextDataCell(direction)

Comenzando en la celda de la primera columna y fila del rango, muestra la siguiente celda en la dirección determinada, que es el borde de un rango contiguo de celdas con datos o la celda en el borde de la hoja de cálculo en esa dirección. Esto equivale a escribir Ctrl+[arrow key] en el editor.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("C3:E5");
// Logs "C1"
Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());

Parámetros

NombreTipoDescripción
directionDirectionLa dirección en la que se encuentra la siguiente celda perimetral de la región de datos.

Devolvedor

Range: Es la celda del borde de la región de datos o la celda en el borde de la hoja de cálculo.

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

getNote()

Muestra la nota asociada con el rango especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getNote());

Devolvedor

String: Es la nota asociada con la celda determinada.

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

getNotes()

Muestra las notas asociadas con las celdas en el rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getNotes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de notas asociadas con las celdas del rango.

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

getNumColumns()

Muestra el número de columnas en este rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumColumns());

Devolvedor

Integer: Es la cantidad de columnas en este rango.

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

getNumRows()

Muestra la cantidad de filas en este rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumRows());

Devolvedor

Integer: Es la cantidad de filas en este rango.

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

getNumberFormat()

Obtén el formato de fecha o número de la celda superior izquierda del rango especificado. Los patrones de formato que se muestran se describen en la documentación de la API de Hojas de cálculo.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("C4");
Logger.log(cell.getNumberFormat());

Devolvedor

String: Es el formato de número de la celda superior izquierda del rango.

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

getNumberFormats()

Muestra los formatos de número o fecha para las celdas en el rango. Los patrones de formato que se muestran se describen en la documentación de la API de Hojas de cálculo.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var formats = range.getNumberFormats();
for (var i in formats) {
  for (var j in formats[i]) {
    Logger.log(formats[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de formatos de números.

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

getRichTextValue()

Muestra el valor de texto enriquecido de la celda superior izquierda del rango o null si el valor de la celda no es texto.

// Gets the Rich Text value of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var richText = range.getRichTextValue();
console.log(richText.getText());

Devolvedor

RichTextValue: Es el valor de texto enriquecido de la celda superior izquierda en el rango o null si el valor de la celda no es texto.

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

getRichTextValues()

Muestra los valores de texto enriquecido para las celdas en el rango.

// Gets the Rich Text values for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var values = range.getRichTextValues();

for (var i = 0; i < values.length; i++) {
  for (var j = 0; j < values[i].length; j++) {
    console.log(values[i][j].getText());
  }
}

Devolvedor

RichTextValue[][]: Es un array bidimensional de valores de texto enriquecido.

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

getRow()

Muestra la posición de fila de este rango. Idéntico a getRowIndex().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2");
Logger.log(range.getRow());

Devolvedor

Integer: Es la posición de fila del rango.

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

getRowIndex()

Muestra la posición de fila de este rango. Idéntico a getRow().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2");
Logger.log(range.getRowIndex());

Devolvedor

Integer: Es la posición de fila del rango.

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


getSheet()

Muestra la hoja a la que pertenece este rango.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the sheet that the range belongs to.
const rangeSheet = range.getSheet();

// Gets the sheet name and logs it to the console.
console.log(rangeSheet.getName());

Devolvedor

Sheet: Es la hoja a la que pertenece este rango.

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

getTextDirection()

Muestra la dirección de texto de la celda superior izquierda del rango. Muestra null si la dirección del texto de la celda se determina con detección automática.

// Get the text direction of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getTextDirection());

Devolvedor

TextDirection: Es la dirección del texto de la celda superior izquierda del rango.

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

getTextDirections()

Muestra las direcciones del texto para las celdas en el rango. Las entradas del array 2D son null para las celdas que usan detección automática.

// Get the text directions for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var directions = range.getTextDirections();

for (var i = 0; i < directions.length; i++) {
  for (var j = 0; j < directions[i].length; j++) {
    Logger.log(directions[i][j]);
  }
}

Devolvedor

TextDirection[][]: Es un array bidimensional de direcciones de texto.

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

getTextRotation()

Muestra la configuración de rotación de texto para la celda superior izquierda del rango.

// Log the text rotation settings for a cell.
var sheet = SpreadsheetApp.getActiveSheet();

var cell = sheet.getRange("A1");
Logger.log(cell.getTextRotation());

Devolvedor

TextRotation: Es la configuración de rotación de texto.

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

getTextRotations()

Muestra la configuración de rotación de texto para las celdas en el rango.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

var results = range.getTextRotations();

for (var i in results) {
  for (var j in results[i]) {
    var rotation = results[i][j];
    Logger.log("Cell [%s, %s] has text rotation: %v", i, j, rotation);
  }
}

Devolvedor

TextRotation[][]: Es un array bidimensional de rotaciones de texto asociadas con celdas en el rango.

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

getTextStyle()

Muestra el estilo de texto de la celda superior izquierda del rango.

// Get the text style of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var style = range.getTextStyle();
Logger.log(style);

Devolvedor

TextStyle: Es el estilo de texto de la celda superior izquierda en el rango.

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

getTextStyles()

Muestra los estilos de texto de las celdas en el rango.

// Get the text styles for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var styles = range.getTextStyles();

for (var i = 0; i < styles.length; i++) {
  for (var j = 0; j < styles[i].length; j++) {
    Logger.log(styles[i][j]);
  }
}

Devolvedor

TextStyle[][]: Es un array bidimensional de estilos de texto.

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

getValue()

Muestra el valor de la celda superior izquierda en el rango. El valor puede ser del tipo Number, Boolean, Date o String, según el valor de la celda. Las celdas vacías muestran una string vacía.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the value of the top-left cell in the range and logs it to the console.
console.log(range.getValue());

Devolvedor

Object: Es el valor de esta celda.

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

getValues()

Muestra la cuadrícula rectangular de valores para este rango.

Muestra un array de valores bidimensional, indexado por fila y, luego, por columna. Los valores pueden ser del tipo Number, Boolean, Date o String, según el valor de la celda. Las celdas vacías se representan con una cadena vacía en el array. Recuerda que, mientras un índice de rango comienza en 1, 1, el array de JavaScript se indexa desde [0][0].

// The code below gets the values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);
En las apps web, un valor Date no es un parámetro legal. getValues() no puede mostrar datos a una app web si el rango contiene una celda con un valor Date. En cambio, transforma todos los valores recuperados de la hoja en un primitivo de JavaScript compatible, como Number, Boolean o String.

Devolvedor

Object[][]: Es un array de valores bidimensional.

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

getVerticalAlignment()

Muestra la alineación vertical (parte superior/central/inferior) de la celda en la esquina superior izquierda del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getVerticalAlignment());

Devolvedor

String: Es la alineación vertical del texto en la celda.

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

getVerticalAlignments()

Muestra las alineaciones verticales de las celdas en el rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Devolvedor

String[][]: Es un array bidimensional de alineaciones verticales de texto asociados con las celdas del rango.

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

getWidth()

Muestra el ancho del rango en columnas.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the width of the range in number of columns and logs it to the console.
console.log(range.getWidth());

Devolvedor

Integer: Es la cantidad de columnas en el rango.

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

getWrap()

Muestra si se ajusta el texto de la celda. Para obtener una estrategia de ajuste más detallada, usa getWrapStrategy().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getWrap());

Devolvedor

Boolean: Indica si el texto de esta celda se ajusta o no.

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

getWrapStrategies()

Muestra las estrategias de ajuste de texto para las celdas en el rango.

// Get the text wrapping strategies for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var strategies = range.getWrapStrategies();

for (var i = 0; i < strategies.length; i++) {
  for (var j = 0; j < strategies[i].length; j++) {
    Logger.log(strategies[i][j]);
  }
}

Devolvedor

WrapStrategy[][]: Es un array bidimensional de estrategias de ajuste de texto.

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

getWrapStrategy()

Muestra la estrategia de ajuste de texto para la celda superior izquierda del rango.

// Get the text wrapping strategy of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getWrapStrategy());

Devolvedor

WrapStrategy: Es la estrategia de ajuste de texto de la celda superior izquierda del rango.

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

getWraps()

Muestra si se ajusta el texto de las celdas. Para obtener una estrategia de ajuste más detallada, usa getWrapStrategies().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    var isWrapped = results[i][j];
    if (isWrapped) {
       Logger.log("Cell [%s, %s] has wrapped text", i, j);
    }
  }
}

Devolvedor

Boolean[][]: Es un array bidimensional de alineaciones verticales de texto asociados con las celdas del rango.

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

insertCells(shiftDimension)

Inserta celdas vacías en este rango. Las celdas nuevas conservan el formato presente en las celdas que antes ocupaban este rango. Los datos existentes en la hoja a lo largo de la dimensión proporcionada se alejan del rango insertado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

Parámetros

NombreTipoDescripción
shiftDimensionDimensionLa dimensión a la que se desplazan los datos existentes.

Devolvedor

Range: Este rango es 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()

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 range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'true' for checked
// and 'false' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'false'.
range.insertCheckboxes();

Devolvedor

Range: Este rango es 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 range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and the empty string for unchecked. Also, sets the value of each cell in the range A1:B10 to
//  the empty string.
range.insertCheckboxes('yes');

Parámetros

NombreTipoDescripción
checkedValueObjectEl valor marcado para la validación de datos en la casilla de verificación.

Devolvedor

Range: Este rango es 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 range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and 'no' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'no'.
range.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

Range: Este rango es 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

isBlank()

Muestra true si el rango está completamente en blanco.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.isBlank());

Devolvedor

Boolean: Es true si el rango está en blanco; de lo contrario, false.

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

isChecked()

Muestra si todas las celdas del rango tienen el estado de casilla de verificación como "marcado". Muestra null si algunas celdas están marcadas y el resto sin marcar, o si algunas celdas no tienen validación de datos con casillas de verificación.

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

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

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Sets the value of isRange1Checked as true as it contains the checked value.
var isRange1Checked = range1.isChecked();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('no');
// Sets the value of isRange2Checked as false as it contains the unchecked value.
var isRange2Checked = range2.isChecked();

var range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox value.
var isRange3Checked = range3.isChecked();

Devolvedor

Boolean: Es true, si todas las celdas del rango están marcadas, false si todas las celdas del rango están desmarcadas, o null si alguna de las celdas está desmarcada o no tiene una casilla de verificación de validación de datos.

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

isEndColumnBounded()

Determina si el final del rango está vinculado a una columna en particular. Por ejemplo, para los rangos A1:B10 o B:B, que están vinculados a columnas al final del rango, este método muestra true; para los rangos 3:7 o A1:5, que están vinculados solo a filas específicas al final del rango, este método muestra false.

 // Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular column and logs it to the
// console.
console.log(range.isEndColumnBounded());

Devolvedor

Boolean: Es true si el final del rango está vinculado a una columna en particular; de lo contrario, false.

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

isEndRowBounded()

Determina si el final del rango está vinculado a una fila en particular. Por ejemplo, para los rangos A1:B10 o 3:7, que están vinculados a filas al final del rango, este método muestra true; para los rangos B:B o A1:C, que están vinculados solo a columnas particulares al final del rango, este método muestra false.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular row and logs it to the console.
console.log(range.isEndRowBounded());

Devolvedor

Boolean: Es true si el final del rango está vinculado a una fila en particular; de lo contrario, false.

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

isPartOfMerge()

Muestra true si las celdas del rango actual se superponen con alguna celda combinada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B3");

// True if any of the cells in A1:B3 is included in a merge.
var isPartOfMerge = range.isPartOfMerge();

Devolvedor

Boolean: Es true si el rango se superpone con alguna celda combinada; de lo contrario, muestra false.


isStartColumnBounded()

Determina si el inicio del rango está vinculado a una columna en particular. Por ejemplo, para los rangos A1:B10 o B:B, que están vinculados a columnas al comienzo del rango, este método muestra true; para el rango 3:7, que está vinculado solo a una fila al comienzo del rango, este método muestra false.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular column and logs it to the
// console.
console.log(range.isStartColumnBounded());

Devolvedor

Boolean: Es true si el inicio del rango está vinculado a una columna en particular; de lo contrario, false.

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

isStartRowBounded()

Determina si el inicio del rango está vinculado a una fila en particular. Por ejemplo, para los rangos A1:B10 o 3:7, que están vinculados a filas al comienzo del rango, este método muestra true; para el rango B:B, que está vinculado solo a una columna en particular al comienzo del rango, este método muestra false.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular row and logs it to the
// console.
console.log(range.isStartRowBounded());

Devolvedor

Boolean: Es true si el inicio del rango está vinculado a una fila en particular; de lo contrario, false.

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

merge()

Combina las celdas del rango en un solo bloque.

var sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

Devolvedor

Range: Este rango es 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

mergeAcross()

Combina las celdas del rango en las columnas del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The code below merges cells C5:E5 into one cell
var range1 = sheet.getRange("C5:E5");
range1.mergeAcross();

// The code below creates 2 horizontal cells, F5:H5 and F6:H6
var range2 = sheet.getRange("F5:H6");
range2.mergeAcross();

Devolvedor

Range: Este rango es 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

mergeVertically()

Combina las celdas del rango.

var sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

Devolvedor

Range: Este rango es 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

moveTo(target)

Corta y pega (con formato y valores) de este rango en el rango objetivo.

// The code below moves the first 5 columns over to the 6th column
var sheet = SpreadsheetApp.getActiveSheet()
sheet.getRange("A1:E").moveTo(sheet.getRange("F1"));

Parámetros

NombreTipoDescripción
targetRangeRango objetivo en el que se copiará este rango; solo es relevante la posición de la celda superior izquierda.

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

offset(rowOffset, columnOffset)

Muestra un rango nuevo que se desplaza desde este rango por la cantidad determinada de filas y columnas (que pueden ser negativas). El rango nuevo tiene el mismo tamaño que el original.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("A1");

// newCell references B2
var newCell = cell.offset(1, 1);

Parámetros

NombreTipoDescripción
rowOffsetIntegerLa cantidad de filas hacia abajo desde la celda superior izquierda del rango; los valores negativos representan las filas superiores desde la celda superior izquierda del rango.
columnOffsetIntegerEl número de columnas a la derecha de la celda superior izquierda del rango; los valores negativos representan las columnas a la izquierda de la celda superior izquierda del rango.

Devolvedor

Range: Este rango es para el encadenamiento.


offset(rowOffset, columnOffset, numRows)

Muestra un rango nuevo relativo al rango actual, cuyo punto superior izquierdo se desplaza del rango actual por las filas y columnas determinadas, y con la altura determinada en las celdas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("A1");

// newCell references B2:B3
var newRange = cell.offset(1, 1, 2);

Parámetros

NombreTipoDescripción
rowOffsetIntegerLa cantidad de filas hacia abajo desde la celda superior izquierda del rango; los valores negativos representan las filas superiores desde la celda superior izquierda del rango.
columnOffsetIntegerEl número de columnas a la derecha de la celda superior izquierda del rango; los valores negativos representan las columnas a la izquierda de la celda superior izquierda del rango.
numRowsIntegerEs la altura en filas del nuevo rango.

Devolvedor

Range: Este rango es para el encadenamiento.


offset(rowOffset, columnOffset, numRows, numColumns)

Muestra un rango nuevo relativo al rango actual, cuyo punto superior izquierdo se desplaza del rango actual por las filas y columnas determinadas, y con la altura y el ancho dados en las celdas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("A1");

// newCell references B2:C3
var newRange = cell.offset(1, 1, 2, 2);

Parámetros

NombreTipoDescripción
rowOffsetIntegerLa cantidad de filas hacia abajo desde la celda superior izquierda del rango; los valores negativos representan las filas superiores desde la celda superior izquierda del rango.
columnOffsetIntegerEl número de columnas a la derecha de la celda superior izquierda del rango; los valores negativos representan las columnas a la izquierda de la celda superior izquierda del rango.
numRowsIntegerEs la altura en filas del nuevo rango.
numColumnsIntegerEl ancho en columnas del nuevo rango.

Devolvedor

Range: Este rango es para el encadenamiento.


protect()

Crea un objeto que puede evitar que editen el rango, excepto por los usuarios que tengan permiso. Hasta que la secuencia de comandos cambie realmente la lista de editores para el rango (mediante una llamada a Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) o la configuración de un valor nuevo para Protection.setDomainEdit(editable)), los permisos duplican los de la hoja de cálculo en sí, lo que significa que el rango permanece desprotegido. Si el rango ya está protegido, este método crea un rango protegido nuevo que se superpone con el existente. Si una celda está protegida por varios rangos protegidos y alguno de ellos impide que un usuario en particular la edite, ese usuario no tiene permiso para editar la celda.

// Protect range A1:B10, then remove all other users from the list of editors.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var protection = range.protect().setDescription('Sample protected range');

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Devolvedor

Protection: Es un objeto que representa la configuración de la protección.

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

randomize()

Aleatoriza el orden de las filas en el rango especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Randomizes the range
range.randomize();

Devolvedor

Range: Este rango es 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 range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

Devolvedor

Range: Este rango es 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

removeDuplicates()

Quita las filas dentro de este rango que contienen valores que son duplicados de los valores en cualquier fila anterior. Se consideran duplicados las filas con valores idénticos, pero con diferente uso de mayúsculas y minúsculas, formato o fórmulas. Este método también quita las filas duplicadas ocultas de la vista (por ejemplo, debido a un filtro). El contenido fuera de este rango no se quita.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B1:D7");

// Remove duplicate rows in the range.
range.removeDuplicates();

Devolvedor

Range: Es el rango resultante después de quitar duplicados. El tamaño del rango se reduce en una fila por cada fila que se quita.

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

removeDuplicates(columnsToCompare)

Quita las filas dentro de este rango que contienen valores en las columnas especificadas que son duplicados de valores de cualquier fila anterior. Se consideran duplicados las filas con valores idénticos, pero con diferente uso de mayúsculas y minúsculas, formato o fórmulas. Este método también quita las filas duplicadas ocultas de la vista (por ejemplo, debido a un filtro). El contenido fuera de este rango no se quita.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B1:D7");

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2,4]);

Parámetros

NombreTipoDescripción
columnsToCompareInteger[]Las columnas para analizar en busca de valores duplicados. Si no se proporcionan columnas, se analizan todas las columnas en busca de duplicados.

Devolvedor

Range: Es el rango resultante después de quitar duplicados. El tamaño del rango se reduce en una fila por cada fila que se quita.

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 todas las celdas en el rango en la notación CSS (como '#ffffff' o 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D5");
range.setBackground("red");

Parámetros

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

Devolvedor

Range: Este rango es 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

setBackgroundObject(color)

Establece el color de fondo de todas las celdas del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var bgColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();

var range = sheet.getRange("B2:D5");
range.setBackgroundObject(bgColor);

Parámetros

NombreTipoDescripción
colorColorEl color de fondo que se establecerá; el valor de null restablece el color de fondo.

Devolvedor

Range: Este rango es 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

setBackgroundObjects(color)

Establece una cuadrícula rectangular de colores de fondo (debe coincidir con las dimensiones de este rango).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setBackgroundObjects(colors);

Parámetros

NombreTipoDescripción
colorColor[][]Es un array de colores bidimensional. Los valores null restablecen el color.

Devolvedor

Range: Este rango es 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 determinado mediante valores RGB (números enteros entre 0 y 255 inclusive).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.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

Range: Este rango es 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

setBackgrounds(color)

Establece una cuadrícula rectangular de colores de fondo (debe coincidir con las dimensiones de este rango). Los colores están en notación CSS (como '#ffffff' o 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setBackgrounds(colors);

Parámetros

NombreTipoDescripción
colorString[][]Es un array de colores bidimensional en notación CSS (como '#ffffff' o 'white'); los valores null restablecen el color.

Devolvedor

Range: Este rango es 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)

Configura la propiedad del borde. Los valores válidos son true (activado), false (desactivado) y null (sin cambios).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.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

Range: Este rango es 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. Los valores válidos son true (activado), false (desactivado) y null (sin cambios). Para el color, usa Color en la notación CSS (como '#ffffff' o 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.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.
colorStringUn color en notación CSS (como '#ffffff' o 'white'), null para el color predeterminado (negro).
styleBorderStyleUn estilo para los bordes, null para el estilo predeterminado (sólido).

Devolvedor

Range: Este rango es 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

setDataValidation(rule)

Establece una regla de validación de datos para todas las celdas del rango.

// Set the data validation rule for cell A1 to require a value from B1:B10.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

Parámetros

NombreTipoDescripción
ruleDataValidationLa regla de validación de datos que se establecerá o null para quitar la validación de datos.

Devolvedor

Range: Este rango es 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

setDataValidations(rules)

Establece las reglas de validación de datos para todas las celdas del rango. Este método toma un arreglo bidimensional de validaciones de datos, que se indexan por fila y, luego, por columna. Las dimensiones del array deben corresponder a las dimensiones del rango.

// Set the data validation rules for Sheet1!A1:B5 to require a value from Sheet2!A1:A10.
var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
var rules = destinationRange.getDataValidations();
for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

Parámetros

NombreTipoDescripción
rulesDataValidation[][]Es un array bidimensional de reglas de validación de datos para establecer. Los valores null quitan la validación de datos.

Devolvedor

Range: Este rango es 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 la fuente en la notación CSS (como '#ffffff' o 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.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

Range: Este rango es 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

setFontColorObject(color)

Establece el color de la fuente del rango especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();

var cell = sheet.getRange("B2");
cell.setFontColor(color);

Parámetros

NombreTipoDescripción
colorColorEs el color de fuente que se establecerá. Con un valor de null, se restablece el color.

Devolvedor

Range: Este rango es 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

setFontColorObjects(colors)

Establece una cuadrícula rectangular de colores de fuente (debe coincidir con las dimensiones de este rango).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setFontColorObjects(colors);

Parámetros

NombreTipoDescripción
colorsColor[][]Es un array de colores bidimensional. Los valores null restablecen el color de la fuente.

Devolvedor

Range: Este rango es 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

setFontColors(colors)

Establece una cuadrícula rectangular de colores de fuente (debe coincidir con las dimensiones de este rango). Los colores están en notación CSS (como '#ffffff' o 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setFontColors(colors);

Parámetros

NombreTipoDescripción
colorsObject[][]Es un array de colores bidimensional en notación CSS (como '#ffffff' o 'white'); los valores null restablecen el color.

Devolvedor

Range: Este rango es 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

setFontFamilies(fontFamilies)

Establece una cuadrícula rectangular de familias de fuentes (debe coincidir con las dimensiones de este rango). Algunos ejemplos de familias de fuentes son " Arial" o "Helvetica".

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var fonts = [
  ["Arial", "Helvetica", "Verdana"],
  ["Courier New", "Arial", "Helvetica]
];

var cell = sheet.getRange("B2:D3");
cell.setFontFamilies(fonts);

Parámetros

NombreTipoDescripción
fontFamiliesObject[][]Es un array bidimensional de familias de fuentes. Los valores null restablecen la familia de fuentes.

Devolvedor

Range: Este rango es 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, como " Arial" o "Helvetica".

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontFamily("Helvetica");

Parámetros

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

Devolvedor

Range: Este rango es 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 del rango determinado ('underline', 'line-through' o 'none').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.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

Range: Este rango es 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

setFontLines(fontLines)

Establece una cuadrícula rectangular de estilos de línea (debe coincidir con las dimensiones de este rango).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontLines = [
  ["underline", "line-through", "none"]
];

var range = sheet.getRange("B2:D2");
range.setFontLines(fontLines);

Parámetros

NombreTipoDescripción
fontLinesObject[][]Es un array bidimensional de estilos de línea de fuente ('underline', 'line-through' o 'none'). Los valores null restablecen el estilo de línea de fuente.

Devolvedor

Range: Este rango es 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 la fuente; el tamaño es el tamaño en puntos que se usará.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontSize(20);

Parámetros

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

Devolvedor

Range: Este rango es 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

setFontSizes(sizes)

Establece una cuadrícula rectangular de tamaños de fuente (debe coincidir con las dimensiones de este rango). Los tamaños están en puntos.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontSizes = [
  [16, 20, 24]
];

var range = sheet.getRange("B2:D2");
range.setFontSizes(fontSizes);

Parámetros

NombreTipoDescripción
sizesObject[][]Es un array de tamaños bidimensional.

Devolvedor

Range: Este rango es 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)

Define el estilo de fuente para el rango especificado ('italic' o 'normal').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.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

Range: Este rango es 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

setFontStyles(fontStyles)

Establece una cuadrícula rectangular de estilos de fuente (debe coincidir con las dimensiones de este rango).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  ["italic", "normal"]
];

var range = sheet.getRange("B2:C2");
range.setFontStyles(fontStyles);

Parámetros

NombreTipoDescripción
fontStylesObject[][]Es un array bidimensional de estilos de fuente, ya sea 'italic' o 'normal'. Los valores null restablecen el estilo de fuente.

Devolvedor

Range: Este rango es 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)

Define el grosor de la fuente para el rango especificado (normal/negrita).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.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

Range: Este rango es 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

setFontWeights(fontWeights)

Establece una cuadrícula rectangular de tamaños de fuente (debe coincidir con las dimensiones de este rango). Un ejemplo de grosor de fuente es la palabra “negrita”.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  [ "bold", "bold", "normal" ]
];

var range = sheet.getRange("B2:D2");
range.setFontWeights(fontStyles);

Parámetros

NombreTipoDescripción
fontWeightsObject[][]Es un array bidimensional de grosores de fuente, ya sea 'bold' o 'normal'. Los valores null restablecen el grosor de la fuente.

Devolvedor

Range: Este rango es 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 de este rango. La fórmula debe estar en notación A1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
cell.setFormula("=SUM(B3:B4)");

Parámetros

NombreTipoDescripción
formulaStringEs una cadena que representa la fórmula para establecer para la celda.

Devolvedor

Range: Este rango es 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 de este rango. La fórmula debe estar en la notación R1C1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1("=SUM(R[-3]C[0]:R[-1]C[0])");

Parámetros

NombreTipoDescripción
formulaStringUna fórmula de cadena.

Devolvedor

Range: Este rango es 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

setFormulas(formulas)

Establece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango). Las fórmulas proporcionadas deben estar en notación A1. Este método toma un arreglo de fórmulas bidimensional, indexada por fila y, luego, por columna. Las dimensiones del array deben coincidir con las dimensiones del rango.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This sets the formulas to be a row of sums, followed by a row of averages right below.
// The size of the two-dimensional array must match the size of the range.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var cell = sheet.getRange("B5:D6");
cell.setFormulas(formulas);

Parámetros

NombreTipoDescripción
formulasString[][]Es un array de fórmulas bidimensional de strings.

Devolvedor

Range: Este rango es 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

setFormulasR1C1(formulas)

Establece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango). Las fórmulas proporcionadas deben estar en la notación R1C1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This creates formulas for a row of sums, followed by a row of averages.
var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])";
var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])";

// The size of the two-dimensional array must match the size of the range.
var formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove]
];

var cell = sheet.getRange("B5:D6");
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

Parámetros

NombreTipoDescripción
formulasString[][]Matriz bidimensional de fórmulas en formato R1C1.

Devolvedor

Range: Este rango es 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 (de izquierda a derecha) para el rango dado (izquierda/centro/derecha).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setHorizontalAlignment("center");

Parámetros

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

Devolvedor

Range: Este rango es 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

setHorizontalAlignments(alignments)

Establece una cuadrícula rectangular de alineaciones horizontales. Consulta setHorizontalAlignment(alignment).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var horizontalAlignments = [
  [ "left", "right", "center" ]
];

var range = sheet.getRange("B2:D2");
range.setHorizontalAlignments(horizontalAlignments);

Parámetros

NombreTipoDescripción
alignmentsObject[][]Es un array de dos dimensiones de alineamientos, ya sea 'left', 'center' o 'normal'. Un valor null restablece la alineación.

Devolvedor

Range: Este rango es 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


setNote(note)

Establece la nota en el valor especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

Parámetros

NombreTipoDescripción
noteStringEs el valor de nota que se establecerá para el rango; un valor de null quitará la nota.

Devolvedor

Range: Este rango es 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

setNotes(notes)

Establece una cuadrícula rectangular de notas (debe coincidir con las dimensiones de este rango).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var notes = [
  ["it goes", "like this", "the fourth, the fifth"],
  ["the minor fall", "and the", "major lift"]
];

var cell = sheet.getRange("B2:D3");
cell.setNotes(notes)

Parámetros

NombreTipoDescripción
notesObject[][]Es un array bidimensional de notas. Los valores null quitan la nota.

Devolvedor

Range: Este rango es 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


setNumberFormat(numberFormat)

Establece el formato de número o fecha en la string de formato determinada. Los patrones de formato aceptados se describen en la documentación de la API de Hojas de cálculo.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Always show 3 decimal points
cell.setNumberFormat("0.000");

Parámetros

NombreTipoDescripción
numberFormatStringUna string de formato numérico.

Devolvedor

Range: Este rango es 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

setNumberFormats(numberFormats)

Establece una cuadrícula rectangular de formatos de número o fecha (debe coincidir con las dimensiones de este período). Los valores son strings de patrones de formato como se describe en la documentación de la API de Hojas de cálculo.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var formats = [
  [ "0.000", "0,000,000", "$0.00" ]
];

var range = sheet.getRange("B2:D2");
range.setNumberFormats(formats);

Parámetros

NombreTipoDescripción
numberFormatsObject[][]Es un array bidimensional de formatos de número.

Devolvedor

Range: Este rango es 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

setRichTextValue(value)

Establece el valor de texto enriquecido para las celdas en el rango.

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" bolded.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var richText = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
range.setRichTextValue(richText);

Parámetros

NombreTipoDescripción
valueRichTextValueEs el valor de texto enriquecido deseado.

Devolvedor

Range: Este rango es 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

setRichTextValues(values)

Establece una cuadrícula rectangular de valores de Texto enriquecido.

// Sets the cells in range A1:A2 to have Rich Text values.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var richTextA2 = SpreadsheetApp.newRichTextValue()
    .setText("bold words, italic words")
    .setTextStyle(0, 11, bold)
    .setTextStyle(12, 24, italic)
    .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

Parámetros

NombreTipoDescripción
valuesRichTextValue[][]Son los valores deseados de texto enriquecido.

Devolvedor

Range: Este rango es 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

Define si el rango debe mostrar hipervínculos o no.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

Parámetros

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

Devolvedor

Range: Este rango es 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 para las celdas en el rango. Si una dirección especificada es null, se infiere y, luego, se configura.

// Sets right-to-left text direction for the range.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
range.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

Range: Este rango es 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

setTextDirections(directions)

Establece una cuadrícula rectangular de direcciones de texto. Si una dirección especificada es null, se infiere y, luego, se configura.

// Copies all of the text directions from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextDirections());

Parámetros

NombreTipoDescripción
directionsTextDirection[][]La dirección de texto deseada. Si una dirección especificada es null, se infiere antes de configurarla.

Devolvedor

Range: Este rango es 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 el rango. 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 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 all cell's in range B2:D4 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

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

Range: Este rango es 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(rotation)

Establece la configuración de rotación de texto para las celdas en el rango.

// Sets all cell's in range B2:D4 to have the same text rotation settings as cell A1.
var sheet = SpreadsheetApp.getActiveSheet();

var rotation = sheet.getRange("A1").getTextRotation();

sheet.getRange("B2:D4").setTextRotation(rotation);

Parámetros

NombreTipoDescripción
rotationTextRotationLa configuración deseada de rotación de texto.

Devolvedor

Range: Este rango es 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

setTextRotations(rotations)

Establece una cuadrícula rectangular de rotaciones de texto.

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextRotations());

Parámetros

NombreTipoDescripción
rotationsTextRotation[][]La configuración deseada de rotación de texto.

Devolvedor

Range: Este rango es 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

setTextStyle(style)

Establece el estilo de texto de las celdas en el rango.

// Sets the cells in range C5:D6 to have underlined size 15 font.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var style = SpreadsheetApp.newTextStyle()
    .setFontSize(15)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

Parámetros

NombreTipoDescripción
styleTextStyleEl estilo de texto deseado

Devolvedor

Range: Este rango es 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

setTextStyles(styles)

Establece una cuadrícula rectangular de estilos de texto.

// Sets text styles for cells in range A1:B2
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var otherStyle = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .setUnderline(true)
    .setItalic(true)
    .setForegroundColor("#335522")
    .setFontSize(44)
    .build();
range.setTextStyles([[bold, otherStyle], [otherStyle, bold]]);

Parámetros

NombreTipoDescripción
stylesTextStyle[][]Los estilos de texto deseados

Devolvedor

Range: Este rango es 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 del rango. El valor puede ser numérico, string, booleano o fecha. Si comienza con '=', se interpreta como una fórmula.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setValue(100);

Parámetros

NombreTipoDescripción
valueObjectEs el valor del rango.

Devolvedor

Range: Este rango es 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

setValues(values)

Establece una cuadrícula rectangular de valores (debe coincidir con las dimensiones de este rango). Si un valor comienza con =, se interpreta como una fórmula.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

Parámetros

NombreTipoDescripción
valuesObject[][]Es un array de valores bidimensional.

Devolvedor

Range: Este rango es 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 (de arriba abajo) para el rango dado (parte superior/central/inferior).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setVerticalAlignment("middle");

Parámetros

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

Devolvedor

Range: Este rango es 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

setVerticalAlignments(alignments)

Establece una cuadrícula rectangular de alineaciones verticales (debe coincidir con las dimensiones de este rango).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

var range = sheet.getRange("B2:D2");
range.setVerticalAlignments(alignments);

Parámetros

NombreTipoDescripción
alignmentsObject[][]Es un array de dos dimensiones de alineamientos, ya sea 'top', 'middle' o 'bottom'. Un valor null restablece la alineación.

Devolvedor

Range: Este rango es 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


setVerticalText(isVertical)

Establece si se debe apilar o no el texto de las celdas del rango. Si el texto se apila verticalmente, se ignora la configuración de rotación de texto en grados.

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setVerticalText(true);

Parámetros

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

Devolvedor

Range: Este rango es 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)

Establece la unión de celdas del rango determinado.

El tamaño de las celdas que tienen habilitada la unión (configuración predeterminada) cambian de tamaño para mostrar todo su contenido. Las celdas con ajuste inhabilitado se muestran tanto como sea posible en la celda sin cambiar el tamaño ni ejecutar varias líneas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setWrap(true);

Parámetros

NombreTipoDescripción
isWrapEnabledBooleanAjustar texto o no

Devolvedor

Range: Este rango es 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

setWrapStrategies(strategies)

Establece una cuadrícula rectangular de estrategias de unión.

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setWrapStrategies(range1.getWrapStrategies());

Parámetros

NombreTipoDescripción
strategiesWrapStrategy[][]Las estrategias de unión deseadas.

Devolvedor

Range: Este rango es 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 las celdas en el rango.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Parámetros

NombreTipoDescripción
strategyWrapStrategyLa estrategia de ajuste deseada

Devolvedor

Range: Este rango es 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

setWraps(isWrapEnabled)

Establece una cuadrícula rectangular de políticas de ajuste de texto (debe coincidir con las dimensiones de este rango). Las celdas con la unión habilitada (configuración predeterminada) cambian de tamaño para mostrar su contenido completo. Las celdas con ajuste inhabilitada se muestran tanto como sea posible en la celda sin cambiar el tamaño ni ejecutar varias líneas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var range = sheet.getRange("B2:D2");
range.setWraps(wraps);

Parámetros

NombreTipoDescripción
isWrapEnabledObject[][]Es un array bidimensional de variables de ajuste que determinan si se debe ajustar el texto de una celda o no.

Devolvedor

Range: Este rango es 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


shiftColumnGroupDepth(delta)

Cambia la profundidad de agrupación de columnas del rango según la cantidad especificada.

Esto tiene el efecto de crear, modificar o borrar grupos que se cruzan con el rango. Para los deltas positivos, se crean o modifican grupos; para los deltas negativos, se destruyen o modifican los grupos.

Esto no tiene ningún efecto cuando se reduce la profundidad del grupo por debajo de cero o superior a ocho.

Si column group control position es BEFORE, se genera un error cuando se intenta cambiar la profundidad de la primera fila.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

Parámetros

NombreTipoDescripción
deltaIntegerLa cantidad por la cual cambiar la profundidad del grupo de columnas de este rango.

Devolvedor

Range: Este rango es para el encadenamiento.

Arroja

Error: Cuando se intenta cambiar la profundidad de la primera columna cuando la posición de control es GroupControlTogglePosition.BEFORE

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

shiftRowGroupDepth(delta)

Cambia la profundidad de agrupación de filas del rango según la cantidad especificada.

Esto tiene el efecto de crear, modificar o borrar grupos que se cruzan con el rango. Para los deltas positivos, se crean o modifican grupos; para los deltas negativos, se destruyen o modifican los grupos.

Esto no tiene ningún efecto cuando se reduce la profundidad del grupo por debajo de cero o superior a ocho.

Si row group control position es BEFORE, se genera un error cuando se intenta cambiar la profundidad de la primera fila.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

Parámetros

NombreTipoDescripción
deltaIntegerLa cantidad por la cual cambiar la profundidad del grupo de filas de este rango.

Devolvedor

Range: Este rango es para el encadenamiento.

Arroja

Error: Cuando se intenta cambiar la profundidad de la primera fila cuando la posición del control es GroupControlTogglePosition.BEFORE

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

sort(sortSpecObj)

Ordena las celdas en el rango dado, por columna y por orden especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([{column: 2, ascending: false}, {column: 1, ascending: true}]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more readable
// code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([{column: 2, ascending: true}, {column: 1, ascending: true}]);

Parámetros

NombreTipoDescripción
sortSpecObjObjectLas columnas que se usan para ordenar.

Devolvedor

Range: Este rango es 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

splitTextToColumns()

Divide una columna de texto en varias columnas en función de un delimitador detectado automáticamente.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

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

splitTextToColumns(delimiter)

Divide una columna de texto en varias columnas con la string especificada como delimitador personalizado.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Parámetros

NombreTipoDescripción
delimiterStringEl delimitador personalizado en el que se divide.

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

splitTextToColumns(delimiter)

Divide una columna de texto en varias columnas según el delimitador especificado.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Parámetros

NombreTipoDescripción
delimiterTextToColumnsDelimiterEl delimitador predeterminado en el que se dividirá.

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 del rango. Quita todos los espacios en blanco del principio y del final del texto de cada celda, y reduce cualquier subsecuencia de los caracteres de espacios 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)'])

range.trimWhitespace();

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

Devolvedor

Range: Este rango es 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

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 range A1:B10 to 'unchecked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

Devolvedor

Range: Este rango es 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

Métodos obsoletos