Class Range

Rango

Acceder a rangos de hojas de cálculo y modificarlos 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()RangeConfigura 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 especificada y visibilidad 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 banda de columna predeterminado al rango.
applyColumnBanding(bandingTheme)BandingAplica un tema de banda de columnas especificado al rango.
applyColumnBanding(bandingTheme, showHeader, showFooter)BandingAplica un tema de banda de columna especificado al rango con la configuración de encabezado y pie de página especificada.
applyRowBanding()BandingAplica un tema de banda de fila predeterminado al rango.
applyRowBanding(bandingTheme)BandingAplica un tema de banda de fila especificado al rango.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingAplica un tema específico de banda de fila al rango con la configuración de encabezado y pie de página especificada.
autoFill(destination, series)voidCompleta el destinationRange con datos según los datos de este rango.
autoFillToNeighbor(series)voidCalcula el rango que se completará con datos nuevos según las celdas vecinas, y lo completará automáticamente con valores nuevos basados en los datos de ese 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 de verificación del rango a "marcado".
clear()RangeBorra la variedad de contenidos y formatos.
clear(options)RangeBorra el rango de contenido, formato, reglas de validación de datos o comentarios, como se especifica con las opciones avanzadas dadas.
clearContent()RangeBorra el contenido del rango y deja el formato intacto.
clearDataValidations()RangeBorra las reglas de validación de datos del rango.
clearFormat()RangeBorra el formato de este rango.
clearNote()RangeBorra la nota de una o varias celdas determinadas.
collapseGroups()RangeContrae todos los grupos que se encuentran dentro del rango.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidCopia el formato del rango a la ubicación determinada.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidCopia el formato del rango a la ubicación determinada.
copyTo(destination)voidCopia los datos de un rango de celdas a otro.
copyTo(destination, copyPasteType, transposed)voidCopia los datos de un rango de celdas a otro.
copyTo(destination, options)voidCopia los datos de un rango de celdas a otro.
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 DevelopersMetadataFinderApi 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 él.
deleteCells(shiftDimension)voidBorra este rango de celdas.
expandGroups()RangeExpande los grupos contraídos cuyo rango o botón de activación se interseca con este rango.
getA1Notation()StringMuestra una descripción de string del rango, en notación A1.
getBackground()StringMuestra el color de fondo de la celda superior izquierda en el rango (por ejemplo, '#ffffff').
getBackgroundObject()ColorMuestra el color de fondo de la celda superior izquierda en el rango.
getBackgroundObjects()Color[][]Muestra los colores de fondo de las celdas del rango.
getBackgrounds()String[][]Muestra los colores de fondo de las celdas del rango (por ejemplo, '#ffffff').
getBandings()Banding[]Muestra todas las bandas que se aplican a cualquier celda de este rango.
getCell(row, column)RangeMuestra una celda determinada dentro de un rango.
getColumn()IntegerMuestra la posición de la columna inicial para este rango.
getDataRegion()RangeMuestra una copia del rango expandido en las cuatro Direction cardinales para cubrir todas las celdas adyacentes con datos en ellas.
getDataRegion(dimension)RangeMuestra una copia del rango expandido Direction.UP y Direction.DOWN si la dimensión especificada es Dimension.ROWS, o 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 del 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 fuentes de datos que se cruzan con el rango.
getDataSourceUrl()StringMuestra una URL para los datos de este rango, que se pueden usar a fin de crear gráficos y consultas.
getDataTable()DataTableMostrar los datos dentro de este objeto como una tabla de datos
getDataTable(firstRowIsHeader)DataTableMuestra los datos dentro de este rango como DataTable.
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 que se muestra 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 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 del rango.
getFontFamilies()String[][]Muestra las familias de fuentes de las celdas del 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 del rango ('underline', 'line-through' o 'none').
getFontSize()IntegerMuestra el tamaño de fuente en el 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 del 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 del rango.
getFontWeight()StringMuestra el grosor de la fuente (normal/negrita) de la celda, en la esquina superior izquierda del rango.
getFontWeights()String[][]Muestra el grosor de la fuente de las celdas del 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 del rango.
getFormulasR1C1()String[][]Muestra las fórmulas (notación R1C1) para las celdas del rango.
getGridId()IntegerMuestra el ID de 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 del 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 que contienen al menos una celda en el rango actual.
getNextDataCell(direction)RangeComenzando por la celda de la primera columna y fila del rango, muestra la siguiente celda en la dirección dada 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 del rango.
getNumColumns()IntegerMuestra la cantidad de columnas en este rango.
getNumRows()IntegerMuestra la cantidad de filas en este rango.
getNumberFormat()StringObtiene el formato de número o fecha de la celda superior izquierda del rango especificado.
getNumberFormats()String[][]Muestra los formatos de número o fecha para las celdas del rango.
getRichTextValue()RichTextValueMuestra el valor de texto enriquecido para 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 del rango.
getRow()IntegerMuestra la posición de la fila para este rango.
getRowIndex()IntegerMuestra la posición de la fila para este rango.
getSheet()SheetMuestra la hoja a la que pertenece este rango.
getTextDirection()TextDirectionMuestra la dirección del texto de la celda superior izquierda del rango.
getTextDirections()TextDirection[][]Muestra las instrucciones de texto para las celdas del rango.
getTextRotation()TextRotationMuestra la configuración de rotación de texto de la celda superior izquierda del rango.
getTextRotations()TextRotation[][]Muestra la configuración de rotación de texto de las celdas del rango.
getTextStyle()TextStyleMuestra el estilo de texto para la celda superior izquierda del rango.
getTextStyles()TextStyle[][]Muestra los estilos de texto de las celdas del rango.
getValue()ObjectMuestra el valor de la celda superior izquierda del rango.
getValues()Object[][]Muestra la cuadrícula rectangular de valores para este rango.
getVerticalAlignment()StringMuestra la alineación vertical (partes superior/media/inferior) de la celda de la esquina superior izquierda del rango.
getVerticalAlignments()String[][]Muestra las alineaciones verticales de las celdas del 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 del rango.
getWrapStrategy()WrapStrategyMuestra la estrategia de ajuste de texto para la celda superior izquierda del rango.
getWraps()Boolean[][]Muestra si el texto de las celdas se une.
insertCells(shiftDimension)RangeInserta celdas vacías en este rango.
insertCheckboxes()RangeInserta casillas de verificación en cada celda del rango, configurada con true para marcado y con false para desmarcado.
insertCheckboxes(checkedValue)RangeInserta casillas de verificación en cada celda del rango, configurada con un valor personalizado para marcar y la string vacía para desmarcar.
insertCheckboxes(checkedValue, uncheckedValue)RangeInserta casillas de verificación en cada celda del rango, configurada con valores personalizados para los estados de marcados y desmarcados.
isBlank()BooleanMuestra true si el rango está en blanco.
isChecked()BooleanMuestra si todas las celdas del rango tienen el estado de una casilla de verificación marcada.
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 celdas combinadas.
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 (formato y valores) de este rango en el rango objetivo.
offset(rowOffset, columnOffset)RangeMuestra un rango nuevo que está desplazado de este rango por la cantidad determinada de filas y columnas (que puede ser negativo).
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 el ancho y la altura determinados en celdas.
protect()ProtectionCrea un objeto que puede evitar que se edite el rango, a excepción de los usuarios que tienen permiso.
randomize()RangeAleatoriza el orden de las filas en el rango especificado.
removeCheckboxes()RangeQuita todas las casillas de verificación del rango.
removeDuplicates()RangeQuita las filas dentro de este rango que contienen valores que son duplicados de 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 del rango en 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 un 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)RangeEstablece la propiedad del borde.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeEstablece la propiedad de 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 fuente en la notación CSS (como '#ffffff' o 'white').
setFontColorObject(color)RangeEstablece el color de fuente del rango especificado.
setFontColorObjects(colors)RangeEstablece una cuadrícula rectangular de colores de la fuente (debe coincidir con las dimensiones de este rango).
setFontColors(colors)RangeEstablece una cuadrícula rectangular de colores de la 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 la fuente del rango dado ('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 fuente, que es el tamaño de punto para usar.
setFontSizes(sizes)RangeEstablece una cuadrícula rectangular de tamaños de fuente (debe coincidir con las dimensiones de este rango).
setFontStyle(fontStyle)RangeConfigura el estilo de fuente para el rango determinado ('italic' o 'normal').
setFontStyles(fontStyles)RangeEstablece una cuadrícula rectangular de estilos de fuente (debe coincidir con las dimensiones de este rango).
setFontWeight(fontWeight)RangeEstablece el grosor de la fuente para el rango especificado (normal/negrita).
setFontWeights(fontWeights)RangeEstablece una cuadrícula rectangular con grosores 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)RangeConfigura la alineación horizontal (izquierda a derecha) para el rango especificado (izquierda/centro/derecha).
setHorizontalAlignments(alignments)RangeEstablece una cuadrícula rectangular de alineaciones horizontales.
setNote(note)RangeEstablece la nota en el valor dado.
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 con números o formatos de fecha (debe coincidir con las dimensiones de este rango).
setRichTextValue(value)RangeEstablece el valor de texto enriquecido para las celdas del rango.
setRichTextValues(values)RangeEstablece una cuadrícula rectangular de valores de texto enriquecido.
setShowHyperlink(showHyperlink)RangeEstablece si el rango debe mostrar hipervínculos o no.
setTextDirection(direction)RangeEstablece la dirección del texto de las celdas del rango.
setTextDirections(directions)RangeEstablece una cuadrícula rectangular de instrucciones de texto.
setTextRotation(degrees)RangeEstablece la configuración de rotación de texto de las celdas del rango.
setTextRotation(rotation)RangeEstablece la configuración de rotación de texto de las celdas del rango.
setTextRotations(rotations)RangeEstablece una cuadrícula rectangular de rotaciones de texto.
setTextStyle(style)RangeEstablece el estilo de texto para las celdas del 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)RangeEstablezca la alineación vertical (parte superior a inferior) para el rango especificado (parte superior/medio/inferior).
setVerticalAlignments(alignments)RangeEstablece una cuadrícula rectangular de alineaciones verticales (debe coincidir con las dimensiones de este rango).
setVerticalText(isVertical)RangeEstablece si se apilará o no el texto para las celdas del rango.
setWrap(isWrapEnabled)RangeEstablece el ajuste de celda del rango especificado.
setWrapStrategies(strategies)RangeEstablece una cuadrícula rectangular de estrategias de unión.
setWrapStrategy(strategy)RangeEstablece la estrategia de ajuste de texto para las celdas del rango.
setWraps(isWrapEnabled)RangeEstablece una cuadrícula rectangular de las políticas de ajuste de palabras (debe coincidir con las dimensiones de este rango).
shiftColumnGroupDepth(delta)RangeCambia la profundidad de agrupación de columnas del rango por la cantidad especificada.
shiftRowGroupDepth(delta)RangeCambia la profundidad de la agrupación de filas según la cantidad especificada.
sort(sortSpecObj)RangeOrdena las celdas del rango especificado por columna y orden especificado.
splitTextToColumns()voidDivide una columna de texto en varias columnas según 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()RangeRecorta el espacio en blanco (como espacios, tabulaciones o nuevas líneas) en cada celda de este rango.
uncheck()RangeCambia el estado de las casillas de verificación del rango a "unchecked".

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

Volver

Range: Este rango, para encadenar.


activateAsCurrentCell()

Configura la celda especificada como current cell.

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

Si la celda especificada no está presente en ningún rango existente, se quita la selección existente y la celda se convierte en la celda actual y 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());

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

addDeveloperMetadata(key, visibility)

Agrega metadatos del desarrollador con la clave especificada y visibilidad 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.
visibilityDeveloperMetadataVisibilityVisibilidad de los nuevos metadatos del desarrollador

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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.
valueStringEs el valor de los metadatos del desarrollador nuevos.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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.
valueStringEs el valor de los metadatos del desarrollador nuevos.
visibilityDeveloperMetadataVisibilityVisibilidad de los nuevos metadatos del desarrollador

Volver

Range: Este rango, para encadenar.

Autorización

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

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

applyColumnBanding()

Aplica un tema de banda de columna predeterminado al rango. De forma predeterminada, las bandas tienen un encabezado y no tienen color 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());

Volver

Banding: El nuevo grupo.

Autorización

Las secuencias de comandos que usan este método requieren 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 banda de columnas especificado al rango. De forma predeterminada, las bandas tienen un color de encabezado y 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 que se aplicará a las columnas del rango.

Volver

Banding: El nuevo grupo.

Autorización

Las secuencias de comandos que usan este método requieren 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 banda de columna especificado al rango con la configuración de encabezado y pie de página especificada.

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

Volver

Banding: El nuevo grupo.

Autorización

Las secuencias de comandos que usan este método requieren 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 banda de fila predeterminado al rango. De forma predeterminada, las bandas tienen un encabezado y no tienen color 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);

Volver

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 banda de fila especificado al rango. De forma predeterminada, las bandas tienen un encabezado y no tienen color 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
bandingThemeBandingThemeUn tema de color que se aplicará a las filas del rango.

Volver

Banding: El nuevo grupo.

Autorización

Las secuencias de comandos que usan este método requieren 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 específico de banda de fila al rango con la configuración de encabezado y pie de página especificada.

// 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
bandingThemeBandingThemeUn tema de color que se 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.

Volver

Banding: El nuevo grupo.

Autorización

Las secuencias de comandos que usan este método requieren 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 el destinationRange con datos según los datos de este rango. Los valores nuevos también se determinan según el tipo series especificado. El rango de destino debe contener este rango y extenderlo en una sola dirección. Por ejemplo, lo siguiente llena 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 en el que se completarán los valores automáticamente. 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 utilizar para calcular los valores nuevos. El efecto de esta serie difiere en función del 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 el rango que se completará con datos nuevos según las celdas vecinas, y lo completará automáticamente con valores nuevos basados en los datos de ese rango. Estos valores nuevos también se determinan 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 a la izquierda o derecha de una columna que se autocompleta, los valores nuevos solo se extienden en cuanto estos datos adyacentes.

Por ejemplo, si A1:A20 se llena 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 adhieren a las celdas que contienen valores de 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 utilizar para calcular los valores nuevos. El efecto de esta serie difiere en función del 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 en un rango equivale a seleccionar un rango 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();

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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

Volver

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 los valores marcados o desmarcados que se configuraron.

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

clear()

Borra la variedad de contenidos y formatos.

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

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

clear(options)

Borra el rango de contenido, formato, reglas de validación de datos o comentarios, como se especifica con las opciones avanzadas dadas. 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 JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
commentsOnlyBooleanSi solo se deben borrar los comentarios
contentsOnlyBooleanIndica si se debe borrar solo el contenido.
formatOnlyBooleanSi solo quieres borrar el formato; ten en cuenta que, si borras el formato, también se borran las reglas de validación de datos.
validationsOnlyBooleanIndica si solo se deben borrar las reglas de validación de datos.
skipFilteredRowsBooleanIndica si se deben borrar las filas filtradas.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

clearContent()

Borra el contenido del rango y deja el formato intacto.

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

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

clearDataValidations()

Borra las reglas de validación de datos del rango.

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

clearFormat()

Borra el formato de este rango.

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

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

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

clearNote()

Borra la nota de una o varias celdas determinadas.

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

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

collapseGroups()

Contrae todos los grupos que se encuentran dentro del rango. Si ningún grupo se encuentra completamente dentro del rango, se contraerá el grupo expandido más profundo que se encuentre 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();

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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

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

Para obtener una descripción detallada del parámetro cuadrículaId, 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 inicial 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 a la ubicación determinada. Si el destino es mayor o menor que el rango de origen, la fuente se repite o trunca de manera correspondiente. 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 inicial 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. 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 en el que se copiará; solo la posición de la celda superior izquierda es relevante.

Autorización

Las secuencias de comandos que usan este método requieren 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.

// 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 en el que se copiará; solo la posición de la celda superior izquierda es relevante.
copyPasteTypeCopyPasteTypeEs un tipo que especifica cómo se pega el contenido del rango en el destino.
transposedBooleanIndica si el rango se debe pegar 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. De forma predeterminada, los valores y el formato se copian, pero 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 en el que se copiará; solo la posición de la celda superior izquierda es relevante.
optionsObjectUn objeto JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
formatOnlyBooleanindica que solo se debe copiar el formato
contentsOnlyBooleanindica 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 trunca de manera correspondiente.

Para obtener una descripción detallada del parámetro cuadrículaId, 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 inicial 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 trunca de manera correspondiente.

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 inicial 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 nueva tabla dinámica de fuente de datos.

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 desde la que se crea la tabla dinámica.

Volver

DataSourcePivotTable: Es la tabla dinámica 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

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 nueva tabla de fuente de datos.

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 desde la que se crea la tabla dinámica.

Volver

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 DevelopersMetadataFinderApi 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 contenidos en ese rango. Por ejemplo, los metadatos asociados con la fila "3:3" no están dentro del alcance de un rango "A1:D5", pero están dentro del alcance de un 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());

Volver

DeveloperMetadataFinder: 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 a tu filtro y modificarlo después de crearlo, usa 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 las hojas de Grid, el tipo predeterminado de hoja. 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:

Volver

Filter: Es el nuevo 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

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 desde los que se creará la tabla dinámica.

Volver

PivotTable: Es la PivotTable 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

createTextFinder(findText)

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

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 debe buscar.

Volver

TextFinder: El TextFinder para el 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
shiftDimensionDimensionEs la dimensión en la que se deben cambiar 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 interseca con este rango. La ubicación del botón de control es el índice en el que se muestra el botón de activación, 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 se encuentra más abajo.

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

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

getA1Notation()

Muestra una descripción de string 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());

Volver

String: Es la descripción de la string del rango en 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 en el rango (por ejemplo, '#ffffff').

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

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

Volver

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 en el rango.

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

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

Volver

Color: 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 del 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());
  }
}

Volver

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 del 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]);
  }
}

Volver

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

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

Volver

Banding[]: Todas las bandas que se aplican a cualquier celda 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
rowIntegerEs la fila de la celda relativa al rango.
columnIntegerColumna de la celda relativa al rango.

Volver

Range: 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 de la columna inicial 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());

Volver

Integer: Es la posición inicial del rango de la columna 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 las cuatro Direction cardinales para cubrir todas las celdas adyacentes con datos en ellas. Si el rango está rodeado de celdas vacías que no las incluye a lo largo 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());

Volver

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 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 en ellas 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 en la dimensión especificada, se muestra el rango en sí. Este método es similar a seleccionar el rango y escribir Ctrl+Space para las columnas o Shift+Space para las 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
dimensionDimensionEs la dimensión en la que se expande el rango.

Volver

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

Volver

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

Volver

DataSourceFormula[]: Es un array de 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());

Volver

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

Volver

DataSourceTable[]: Es una lista de tablas de fuentes 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 de este rango, que se pueden usar a fin de 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();
}

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

Volver

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

Mostrar los datos dentro de este objeto como una tabla 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: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();

Volver

DataTable: Son los datos como una tabla de datos.


getDataTable(firstRowIsHeader)

Muestra los datos dentro de este rango como DataTable.

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.

Volver

DataTable: 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 estableció 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.')
}

Volver

DataValidation: La regla de validación de datos para 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 estableció 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);

Volver

DataValidation[][]: Es un array bidimensional de reglas de validación de datos asociadas a 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()}`);
}

Volver

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 que se muestra de la celda superior izquierda del rango. El valor es String. El valor que se muestra tiene en cuenta el formato de la fecha, la hora y la moneda, incluidos los formatos que aplica automáticamente 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());

Volver

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 que se muestran, indexados por fila y, luego, por columna. Los valores son objetos String. El valor que se muestra tiene en cuenta el formato de la fecha, la hora y la 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 string 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]);

Volver

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

Volver

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

Volver

Color: 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 del 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());
  }
}

Volver

Color[][]: Es un array bidimensional de colores de fuente 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 del 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]);
  }
}

Volver

String[][]: Es un array bidimensional de familias de fuentes asociadas 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

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

Volver

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

Volver

String: 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 del 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]);
  }
}

Volver

String[][]: Es un array bidimensional de líneas de fuente asociadas a 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 el 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());

Volver

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

Autorización

Las secuencias de comandos que usan este método requieren 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 del 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]);
  }
}

Volver

Integer[][]: Es un array bidimensional de tamaños de fuente del texto asociado con celdas dentro 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

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

Volver

String: Es el estilo de fuente 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

getFontStyles()

Muestra los estilos de fuente de las celdas del 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]);
  }
}

Volver

String[][]: Es un array bidimensional de estilos 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

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

Volver

String: El grosor de la fuente 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

getFontWeights()

Muestra el grosor de la fuente de las celdas del 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]);
  }
}

Volver

String[][]: Es un array bidimensional de grosor 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

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

Volver

String: 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);

Volver

String: La fórmula 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

getFormulas()

Muestra las fórmulas (notación A1) para las celdas del rango. Las entradas del array 2D son strings 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]);
  }
}

Volver

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 del rango. Las entradas del array 2D son null para 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]);
  }
}

Volver

String[][]: Es un array bidimensional de fórmulas 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

getGridId()

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

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

Volver

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

Volver

Integer: 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());

Volver

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 del 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]);
  }
}

Volver

String[][]: Es un array bidimensional de alineaciones horizontales del texto asociado 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

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

Volver

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

Volver

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

Volver

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


getNextDataCell(direction)

Comenzando por la celda de la primera columna y fila del rango, muestra la siguiente celda en la dirección dada 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 busca la próxima celda perimetral de la región de datos.

Volver

Range: Es la celda perimetral de la región de datos o la celda en el perímetro 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());

Volver

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 del 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]);
  }
}

Volver

String[][]: Es un array bidimensional de notas asociadas 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

getNumColumns()

Muestra la cantidad de columnas en este rango.

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

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

Volver

Integer: La cantidad de columnas 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

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

Volver

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

Obtiene el formato de número o fecha 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());

Volver

String: Es el formato numérico 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 del 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]);
  }
}

Volver

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

Autorización

Las secuencias de comandos que usan este método requieren 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 para 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());

Volver

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

Volver

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 la fila para este rango. Es idéntico a getRowIndex().

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

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

Volver

Integer: Es la posición de la 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 la fila para este rango. Es idéntico a getRow().

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

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

Volver

Integer: Es la posición de la 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());

Volver

Sheet: 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 del texto de la celda superior izquierda del rango. Muestra null si la dirección del texto de la celda se determina con una 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());

Volver

TextDirection: Indica 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 instrucciones de texto para las celdas del rango. Las entradas del array 2D son null para las celdas que usan la 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]);
  }
}

Volver

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

Volver

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 de las celdas del 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);
  }
}

Volver

TextRotation[][]: Es un array bidimensional de rotaciones de texto asociadas a 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

getTextStyle()

Muestra el estilo de texto para 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);

Volver

TextStyle: Es el estilo 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

getTextStyles()

Muestra los estilos de texto de las celdas del 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]);
  }
}

Volver

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

Volver

Object: 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 de tipo Number, Boolean, Date o String, según el valor de la celda. Las celdas vacías se representan con una string 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 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 aplicaciones 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 su lugar, transforma todos los valores recuperados de la hoja en una primitiva de JavaScript compatible, como un Number, Boolean o String.

Volver

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 (partes superior/media/inferior) de la celda de 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());

Volver

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 del 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]);
  }
}

Volver

String[][]: Es un array bidimensional de alineaciones verticales de texto asociado 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

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

Volver

Integer: La cantidad de columnas 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

getWrap()

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

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

Logger.log(range.getWrap());

Volver

Boolean: Indica si el texto de esta celda se une 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 del 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]);
  }
}

Volver

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

Volver

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 el texto de las celdas se une. Para obtener una estrategia de unión 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);
    }
  }
}

Volver

Boolean[][]: Es un array bidimensional de alineaciones verticales de texto asociado 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

insertCells(shiftDimension)

Inserta celdas vacías en este rango. Las celdas nuevas conservan cualquier formato presente en las celdas que anteriormente 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
shiftDimensionDimensionEs la dimensión en la que se deben cambiar los datos existentes.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

insertCheckboxes()

Inserta casillas de verificación en cada celda del rango, configurada con true para marcado y con false para desmarcado. Establece el valor de todas las celdas del 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();

Volver

Range: Este rango, para encadenar.

Autorización

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

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

insertCheckboxes(checkedValue)

Inserta casillas de verificación en cada celda del rango, configurada con un valor personalizado para marcar y la string vacía para desmarcar. Establece la string vacía en el valor de cada celda del rango.

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
checkedValueObjectValor marcado para la validación de datos de la casilla de verificación.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

insertCheckboxes(checkedValue, uncheckedValue)

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

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
checkedValueObjectValor marcado para la validación de datos de la casilla de verificación.
uncheckedValueObjectEl valor no marcado para la validación de datos de la casilla de verificación.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

isBlank()

Muestra true si el rango está en blanco.

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

Logger.log(range.isBlank());

Volver

Boolean: Es el 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 una casilla de verificación marcada. Muestra null si algunas celdas están marcadas y el resto no está marcado, o si algunas celdas no tienen la validación de datos de casilla 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();

Volver

Boolean: 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 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. En el caso de 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());

Volver

Boolean: Es true si el final del rango está vinculado a una columna específica. 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. En el caso de los rangos B:B o A1:C, que solo están vinculados 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());

Volver

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 celdas combinadas.

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

Volver

Boolean: Muestra true si el rango se superpone con celdas combinadas; 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());

Volver

Boolean: Es true si el inicio del rango está vinculado a una columna específica. 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());

Volver

Boolean: Es true si el inicio del rango está vinculado a una fila en particular; en caso 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();

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

moveTo(target)

Corta y pega (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 de destino 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 está desplazado de este rango por la cantidad determinada de filas y columnas (que puede ser negativo). El rango nuevo es del 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 filas hacia arriba de la celda superior izquierda del rango.
columnOffsetIntegerNúmero de columnas a la derecha de la celda superior izquierda del rango; los valores negativos representan columnas de la celda superior izquierda del rango.

Volver

Range: Este rango, para encadenar.


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 filas hacia arriba de la celda superior izquierda del rango.
columnOffsetIntegerNúmero de columnas a la derecha de la celda superior izquierda del rango; los valores negativos representan columnas de la celda superior izquierda del rango.
numRowsIntegerLa altura en filas del rango nuevo

Volver

Range: Este rango, para encadenar.


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 el ancho y la altura determinados en 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 filas hacia arriba de la celda superior izquierda del rango.
columnOffsetIntegerNúmero de columnas a la derecha de la celda superior izquierda del rango; los valores negativos representan columnas de la celda superior izquierda del rango.
numRowsIntegerLa altura en filas del rango nuevo
numColumnsIntegerEl ancho en columnas del rango nuevo.

Volver

Range: Este rango, para encadenar.


protect()

Crea un objeto que puede evitar que se edite el rango, a excepción de los usuarios que tienen permiso. Hasta que la secuencia de comandos cambie la lista de editores para el rango (llamando a Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user) o Protection.addEditors(emailAddresses), o configurando un valor nuevo para Protection.setDomainEdit(editable)), los permisos reflejan los de la hoja de cálculo, 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 edite la celda, ese usuario no tiene permiso para editarla.

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

Volver

Protection: Es un objeto que representa la configuración de 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();

Volver

Range: Este rango, para encadenar.

Autorización

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

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

removeCheckboxes()

Quita todas las casillas de verificación del rango. Borra la validación de datos de cada celda y su valor si su 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();

Volver

Range: Este rango, para encadenar.

Autorización

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

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

removeDuplicates()

Quita las filas dentro de este rango que contienen valores que son duplicados de valores en cualquier fila anterior. Se consideran duplicadas las filas con valores idénticos, pero con letras, formato o fórmulas diferentes. Este método también quita las filas duplicadas ocultas de la vista (por ejemplo, debido a un filtro). No se quita el contenido que se encuentra fuera de este rango.

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

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

Volver

Range: El rango resultante después de quitar duplicados. Se reduce el tamaño del rango 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 duplicadas las filas con valores idénticos, pero con letras mayúsculas, formato o fórmulas diferentes. Este método también quita las filas duplicadas ocultas de la vista (por ejemplo, debido a un filtro). No se quita el contenido que se encuentra fuera de este rango.

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, todas las columnas se analizan en busca de duplicados.

Volver

Range: El rango resultante después de quitar duplicados. Se reduce el tamaño del rango 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 del rango en 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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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 bidimensional de colores; los valores de null restablecen el color.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setBackgroundRGB(red, green, blue)

Establece el fondo en un 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
redIntegerEl valor rojo en la notación RGB
greenIntegerEl valor verde en la notación RGB
blueIntegerEl valor azul en la notación RGB

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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[][]Corresponde a un array bidimensional de colores en la notación CSS (como '#ffffff' o 'white'); los valores null restablecen el color.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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

Establece la propiedad del borde. Los valores válidos son true (activado), false (apagado) 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, null para sin cambios.
leftBooleantrue para el borde, false para ninguno, null para sin cambios.
bottomBooleantrue para el borde, false para ninguno, null para sin cambios.
rightBooleantrue para el borde, false para ninguno, null para sin cambios.
verticalBooleantrue para bordes verticales internos, false para ninguno, null para sin cambios.
horizontalBooleantrue para bordes horizontales internos, false para ninguno, null para sin cambios.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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

Establece la propiedad de borde con color o estilo. Los valores válidos son true (activado), false (apagado) y null (sin cambios). Para agregar 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, null para sin cambios.
leftBooleantrue para el borde, false para ninguno, null para sin cambios.
bottomBooleantrue para el borde, false para ninguno, null para sin cambios.
rightBooleantrue para el borde, false para ninguno, null para sin cambios.
verticalBooleantrue para bordes verticales internos, false para ninguno, null para sin cambios.
horizontalBooleantrue para bordes horizontales internos, false para ninguno, null para sin cambios.
colorStringUn color en la 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)

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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 debe establecer o null para quitar la validación de datos

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setDataValidations(rules)

Establece las reglas de validación de datos para todas las celdas del rango. Este método toma un array bidimensional de validaciones de datos, indexado 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[][]Un arreglo bidimensional de reglas de validación de datos para configurar; los valores de null quitan la validación de datos.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontColor(color)

Establece el color de fuente 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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontColorObject(color)

Establece el color de 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
colorColorEl color de fuente que se establecerá; un valor null restablece el color.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontColorObjects(colors)

Establece una cuadrícula rectangular de colores de la 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[][]Una matriz de colores bidimensional; los valores de null restablecen el color de la fuente.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontColors(colors)

Establece una cuadrícula rectangular de colores de la 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[][]Corresponde a un array bidimensional de colores en la notación CSS (como '#ffffff' o 'white'); los valores null restablecen el color.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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[][]Un array bidimensional de familias de fuentes; los valores de null restablecen la familia de fuentes.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontFamily(fontFamily)

Establece la familia de fuentes, 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 configurará; un valor null restablece la familia de fuentes.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontLine(fontLine)

Establece el estilo de línea de la fuente del rango dado ('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.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontSize(size)

Establece el tamaño de fuente, que es el tamaño de punto para usar.

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

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

Parámetros

NombreTipoDescripción
sizeIntegerTamaño de fuente en tamaño de punto

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontSizes(sizes)

Establece una cuadrícula rectangular de tamaños de fuente (debe coincidir con las dimensiones de este rango). Los tamaños se indican 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[][]Un array de tamaños bidimensionales.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontStyle(fontStyle)

Configura el estilo de fuente para el rango determinado ('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 fuente

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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[][]Un array bidimensional de estilos de fuente, ya sea 'italic' o 'normal'; los valores null restablecen el estilo de fuente.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontWeight(fontWeight)

Establece el grosor de la fuente para 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.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFontWeights(fontWeights)

Establece una cuadrícula rectangular con grosores de fuente (debe coincidir con las dimensiones de este rango). Un ejemplo de un grosor de fuente es "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[][]Un array bidimensional de grosores de fuente, ya sea 'bold' o 'normal'; los valores de null restablecen el grosor de fuente.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFormula(formula)

Actualiza la fórmula de este rango. La fórmula especificada debe estar en la 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
formulaStringString que representa la fórmula que se debe establecer para la celda.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFormulaR1C1(formula)

Actualiza la fórmula de este rango. La fórmula dada 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 string.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFormulas(formulas)

Establece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango). Las fórmulas dadas deben estar en la notación A1. Este método toma un array bidimensional de fórmulas, indexadas por fila y, luego, por columna. Las dimensiones del array deben corresponder a 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[][]Un array de strings bidimensional de fórmulas

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setFormulasR1C1(formulas)

Establece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango). Las fórmulas deben estar en 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[][]Una matriz de fórmulas bidimensionales en formato R1C1.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setHorizontalAlignment(alignment)

Configura la alineación horizontal (izquierda a derecha) para el rango especificado (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 restablece la alineación.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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[][]Un array de alineamientos de dos dimensiones, 'left', 'center' o 'normal'; un valor null restablece la alineación.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

Consulta también


setNote(note)

Establece la nota en el valor dado.

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

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

Parámetros

NombreTipoDescripción
noteStringEl valor de la nota que se establece para el rango; un valor null quita la nota.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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[][]Un arreglo de notas bidimensional; los valores de null quitan la nota.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

Consulta también


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 de número.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setNumberFormats(numberFormats)

Establece una cuadrícula rectangular con números o formatos de fecha (debe coincidir con las dimensiones de este rango). 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[][]Un array bidimensional de formatos numéricos

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setRichTextValue(value)

Establece el valor de texto enriquecido para las celdas del 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
valueRichTextValueEl valor deseado de texto enriquecido

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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[][]Los valores deseados de texto enriquecido

Volver

Range: Este rango, para encadenar.

Autorización

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

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

Establece si 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 muestra el hipervínculo o no.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setTextDirection(direction)

Establece la dirección del texto de las celdas del rango. Si la dirección especificada es null, se infiere y, luego, se establece.

// 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 del texto deseada; si null se infiere antes de la configuración.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setTextDirections(directions)

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

// 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[][]Las instrucciones en texto deseadas; si una dirección especificada es null, se infiere antes de la configuración.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setTextRotation(degrees)

Establece la configuración de rotación de texto de las celdas del 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 del texto de izquierda a derecha, los ángulos positivos están en el sentido antihorario, mientras que para el derecho a la izquierda, están 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 deseada. En el caso del texto de izquierda a derecha, los ángulos positivos son hacia la izquierda.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setTextRotation(rotation)

Establece la configuración de rotación de texto de las celdas del 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 de rotación de texto deseada

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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 de rotación de texto deseada

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setTextStyle(style)

Establece el estilo de texto para las celdas del 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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setValue(value)

Establece el valor del rango. El valor puede ser numérico, de string, booleano o de 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
valueObjectEl valor del rango.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setValues(values)

Establece una cuadrícula rectangular de valores (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 values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

Parámetros

NombreTipoDescripción
valuesObject[][]Array de valores bidimensional.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setVerticalAlignment(alignment)

Establezca la alineación vertical (parte superior a inferior) para el rango especificado (parte superior/medio/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 restablece la alineación.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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[][]Un array de alineaciones bidimensional, ya sea 'top', 'middle' o 'bottom'; un valor null restablece la alineación.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

Consulta también


setVerticalText(isVertical)

Establece si se apilará o no el texto para las celdas del rango. Si el texto se apila verticalmente, se ignora la configuración de rotación de texto de grado.

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setWrap(isWrapEnabled)

Establece el ajuste de celda del rango especificado.

Las celdas con ajuste envolvente (el valor predeterminado) cambian de tamaño para mostrar todo el contenido. Las celdas con ajuste inhabilitado se muestran tanto como sea posible en la celda sin cambiar el tamaño ni ejecutarse en varias líneas.

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

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

Parámetros

NombreTipoDescripción
isWrapEnabledBooleanSi se trata de ajustar el texto o no.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

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[][]Son las estrategias de unión deseadas.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setWrapStrategy(strategy)

Establece la estrategia de ajuste de texto para las celdas del 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 unión deseada.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

setWraps(isWrapEnabled)

Establece una cuadrícula rectangular de las políticas de ajuste de palabras (debe coincidir con las dimensiones de este rango). Las celdas con ajuste habilitado (ajuste predeterminado) cambian de tamaño para mostrar todo el contenido. Las celdas con el ajuste inhabilitado se muestran tanto como sea posible en la celda sin cambiar el tamaño ni ejecutarse en 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[][]Array de dos dimensiones de variables de unión que determina si se debe ajustar el texto en una celda o no.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

Consulta también


shiftColumnGroupDepth(delta)

Cambia la profundidad de agrupación de columnas del rango por 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 los grupos; para los deltas negativos, los grupos se destruyen o modifican.

Esto no tiene efecto cuando se reduce la profundidad del grupo por debajo de cero o superior a ocho.

Si el 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 en la que se cambia la profundidad del grupo de columnas de este rango.

Volver

Range: Este rango, para encadenar.

Arroja

Error: cuando se intenta cambiar la profundidad de la primera columna 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

shiftRowGroupDepth(delta)

Cambia la profundidad de la agrupación de filas 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 los grupos; para los deltas negativos, los grupos se destruyen o modifican.

Esto no tiene efecto cuando se reduce la profundidad del grupo por debajo de cero o superior a ocho.

Si el 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 en la que se cambia la profundidad del grupo de filas de este rango.

Volver

Range: Este rango, para encadenar.

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 del rango especificado por columna y 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 para ordenar.

Volver

Range: Este rango, para encadenar.

Autorización

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

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

splitTextToColumns()

Divide una columna de texto en varias columnas según 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 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

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

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

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

range.trimWhitespace();

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

uncheck()

Cambia el estado de las casillas de verificación de los rangos a "desmarcado". Ignora las celdas del rango que actualmente no contienen los valores marcados o desmarcados que se configuraron.

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

Volver

Range: Este rango, para encadenar.

Autorización

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

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

Métodos obsoletos