Class Range

Range

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 del rango como current cell.
activateAsCurrentCell()RangeEstablece la celda especificada como current cell.
addDeveloperMetadata(key)RangeAgrega metadatos para desarrolladores con la clave especificada al rango.
addDeveloperMetadata(key, visibility)RangeAgrega metadatos del desarrollador con la clave y la visibilidad especificadas al rango.
addDeveloperMetadata(key, value)RangeAgrega metadatos para desarrolladores 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 predeterminado de bandas de columnas al rango.
applyColumnBanding(bandingTheme)BandingAplica un tema de bandas de columnas especificado al rango.
applyColumnBanding(bandingTheme, showHeader, showFooter)BandingAplica un tema de bandas de columnas especificado al rango con la configuración de encabezado y pie de página especificada.
applyRowBanding()BandingAplica un tema predeterminado de bandas de filas al rango.
applyRowBanding(bandingTheme)BandingAplica un tema de bandas de filas especificado al rango.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingAplica un tema de bandas de filas especificado al rango con la configuración de encabezado y pie de página especificada.
autoFill(destination, series)voidCompleta el destinationRange con datos basados en los datos de este rango.
autoFillToNeighbor(series)voidCalcula un rango para completar con datos nuevos según las celdas vecinas y, luego, lo completa automáticamente con valores nuevos según los datos que contiene.
breakApart()RangeVuelve a dividir las celdas de varias columnas del rango en celdas individuales.
canEdit()BooleanDetermina si el usuario tiene permiso para editar cada celda del rango.
check()RangeCambia el estado de las casillas de verificación del rango a “checked”.
clear()RangeBorra el rango de contenido y formatos.
clear(options)RangeBorra el rango de contenido, formato, reglas de validación de datos o comentarios, según se especifica con las opciones avanzadas proporcionadas.
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 la celda o las celdas especificadas.
collapseGroups()RangeContrae todos los grupos que están completamente contenidos dentro del rango.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidCopia el formato del rango en la ubicación especificada.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidCopia el formato del rango en la ubicación especificada.
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 especificada.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidCopia el contenido del rango en la ubicación especificada.
createDataSourcePivotTable(dataSource)DataSourcePivotTableCrea una tabla dinámica vacía 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()DeveloperMetadataFinderDevuelve un DeveloperMetadataFinderApi para encontrar metadatos para desarrolladores 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, anclada en la primera celda de este rango.
createTextFinder(findText)TextFinderCrea un buscador de texto para el rango, que puede buscar y reemplazar texto en este rango.
deleteCells(shiftDimension)voidBorra este rango de celdas.
expandGroups()RangeExpande los grupos contraídos cuyo rango o botón de activación de control se interseca con este rango.
getA1Notation()StringDevuelve una descripción de cadena del rango en notación A1.
getBackground()StringDevuelve el color de fondo de la celda superior izquierda del rango (por ejemplo, '#ffffff').
getBackgroundObject()ColorDevuelve el color de fondo de la celda superior izquierda del rango.
getBackgroundObjects()Color[][]Devuelve los colores de fondo de las celdas del rango.
getBackgrounds()String[][]Devuelve los colores de fondo de las celdas del rango (por ejemplo, '#ffffff').
getBandings()Banding[]Devuelve todas las bandas que se aplican a las celdas de este rango.
getCell(row, column)RangeDevuelve una celda determinada dentro de un rango.
getColumn()IntegerDevuelve la posición de la columna inicial de este rango.
getDataRegion()RangeDevuelve una copia del rango expandido en las cuatro direcciones cardinales Direction para abarcar todas las celdas adyacentes que contienen datos.
getDataRegion(dimension)RangeDevuelve 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()DataSourceFormulaDevuelve DataSourceFormula para la primera celda del rango o null si la celda no contiene una fórmula de fuente de datos.
getDataSourceFormulas()DataSourceFormula[]Devuelve los valores de DataSourceFormula para 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 la fuente de datos que se cruzan con el rango.
getDataSourceUrl()StringDevuelve una URL para los datos de este rango, que se puede usar para crear gráficos y consultas.
getDataTable()DataTableDevuelve los datos dentro de este objeto como un objeto DataTable.
getDataTable(firstRowIsHeader)DataTableDevuelve los datos dentro de este rango como un objeto DataTable.
getDataValidation()DataValidationDevuelve la regla de validación de datos para la celda superior izquierda del rango.
getDataValidations()DataValidation[][]Devuelve las reglas de validación de datos para todas las celdas del rango.
getDeveloperMetadata()DeveloperMetadata[]Obtiene los metadatos de desarrollador asociados con este rango.
getDisplayValue()StringDevuelve el valor que se muestra en la celda superior izquierda del rango.
getDisplayValues()String[][]Devuelve la cuadrícula rectangular de valores para este rango.
getFilter()FilterDevuelve el filtro de la hoja a la que pertenece este rango o null si no hay ningún filtro en la hoja.
getFontColorObject()ColorDevuelve el color de la fuente de la celda en la esquina superior izquierda del rango.
getFontColorObjects()Color[][]Devuelve los colores de fuente de las celdas del rango.
getFontFamilies()String[][]Devuelve las familias de fuentes de las celdas del rango.
getFontFamily()StringDevuelve la familia de fuentes de la celda ubicada 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()IntegerDevuelve el tamaño de fuente en puntos de la celda ubicada en la esquina superior izquierda del rango.
getFontSizes()Integer[][]Devuelve los tamaños de fuente de las celdas del rango.
getFontStyle()StringDevuelve el estilo de fuente ('italic' o 'normal') de la celda ubicada en la esquina superior izquierda del rango.
getFontStyles()String[][]Devuelve los estilos de fuente de las celdas del rango.
getFontWeight()StringDevuelve el grosor de la fuente (normal o negrita) de la celda ubicada en la esquina superior izquierda del rango.
getFontWeights()String[][]Devuelve los pesos de fuente de las celdas del rango.
getFormula()StringDevuelve la fórmula (notación A1) de la celda superior izquierda del rango o una cadena vacía si la celda está vacía o no contiene una fórmula.
getFormulaR1C1()StringDevuelve la fórmula (notación R1C1) de una celda determinada o null si no hay ninguna.
getFormulas()String[][]Devuelve las fórmulas (notación A1) de las celdas del rango.
getFormulasR1C1()String[][]Devuelve las fórmulas (notación R1C1) de las celdas del rango.
getGridId()IntegerDevuelve el ID de cuadrícula de la hoja principal del rango.
getHeight()IntegerDevuelve la altura del rango.
getHorizontalAlignment()StringDevuelve la alineación horizontal del texto (izquierda/centro/derecha) de la celda en la esquina superior izquierda del rango.
getHorizontalAlignments()String[][]Devuelve las alineaciones horizontales de las celdas en el rango.
getLastColumn()IntegerDevuelve la posición de la columna final.
getLastRow()IntegerDevuelve la posición de la fila final.
getMergedRanges()Range[]Devuelve un array de objetos Range que representan celdas combinadas que se encuentran completamente dentro del rango actual o que contienen al menos una celda en el rango actual.
getNextDataCell(direction)RangeA partir de la celda de la primera columna y fila del rango, devuelve la siguiente celda en la dirección indicada 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()StringDevuelve la nota asociada con el rango determinado.
getNotes()String[][]Devuelve las notas asociadas a las celdas del rango.
getNumColumns()IntegerDevuelve la cantidad de columnas en este rango.
getNumRows()IntegerDevuelve la cantidad de filas en este rango.
getNumberFormat()StringObtiene el formato de número o fecha de la celda superior izquierda del rango determinado.
getNumberFormats()String[][]Devuelve los formatos de número o fecha de las celdas del rango.
getRichTextValue()RichTextValueDevuelve el valor de texto enriquecido de la celda superior izquierda del rango o null si el valor de la celda no es texto.
getRichTextValues()RichTextValue[][]Devuelve los valores de texto enriquecido de las celdas del rango.
getRow()IntegerDevuelve la posición de la fila para este rango.
getRowIndex()IntegerDevuelve la posición de la fila para este rango.
getSheet()SheetDevuelve la hoja a la que pertenece este rango.
getTextDirection()TextDirectionDevuelve la dirección del texto de la celda superior izquierda del rango.
getTextDirections()TextDirection[][]Devuelve las direcciones de texto para las celdas del rango.
getTextRotation()TextRotationDevuelve la configuración de rotación del texto para la celda superior izquierda del rango.
getTextRotations()TextRotation[][]Devuelve la configuración de rotación del texto para las celdas del rango.
getTextStyle()TextStyleDevuelve el estilo de texto de la celda superior izquierda del rango.
getTextStyles()TextStyle[][]Devuelve los estilos de texto de las celdas del rango.
getValue()ObjectDevuelve el valor de la celda superior izquierda del rango.
getValues()Object[][]Devuelve la cuadrícula rectangular de valores para este rango.
getVerticalAlignment()StringDevuelve la alineación vertical (superior, central o inferior) de la celda en la esquina superior izquierda del rango.
getVerticalAlignments()String[][]Devuelve las alineaciones verticales de las celdas en el rango.
getWidth()IntegerDevuelve el ancho del rango en columnas.
getWrap()BooleanDevuelve un valor que indica si el texto de la celda se ajusta.
getWrapStrategies()WrapStrategy[][]Devuelve las estrategias de ajuste de texto para las celdas del rango.
getWrapStrategy()WrapStrategyDevuelve la estrategia de ajuste de texto para la celda superior izquierda del rango.
getWraps()Boolean[][]Devuelve si el texto de las celdas se ajusta.
insertCells(shiftDimension)RangeInserta celdas vacías en este rango.
insertCheckboxes()RangeInserta casillas de verificación en cada celda del rango, configuradas con true para las casillas marcadas y false para las desmarcadas.
insertCheckboxes(checkedValue)RangeInserta casillas de verificación en cada celda del rango, configuradas con un valor personalizado para la opción marcada y la cadena vacía para la opción desmarcada.
insertCheckboxes(checkedValue, uncheckedValue)RangeInserta casillas de verificación en cada celda del rango, configuradas con valores personalizados para los estados de marcado y desmarcado.
isBlank()BooleanDevuelve true si el rango está completamente en blanco.
isChecked()BooleanDevuelve si todas las celdas del rango tienen el estado de la casilla de verificación como "checked".
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()BooleanDevuelve true si las celdas del rango actual se superponen con alguna celda combinada.
isStartColumnBounded()BooleanDetermina si el inicio del rango está vinculado a una columna en particular.
isStartRowBounded()BooleanDetermina si el inicio del rango está vinculado a una fila en particular.
merge()RangeCombina las celdas del rango en un solo bloque.
mergeAcross()RangeCombina las celdas del rango en las columnas del rango.
mergeVertically()RangeCombina las celdas del rango.
moveTo(target)voidCorta y pega (tanto el formato como los valores) de este rango al rango de destino.
offset(rowOffset, columnOffset)RangeDevuelve un rango nuevo que se desplaza desde este rango según la cantidad de filas y columnas proporcionada (que puede ser negativa).
offset(rowOffset, columnOffset, numRows)RangeDevuelve un rango nuevo que es 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 celdas.
offset(rowOffset, columnOffset, numRows, numColumns)RangeDevuelve un rango nuevo que es relativo al rango actual, cuyo punto superior izquierdo se desplaza desde el rango actual según las filas y columnas proporcionadas, y con la altura y el ancho proporcionados en celdas.
protect()ProtectionCrea un objeto que puede proteger el rango para que no se edite, excepto por los usuarios que tienen permiso.
randomize()RangeAleatoriza el orden de las filas en el rango determinado.
removeCheckboxes()RangeQuita todas las casillas de verificación del rango.
removeDuplicates()RangeQuita las filas dentro de este rango que contienen valores 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 con el color determinado usando 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 de 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 la fuente en notación CSS (como '#ffffff' o 'white').
setFontColorObject(color)RangeEstablece el color de fuente del rango determinado.
setFontColorObjects(colors)RangeEstablece una cuadrícula rectangular de colores de fuente (debe coincidir con las dimensiones de este rango).
setFontColors(colors)RangeEstablece una cuadrícula rectangular de colores de fuente (debe coincidir con las dimensiones de este rango).
setFontFamilies(fontFamilies)RangeEstablece una cuadrícula rectangular de familias de fuentes (debe coincidir con las dimensiones de este rango).
setFontFamily(fontFamily)RangeEstablece la familia de fuentes, como "Arial" o "Helvetica".
setFontLine(fontLine)RangeEstablece el estilo de línea de la fuente del rango determinado ('underline', 'line-through' o 'none').
setFontLines(fontLines)RangeEstablece una cuadrícula rectangular de estilos de línea (debe coincidir con las dimensiones de este rango).
setFontSize(size)RangeEstablece el tamaño de la fuente, que es el tamaño en puntos que se usará.
setFontSizes(sizes)RangeEstablece una cuadrícula rectangular de tamaños de fuente (debe coincidir con las dimensiones de este rango).
setFontStyle(fontStyle)RangeEstablece 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 determinado (normal o negrita).
setFontWeights(fontWeights)RangeEstablece una cuadrícula rectangular de pesos de fuente (debe coincidir con las dimensiones de este rango).
setFormula(formula)RangeActualiza la fórmula de este rango.
setFormulaR1C1(formula)RangeActualiza la fórmula de este rango.
setFormulas(formulas)RangeEstablece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango).
setFormulasR1C1(formulas)RangeEstablece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango).
setHorizontalAlignment(alignment)RangeEstablece la alineación horizontal (de izquierda a derecha) para el rango determinado (izquierda/centro/derecha).
setHorizontalAlignments(alignments)RangeEstablece una cuadrícula rectangular de alineaciones horizontales.
setNote(note)RangeEstablece la nota en el valor determinado.
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 cadena de formato determinada.
setNumberFormats(numberFormats)RangeEstablece una cuadrícula rectangular de formatos de número o 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.
setTextDirection(direction)RangeEstablece la dirección del texto para las celdas del rango.
setTextDirections(directions)RangeEstablece una cuadrícula rectangular de direcciones de texto.
setTextRotation(degrees)RangeEstablece la configuración de rotación del texto para las celdas del rango.
setTextRotation(rotation)RangeEstablece la configuración de rotación del texto para 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)RangeEstablece la alineación vertical (de arriba hacia abajo) para el rango determinado (arriba, medio o abajo).
setVerticalAlignments(alignments)RangeEstablece una cuadrícula rectangular de alineaciones verticales (debe coincidir con las dimensiones de este rango).
setVerticalText(isVertical)RangeEstablece si se debe apilar el texto de las celdas en el rango.
setWrap(isWrapEnabled)RangeEstablece el ajuste de celda del rango determinado.
setWrapStrategies(strategies)RangeEstablece una cuadrícula rectangular de estrategias de ajuste.
setWrapStrategy(strategy)RangeEstablece la estrategia de ajuste de texto para las celdas del rango.
setWraps(isWrapEnabled)RangeEstablece una cuadrícula rectangular de políticas de ajuste de texto (debe coincidir con las dimensiones de este rango).
shiftColumnGroupDepth(delta)RangeCambia la profundidad de la agrupación de columnas del rango según la cantidad especificada.
shiftRowGroupDepth(delta)RangeCambia la profundidad de la agrupación de filas del rango según la cantidad especificada.
sort(sortSpecObj)RangeOrdena las celdas del rango determinado según la columna y el orden especificados.
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 usando la cadena especificada como delimitador personalizado.
splitTextToColumns(delimiter)voidDivide una columna de texto en varias columnas según el delimitador especificado.
trimWhitespace()RangeQuita los espacios en blanco (como espacios, tabulaciones o líneas nuevas) de cada celda de este rango.
uncheck()RangeCambia el estado de las casillas de verificación del rango a “sin marcar”.

Documentación detallada

activate()

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

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

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

Volver

Range: Es el rango para el encadenamiento.


activateAsCurrentCell()

Establece la celda especificada como current cell.

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

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

Nota: La Range especificada debe constar de una celda; de lo contrario, se arrojará una excepción.

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

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

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

addDeveloperMetadata(key)

Agrega metadatos para desarrolladores 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
keyStringEs la clave de los metadatos para desarrolladores nuevos.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

addDeveloperMetadata(key, visibility)

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

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

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

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

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

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

Parámetros

NombreTipoDescripción
keyStringEs la clave de los metadatos para desarrolladores nuevos.
visibilityDeveloperMetadataVisibilityEs la visibilidad de los metadatos del desarrollador nuevos.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

addDeveloperMetadata(key, value)

Agrega metadatos para desarrolladores 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
keyStringEs la clave de los metadatos para desarrolladores nuevos.
valueStringEs el valor de los metadatos del desarrollador nuevos.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

addDeveloperMetadata(key, value, visibility)

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

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

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

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

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

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

Parámetros

NombreTipoDescripción
keyStringEs la clave de los metadatos para desarrolladores nuevos.
valueStringEs el valor de los metadatos del desarrollador nuevos.
visibilityDeveloperMetadataVisibilityEs la visibilidad de los metadatos del desarrollador nuevos.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

applyColumnBanding()

Aplica un tema predeterminado de bandas de columnas al rango. De forma predeterminada, el banding tiene un encabezado y no tiene 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: Es la nueva banda.

Autorización

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

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

applyColumnBanding(bandingTheme)

Aplica un tema de bandas de columnas especificado al rango. De forma predeterminada, el banding tiene un color de encabezado y no tiene 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 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
bandingThemeBandingThemeEs un tema de color que se aplicará a las columnas del rango.

Volver

Banding: Es la nueva banda.

Autorización

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

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

applyColumnBanding(bandingTheme, showHeader, showFooter)

Aplica un tema de bandas de columnas 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
bandingThemeBandingThemeEs un 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: Es la nueva banda.

Autorización

Las secuencias de comandos que usan este método requieren 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 predeterminado de bandas de filas al rango. De forma predeterminada, el banding tiene un encabezado y no tiene 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: Es el banding.

Autorización

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

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

applyRowBanding(bandingTheme)

Aplica un tema de bandas de filas especificado al rango. De forma predeterminada, el banding tiene un encabezado y no tiene 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
bandingThemeBandingThemeEs un tema de color para aplicar a las filas del rango.

Volver

Banding: Es la nueva banda.

Autorización

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

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

applyRowBanding(bandingTheme, showHeader, showFooter)

Aplica un tema de bandas de filas especificado 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
bandingThemeBandingThemeEs un tema de color para aplicar a las filas del rango.
showHeaderBooleanSi es true, el color del encabezado del tema de la banda 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: Es la nueva banda.

Autorización

Las secuencias de comandos que usan este método requieren 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 basados en 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, el siguiente código completa A1:A20 con una serie de números crecientes basados en los valores actuales de A1:A4:

const sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
const sourceRange = sheet.getRange('A1:A4');
// The range to fill with values.
const 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
destinationRangeEs el rango que se autocompletará con valores. El rango de destino debe contener este rango y extenderlo en una sola dirección (hacia arriba, hacia abajo, hacia la izquierda o hacia la derecha).
seriesAutoFillSeriesEs el tipo de serie de autocompletado que se debe usar para calcular valores nuevos. El efecto de esta serie difiere según el tipo y la cantidad de datos de origen.

Autorización

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

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

autoFillToNeighbor(series)

Calcula un rango para completar con datos nuevos según las celdas vecinas y, luego, lo completa automáticamente con valores nuevos según los datos que contiene. Estos valores nuevos también se determinan según el tipo de series especificado.

El rango de destino calculado tiene en cuenta los datos circundantes para determinar dónde se deben insertar los valores nuevos: si hay datos inmediatamente a la izquierda o a la derecha de una columna que se está autocompletando, los valores nuevos solo se extienden hasta esos datos adyacentes.

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

const sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
const 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
seriesAutoFillSeriesEs el tipo de serie de autocompletado que se debe usar para calcular valores nuevos. El efecto de esta serie difiere según el tipo y la cantidad de datos de origen.

Autorización

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

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

breakApart()

Vuelve a dividir las celdas de varias columnas del rango en celdas individuales.

Llamar a esta función en un rango equivale a seleccionar un rango y hacer clic en Formato > Combinar celdas > Descombinar.

// 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: Es el rango para el encadenamiento.

Autorización

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

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

canEdit()

Determina si el usuario tiene permiso para editar cada celda del rango. El propietario de la hoja de cálculo siempre puede editar los rangos y las hojas 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: true si el usuario tiene permiso para editar cada celda del rango; false en caso contrario

Autorización

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

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

check()

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

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the range A1:B10 to 'checked'.
const range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

clear()

Borra el rango de contenido y formatos.

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

const range = sheet.getRange('A1:D10');
range.clear();

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

clear(options)

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

Parámetros avanzados

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

clearContent()

Borra el contenido del rango y deja el formato intacto.

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

const range = sheet.getRange('A1:D10');
range.clearContent();

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

clearDataValidations()

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

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

clearFormat()

Borra el formato de este rango.

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

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

const range = sheet.getRange('A1:D10');
range.clearFormat();

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

clearNote()

Borra la nota de la celda o las celdas especificadas.

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

const range = sheet.getRange('A1:D10');
range.clearNote();

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

collapseGroups()

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

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

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

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

Copia el formato del rango en la ubicación especificada. Si el destino es más grande o más pequeño que el rango de origen, el origen se repite o trunca según corresponda. Ten en cuenta que este método solo copia el formato.

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

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

const 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
gridIdIntegerEs el ID único de la hoja dentro de la hoja de cálculo, independientemente de su posición.
columnIntegerEs la primera columna del rango de destino.
columnEndIntegerEs la columna final del rango objetivo.
rowIntegerEs la fila inicial del rango de destino.
rowEndIntegerEs la fila final del rango de destino.

Autorización

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

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

Consulta también


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

Copia el formato del rango en la ubicación especificada. Si el destino es más grande o más pequeño que el rango de origen, el origen se repite o trunca según corresponda. Ten en cuenta que este método solo copia el formato.

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

const 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
sheetSheetEs la hoja de destino.
columnIntegerEs la primera columna del rango de destino.
columnEndIntegerEs la columna final del rango objetivo.
rowIntegerEs la fila inicial del rango de destino.
rowEndIntegerEs la fila final del rango de destino.

Autorización

Las secuencias de comandos que usan este método requieren 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 tanto los valores como el formato.

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

Parámetros

NombreTipoDescripción
destinationRangeEs el rango de destino al que se copiará. Solo es relevante la posición de la celda superior izquierda.

Autorización

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

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

copyTo(destination, copyPasteType, transposed)

Copia los datos de un rango de celdas a otro.

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

Parámetros

NombreTipoDescripción
destinationRangeEs el rango de destino al que se copiará. Solo es relevante la posición de la celda superior izquierda.
copyPasteTypeCopyPasteTypeEs un tipo que especifica cómo se pega el contenido del rango en el destino.
transposedBooleanIndica si el rango 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, se copian tanto los valores como el formato, pero esto se puede anular con argumentos avanzados.

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

Parámetros

NombreTipoDescripción
destinationRangeEs el rango de destino al que se copiará. Solo es relevante la posición de la celda superior izquierda.
optionsObjectEs un 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 especificada. Si el destino es más grande o más pequeño que el rango de origen, el origen se repite o trunca según corresponda.

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

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

const 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
gridIdIntegerEs el ID único de la hoja dentro de la hoja de cálculo, independientemente de su posición.
columnIntegerEs la primera columna del rango de destino.
columnEndIntegerEs la columna final del rango objetivo.
rowIntegerEs la fila inicial del rango de destino.
rowEndIntegerEs la fila final del rango de destino.

Autorización

Las secuencias de comandos que usan este método requieren 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 especificada. Si el destino es más grande o más pequeño que el rango de origen, el origen se repite o trunca según corresponda.

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

const 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
sheetSheetEs la hoja de destino.
columnIntegerEs la primera columna del rango de destino.
columnEndIntegerEs la columna final del rango objetivo.
rowIntegerEs la fila inicial del rango de destino.
rowEndIntegerEs la fila final del rango de destino.

Autorización

Las secuencias de comandos que usan este método requieren 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 vacía de la fuente de datos, anclada en la primera celda de este rango.

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

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

const 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
dataSourceDataSourceEs la fuente de datos a partir de la cual se creará la tabla dinámica.

Volver

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

Autorización

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

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

createDataSourceTable(dataSource)

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

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

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

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

Parámetros

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

Volver

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

Autorización

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

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

createDeveloperMetadataFinder()

Devuelve un DeveloperMetadataFinderApi para encontrar metadatos para desarrolladores 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 sí 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: Es un buscador de metadatos del desarrollador para buscar metadatos en el alcance de este rango.


createFilter()

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

const ss = SpreadsheetApp.getActiveSheet();
const 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() {
  const filter = range.getFilter();
  const criteria =
      SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
  filter.setColumnFilterCriteria(2, criteria);
}
Usa este método para crear filtros para las hojas de Grid, el tipo de hoja predeterminado. Las hojas de cuadrícula son hojas que no están conectadas a una base de datos. Para crear otros tipos de filtros, consulta lo siguiente:

Volver

Filter: Es el filtro nuevo.

Autorización

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

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

createPivotTable(sourceData)

Crea una tabla dinámica vacía a partir del sourceData especificado, anclada 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
sourceDataRangeSon los datos a partir de los cuales se creará la tabla dinámica.

Volver

PivotTable: Es el PivotTable recién creado.

Autorización

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

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

createTextFinder(findText)

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

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

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

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

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

Parámetros

NombreTipoDescripción
findTextStringEs el texto que se buscará.

Volver

TextFinder: El TextFinder del rango


deleteCells(shiftDimension)

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

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

const range = sheet.getRange('A1:D10');
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

Parámetros

NombreTipoDescripción
shiftDimensionDimensionEs la dimensión a lo largo de la cual se desplazan los datos existentes.

Autorización

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

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

expandGroups()

Expande los grupos contraídos cuyo rango o botón de activación de control se interseca con este rango. La ubicación del botón de activación del control es el índice en el que se muestra el botón de activación del control, inmediatamente 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 menos profundo.

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

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

getA1Notation()

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

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

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

Volver

String: Es la descripción de cadena 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()

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

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

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

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

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

Volver

Color: Es 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()

Devuelve los colores de fondo de las celdas del rango.

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgroundObjects();
for (const i in bgColors) {
  for (const 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()

Devuelve los colores de fondo de las celdas del rango (por ejemplo, '#ffffff').

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgrounds();
for (const i in bgColors) {
  for (const 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()

Devuelve todas las bandas que se aplican a las celdas 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 (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Volver

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

Autorización

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

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

getCell(row, column)

Devuelve una celda determinada dentro de un rango.

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

const 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
const cell = range.getCell(1, 1);
Logger.log(cell.getValue());

Parámetros

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

Volver

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

Autorización

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

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

getColumn()

Devuelve la posición de la columna inicial de este rango.

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

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

Volver

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

Autorización

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

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

getDataRegion()

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

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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: Es 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)

Devuelve 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 están organizados 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 a lo largo de la dimensión especificada, se devuelve 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.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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
dimensionDimensionDimensión a lo largo de la cual se expande el rango.

Volver

Range: Es 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()

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

Devuelve los valores de DataSourceFormula para 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 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

getDataSourceTables()

Obtiene todas las tablas 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 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()

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

Code.gs

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

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

piechart.html

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

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

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

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

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

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

Volver

String: Es una URL para este rango como fuente de datos que se puede pasar a otras APIs, como las de 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()

Devuelve los datos dentro de este objeto como un objeto DataTable.

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

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

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

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

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

Volver

DataTable: Los datos como una tabla de datos.


getDataTable(firstRowIsHeader)

Devuelve los datos dentro de este rango como un objeto DataTable.

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

// Calling this method with "true" sets the first line to be the title of the
// axes
const 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.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Title Here')
                  .build();

Parámetros

NombreTipoDescripción
firstRowIsHeaderBooleanIndica si se debe tratar la primera fila como 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()

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

// Log information about the data validation rule for cell A1.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const 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: Es 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()

Devuelve las reglas de validación de datos para todas las celdas del rango. Si no se configuró la validación de datos en una celda determinada, este método devuelve 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.
const oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
const newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
const rules = range.getDataValidations();

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

    if (rule != null) {
      const criteria = rule.getCriteriaType();
      const 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 con las celdas del rango.

Autorización

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

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

getDeveloperMetadata()

Obtiene los metadatos de 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 de desarrollador asociados a 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()

Devuelve el valor que se muestra en la celda superior izquierda del rango. El valor es String. El valor que se muestra tiene en cuenta el formato de fecha, hora y moneda, incluidos los formatos que se aplican automáticamente según la configuración regional de la hoja de cálculo. Las celdas vacías devuelven una cadena 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()

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

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

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

Volver

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

Autorización

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

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

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Gets the existing filter on the sheet that the given range belongs to.
const 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()

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

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

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

Volver

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

Devuelve los colores de fuente de las celdas del rango.

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

const results = range.getFontColorObjects();

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

Volver

Color[][]: Es un array bidimensional de colores de fuente asociados 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

getFontFamilies()

Devuelve las familias de fuentes de las celdas del rango.

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

const results = range.getFontFamilies();

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

Volver

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

getFontFamily()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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').

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

Logger.log(range.getFontLine());

Volver

String: Es la línea de la 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').

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

const results = range.getFontLines();

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

Volver

String[][]: Es un array bidimensional de líneas de fuentes 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

getFontSize()

Devuelve el tamaño de fuente en puntos de la celda ubicada en la esquina superior izquierda del rango.

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

Logger.log(range.getFontSize());

Volver

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

Autorización

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

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

getFontSizes()

Devuelve los tamaños de fuente de las celdas del rango.

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

const results = range.getFontSizes();

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

Volver

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

getFontStyle()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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()

Devuelve los estilos de fuente de las celdas del rango.

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

const results = range.getFontStyles();

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

Volver

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

getFontWeight()

Devuelve el grosor de la fuente (normal o negrita) de la celda ubicada en la esquina superior izquierda del rango.

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

Logger.log(range.getFontWeight());

Volver

String: Es 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()

Devuelve los pesos de fuente de las celdas del rango.

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

const results = range.getFontWeights();

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

Volver

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

getFormula()

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

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

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

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

Volver

String: Es la fórmula de la celda.

Autorización

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

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

getFormulaR1C1()

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

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

const range = sheet.getRange('B5');
const formula = range.getFormulaR1C1();
Logger.log(formula);

Volver

String: Es 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()

Devuelve las fórmulas (notación A1) de las celdas del rango. Las entradas de la matriz bidimensional son cadenas vacías para las celdas sin fórmula.

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

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

Volver

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

Autorización

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

Devuelve las fórmulas (notación R1C1) de las celdas del rango. Las entradas de la matriz 2D son null para las celdas sin fórmula.

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

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

Volver

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

Autorización

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

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

getGridId()

Devuelve el ID de cuadrícula de la hoja principal del rango. Los IDs son valores int no negativos aleatorios.

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

Logger.log(range.getGridId());

Volver

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

Autorización

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

Devuelve la altura del rango.

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

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

Volver

Integer: Es la altura del rango.

Autorización

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

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

getHorizontalAlignment()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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()

Devuelve las alineaciones horizontales de las celdas en el rango.

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

const results = range.getHorizontalAlignments();

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

Volver

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

getLastColumn()

Devuelve la posición de la columna final.

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

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

Devuelve la posición de la fila final.

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

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

Devuelve un array de objetos Range que representan celdas combinadas que se encuentran completamente dentro del rango actual o que contienen al menos una celda en el rango actual.

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

const range = sheet.getRange('A1:B3');

const mergedRanges = range.getMergedRanges();
for (let 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 representan las celdas combinadas que se superponen con el rango.


getNextDataCell(direction)

A partir de la celda de la primera columna y fila del rango, devuelve la siguiente celda en la dirección indicada 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.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

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

Parámetros

NombreTipoDescripción
directionDirectionEs la dirección en la que se debe buscar la siguiente celda de borde de la región de datos.

Volver

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

Autorización

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

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

getNote()

Devuelve la nota asociada con el rango determinado.

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

Logger.log(range.getNote());

Volver

String: Es la nota asociada a 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()

Devuelve las notas asociadas a las celdas del rango.

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

const results = range.getNotes();

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

Volver

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

getNumColumns()

Devuelve la cantidad de columnas en este rango.

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumColumns());

Volver

Integer: Es la cantidad de columnas en este rango.

Autorización

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

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

getNumRows()

Devuelve la cantidad de filas en este rango.

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumRows());

Volver

Integer: Es la cantidad de filas en este rango.

Autorización

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

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

getNumberFormat()

Obtiene el formato de número o fecha de la celda superior izquierda del rango determinado. Los patrones de formato que se muestran se describen en la documentación de la API de Sheets.

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

const cell = sheet.getRange('C4');
Logger.log(cell.getNumberFormat());

Volver

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

Autorización

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

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

getNumberFormats()

Devuelve los formatos de número o fecha de las celdas del rango. Los patrones de formato que se devuelven se describen en la documentación de la API de Sheets.

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

const range = sheet.getRange('B5:C6');
const formats = range.getNumberFormats();
for (const i in formats) {
  for (const 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()

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

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

Volver

RichTextValue: Es el valor de texto enriquecido de la celda superior izquierda del 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()

Devuelve los valores de texto enriquecido de las celdas del rango.

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

for (let i = 0; i < values.length; i++) {
  for (let 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()

Devuelve la posición de la fila para este rango. Es idéntico a getRowIndex().

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

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

Devuelve la posición de la fila para este rango. Es idéntico a getRow().

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

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

Devuelve 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: Es la hoja a la que pertenece este rango.

Autorización

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

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

getTextDirection()

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

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

Volver

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

Devuelve las direcciones de texto para las celdas del rango. Las entradas de la matriz 2D son null para las celdas que usan la detección automática.

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

for (let i = 0; i < directions.length; i++) {
  for (let 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()

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

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

const cell = sheet.getRange('A1');
Logger.log(cell.getTextRotation());

Volver

TextRotation: Es la configuración de rotación del 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()

Devuelve la configuración de rotación del texto para las celdas del rango.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

const results = range.getTextRotations();

for (const i in results) {
  for (const j in results[i]) {
    const 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 con las celdas del rango.

Autorización

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

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

getTextStyle()

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

// Get the text style of cell D4.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const 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()

Devuelve los estilos de texto de las celdas del rango.

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

for (let i = 0; i < styles.length; i++) {
  for (let 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()

Devuelve el valor de la celda superior izquierda del rango. El valor puede ser de tipo Number, Boolean, Date o String según el valor de la celda. Las celdas vacías devuelven una cadena 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: Es el valor de esta celda.

Autorización

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

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

getValues()

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

Devuelve un array bidimensional de valores, 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 cadena vacía en el array. Recuerda que, si bien un índice de rango comienza en 1, 1, el arreglo de JavaScript se indexa a partir de [0][0].

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

Volver

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

Autorización

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

Devuelve la alineación vertical (superior, central o inferior) de la celda en la esquina superior izquierda del rango.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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()

Devuelve las alineaciones verticales de las celdas en el rango.

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

const results = range.getVerticalAlignments();

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

Volver

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

getWidth()

Devuelve 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: Es la cantidad de columnas en el rango.

Autorización

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

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

getWrap()

Devuelve un valor que indica si el texto de la celda se ajusta. Para obtener una estrategia de envoltorio más detallada, usa getWrapStrategy().

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

Logger.log(range.getWrap());

Volver

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

Autorización

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

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

getWrapStrategies()

Devuelve las estrategias de ajuste de texto para las celdas del rango.

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

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

Volver

WrapStrategy[][]: Es un array bidimensional de estrategias de unió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

getWrapStrategy()

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

// Get the text wrapping strategy of cell B1.
const sheet = SpreadsheetApp.getActiveSheet();
const 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()

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

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

const results = range.getVerticalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    const 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 del texto asociado 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

insertCells(shiftDimension)

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

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

const range = sheet.getRange('A1:D10');
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

Parámetros

NombreTipoDescripción
shiftDimensionDimensionEs la dimensión a lo largo de la cual se desplazan los datos existentes.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

insertCheckboxes()

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

const 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: Es el rango para el encadenamiento.

Autorización

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

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

insertCheckboxes(checkedValue)

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

const 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
checkedValueObjectEs el valor seleccionado para la validación de datos de la casilla de verificación.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

insertCheckboxes(checkedValue, uncheckedValue)

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

const 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
checkedValueObjectEs el valor seleccionado para la validación de datos de la casilla de verificación.
uncheckedValueObjectEs el valor sin seleccionar para la validación de datos de la casilla de verificación.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

isBlank()

Devuelve true si el rango está completamente en blanco.

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

Logger.log(range.isBlank());

Volver

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

Devuelve si todas las celdas del rango tienen el estado de la casilla de verificación como "checked". Devuelve null si algunas celdas están marcadas y el resto no, o si algunas celdas no tienen validación de datos de casillas de verificación.

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

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

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

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

const range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox
// value.
const 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 validación de datos de casilla de verificació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

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 devuelve true; para los rangos 3:7 o A1:5, que están vinculados solo a filas particulares al final del rango, este método devuelve 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: true si el final del rango está vinculado a una columna en particular; false en otros casos

Autorización

Las secuencias de comandos que usan este método requieren 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 devuelve true; para los rangos B:B o A1:C, que solo están vinculados a columnas específicas al final del rango, este método devuelve 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 — 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()

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

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

const range = sheet.getRange('A1:B3');

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

Volver

Boolean: true si el rango se superpone con alguna celda combinada; de lo contrario, devuelve 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 devuelve true; para el rango 3:7, que está vinculado solo a una fila al comienzo del rango, este método devuelve 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 – true si el inicio del rango está vinculado a una columna en particular; false en otros casos.

Autorización

Las secuencias de comandos que usan este método requieren 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 inicio del rango, este método devuelve true; para el rango B:B, que está vinculado solo a una columna en particular al inicio del rango, este método devuelve 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: true si el inicio del rango está vinculado a una fila en particular; false en caso contrario

Autorización

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

const sheet = SpreadsheetApp.getActiveSheet();

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

mergeAcross()

Combina las celdas del rango en las columnas del rango.

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

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

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

mergeVertically()

Combina las celdas del rango.

const 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: Es el rango para el encadenamiento.

Autorización

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

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

moveTo(target)

Corta y pega (tanto el formato como los valores) de este rango al rango de destino.

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

Parámetros

NombreTipoDescripción
targetRangeEs un rango 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)

Devuelve un rango nuevo que se desplaza desde este rango según la cantidad de filas y columnas proporcionada (que puede ser negativa). El rango nuevo tiene el mismo tamaño que el original.

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

const cell = sheet.getRange('A1');

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

Parámetros

NombreTipoDescripción
rowOffsetIntegerCantidad de filas hacia abajo desde la celda superior izquierda del rango. Los valores negativos representan filas hacia arriba desde la celda superior izquierda del rango.
columnOffsetIntegerCantidad de columnas a la derecha de la celda superior izquierda del rango. Los valores negativos representan columnas a la izquierda de la celda superior izquierda del rango.

Volver

Range: Es el rango para el encadenamiento.


offset(rowOffset, columnOffset, numRows)

Devuelve un rango nuevo que es 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 celdas.

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

const cell = sheet.getRange('A1');

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

Parámetros

NombreTipoDescripción
rowOffsetIntegerCantidad de filas hacia abajo desde la celda superior izquierda del rango. Los valores negativos representan filas hacia arriba desde la celda superior izquierda del rango.
columnOffsetIntegerCantidad de columnas a la derecha de la celda superior izquierda del rango. Los valores negativos representan columnas a la izquierda de la celda superior izquierda del rango.
numRowsIntegerEs la altura en filas del rango nuevo.

Volver

Range: Es el rango para el encadenamiento.


offset(rowOffset, columnOffset, numRows, numColumns)

Devuelve un rango nuevo que es relativo al rango actual, cuyo punto superior izquierdo se desplaza desde el rango actual según las filas y columnas proporcionadas, y con la altura y el ancho proporcionados en celdas.

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

const cell = sheet.getRange('A1');

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

Parámetros

NombreTipoDescripción
rowOffsetIntegerCantidad de filas hacia abajo desde la celda superior izquierda del rango. Los valores negativos representan filas hacia arriba desde la celda superior izquierda del rango.
columnOffsetIntegerCantidad de columnas a la derecha de la celda superior izquierda del rango. Los valores negativos representan columnas a la izquierda de la celda superior izquierda del rango.
numRowsIntegerEs la altura en filas del rango nuevo.
numColumnsIntegerAncho en columnas del rango nuevo.

Volver

Range: Es el rango para el encadenamiento.


protect()

Crea un objeto que puede proteger el rango para que no se edite, excepto por los usuarios que tienen permiso. Hasta que la secuencia de comandos cambie realmente la lista de editores del rango (llamando a Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) o configurando un nuevo valor 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 nuevo rango protegido que se superpone con el existente. Si una celda está protegida por varios rangos protegidos y cualquiera de ellos impide que un usuario en particular edite la celda, ese usuario no podrá editarla.

// Protect range A1:B10, then remove all other users from the list of editors.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const 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.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Volver

Protection: 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 determinado.

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

// Randomizes the range
range.randomize();

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

removeCheckboxes()

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

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

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

const range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

const 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: Es el rango para el encadenamiento.

Autorización

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

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

removeDuplicates()

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

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

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

Volver

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

Autorización

Las secuencias de comandos que usan este método requieren 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. Las filas con valores idénticos, pero con un patrón de mayúsculas, un formato o fórmulas diferentes se consideran duplicados. Este método también quita las filas duplicadas ocultas en la vista (por ejemplo, debido a un filtro). El contenido fuera de este rango no se quita.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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[]Son las columnas que se analizarán para detectar valores duplicados. Si no se proporcionan columnas, se analizan todas las columnas en busca de duplicados.

Volver

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

Autorización

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

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

const range = sheet.getRange('B2:D5');
range.setBackground('red');

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setBackgroundObject(color)

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

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

const range = sheet.getRange('B2:D5');
range.setBackgroundObject(bgColor);

Parámetros

NombreTipoDescripción
colorColorColor de fondo que se establecerá. El valor null restablece el color de fondo.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setBackgroundObjects(color)

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

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

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

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

const 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: Es el rango para el encadenamiento.

Autorización

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

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

setBackgroundRGB(red, green, blue)

Establece el fondo con el color determinado usando valores RGB (números enteros entre 0 y 255, inclusive).

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

const cell = sheet.getRange('B2');

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

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

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setBackgrounds(color)

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

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

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

const cell = sheet.getRange('B5:D6');
cell.setBackgrounds(colors);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

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

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

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

const 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 borde, false para ninguno y null para sin cambios.
leftBooleantrue para borde, false para ninguno y null para sin cambios.
bottomBooleantrue para borde, false para ninguno y null para sin cambios.
rightBooleantrue para borde, false para ninguno y null para sin cambios.
verticalBooleantrue para los bordes verticales internos, false para ninguno y null para sin cambios.
horizontalBooleantrue para bordes horizontales internos, false para ninguno y null para sin cambios.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

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

Establece la propiedad de borde con color o estilo. Los valores válidos son true (activado), false (desactivado) y null (sin cambios). Para el color, usa Color en la notación CSS (como '#ffffff' o 'white').

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

const 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 borde, false para ninguno y null para sin cambios.
leftBooleantrue para borde, false para ninguno y null para sin cambios.
bottomBooleantrue para borde, false para ninguno y null para sin cambios.
rightBooleantrue para borde, false para ninguno y null para sin cambios.
verticalBooleantrue para los bordes verticales internos, false para ninguno y null para sin cambios.
horizontalBooleantrue para bordes horizontales internos, false para ninguno y null para sin cambios.
colorStringUn color en notación CSS (como '#ffffff' o 'white'), null para el color predeterminado (negro).
styleBorderStyleEs un estilo para los bordes, null para el estilo predeterminado (sólido).

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setDataValidation(rule)

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

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

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setDataValidations(rules)

Establece las reglas de validación de datos para todas las celdas del rango. Este método toma un 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.
const destinationRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
const sourceRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
const rules = destinationRange.getDataValidations();
for (let i = 0; i < rules.length; i++) {
  for (let j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontColor(color)

Establece el color de la fuente en notación CSS (como '#ffffff' o 'white').

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

const cell = sheet.getRange('B2');
cell.setFontColor('red');

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontColorObject(color)

Establece el color de fuente del rango determinado.

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

const cell = sheet.getRange('B2');
cell.setFontColor(color);

Parámetros

NombreTipoDescripción
colorColorColor de fuente que se establecerá. Un valor null restablece el color.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontColorObjects(colors)

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

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

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

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

const cell = sheet.getRange('B5:C6');
cell.setFontColorObjects(colors);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontColors(colors)

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

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

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

const cell = sheet.getRange('B5:D6');
cell.setFontColors(colors);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontFamilies(fontFamilies)

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

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

const fonts = [
  ['Arial', 'Helvetica', 'Verdana'],
  ['Courier New', 'Arial', 'Helvetica'],
];

const cell = sheet.getRange('B2:D3');
cell.setFontFamilies(fonts);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontFamily(fontFamily)

Establece la familia de fuentes, como "Arial" o "Helvetica".

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

const cell = sheet.getRange('B2');
cell.setFontFamily('Helvetica');

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontLine(fontLine)

Establece el estilo de línea de la fuente del rango determinado ('underline', 'line-through' o 'none').

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

const cell = sheet.getRange('B2');
cell.setFontLine('line-through');

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontLines(fontLines)

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

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

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

const range = sheet.getRange('B2:D2');
range.setFontLines(fontLines);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontSize(size)

Establece el tamaño de la fuente, que es el tamaño en puntos que se usará.

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

const cell = sheet.getRange('B2');
cell.setFontSize(20);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontSizes(sizes)

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

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

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

const range = sheet.getRange('B2:D2');
range.setFontSizes(fontSizes);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontStyle(fontStyle)

Establece el estilo de fuente para el rango determinado ('italic' o 'normal').

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

const cell = sheet.getRange('B2');
cell.setFontStyle('italic');

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontStyles(fontStyles)

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

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

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

const range = sheet.getRange('B2:C2');
range.setFontStyles(fontStyles);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontWeight(fontWeight)

Establece el grosor de la fuente para el rango determinado (normal o negrita).

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

const cell = sheet.getRange('B2');
cell.setFontWeight('bold');

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFontWeights(fontWeights)

Establece una cuadrícula rectangular de pesos de fuente (debe coincidir con las dimensiones de este rango). Un ejemplo de peso de fuente es "negrita".

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

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

const range = sheet.getRange('B2:D2');
range.setFontWeights(fontStyles);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFormula(formula)

Actualiza la fórmula de este rango. La fórmula proporcionada debe estar en notación A1.

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

const cell = sheet.getRange('B5');
cell.setFormula('=SUM(B3:B4)');

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFormulaR1C1(formula)

Actualiza la fórmula de este rango. La fórmula proporcionada debe estar en notación R1C1.

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

const 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
formulaStringEs una fórmula de cadena.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFormulas(formulas)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.
const formulas = [
  ['=SUM(B2:B4)', '=SUM(C2:C4)', '=SUM(D2:D4)'],
  ['=AVERAGE(B2:B4)', '=AVERAGE(C2:C4)', '=AVERAGE(D2:D4)'],
];

const cell = sheet.getRange('B5:D6');
cell.setFormulas(formulas);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setFormulasR1C1(formulas)

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

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

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

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

const 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[][]Es un array bidimensional de fórmulas en formato R1C1.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setHorizontalAlignment(alignment)

Establece la alineación horizontal (de izquierda a derecha) para el rango determinado (izquierda/centro/derecha).

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

const 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: Es el rango para el encadenamiento.

Autorización

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

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

setHorizontalAlignments(alignments)

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

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

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

const range = sheet.getRange('B2:D2');
range.setHorizontalAlignments(horizontalAlignments);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

Consulta también


setNote(note)

Establece la nota en el valor determinado.

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

const cell = sheet.getRange('B2');
cell.setNote('This is a note');

Parámetros

NombreTipoDescripción
noteStringValor de la nota que se establecerá para el rango. Un valor de null quita la nota.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setNotes(notes)

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

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

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

const cell = sheet.getRange('B2:D3');
cell.setNotes(notes);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

Consulta también


setNumberFormat(numberFormat)

Establece el formato de número o fecha en la cadena de formato determinada. Los patrones de formato aceptados se describen en la documentación de la API de Sheets.

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

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

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setNumberFormats(numberFormats)

Establece una cuadrícula rectangular de formatos de número o fecha (debe coincidir con las dimensiones de este rango). Los valores son cadenas de patrones de formato, como se describe en la documentación de la API de Sheets.

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

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

const range = sheet.getRange('B2:D2');
range.setNumberFormats(formats);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setRichTextValue(value)

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

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

Parámetros

NombreTipoDescripción
valueRichTextValueEs el valor de texto enriquecido deseado.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setRichTextValues(values)

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

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

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

Establece si el rango debe mostrar hipervínculos.

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

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

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

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

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setTextDirection(direction)

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

// Sets right-to-left text direction for the range.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setTextDirections(directions)

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

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

range2.setTextRotations(range1.getTextDirections());

Parámetros

NombreTipoDescripción
directionsTextDirection[][]Son las direcciones de texto deseadas. Si una dirección especificada es null, se infiere antes de establecerse.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setTextRotation(degrees)

Establece la configuración de rotación del texto para 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 se encuentran en el sentido contrario a las manecillas del reloj, mientras que, para la dirección de derecha a izquierda, se encuentran en el sentido de las manecillas del reloj.

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setTextRotation(45);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setTextRotation(rotation)

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

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

const rotation = sheet.getRange('A1').getTextRotation();

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

Parámetros

NombreTipoDescripción
rotationTextRotationEs la configuración de rotación de texto deseada.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setTextRotations(rotations)

Establece una cuadrícula rectangular de rotaciones de texto.

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

range2.setTextRotations(range1.getTextRotations());

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setTextStyle(style)

Establece el estilo de texto para las celdas del rango.

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

Parámetros

NombreTipoDescripción
styleTextStyleEs el estilo de texto deseado.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setTextStyles(styles)

Establece una cuadrícula rectangular de estilos de texto.

// Sets text styles for cells in range A1:B2
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const 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[][]Son los estilos de texto deseados.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setValue(value)

Establece el valor del rango. El valor puede ser numérico, de cadena, booleano o de fecha. Si comienza con '=', se interpreta como una fórmula.

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

const cell = sheet.getRange('B2');
cell.setValue(100);

Parámetros

NombreTipoDescripción
valueObjectEs el valor del rango.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setValues(values)

Establece una cuadrícula rectangular de valores (debe coincidir con las dimensiones de este rango). Si un valor comienza con =, se interpreta como una fórmula.

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

// The size of the two-dimensional array must match the size of the range.
const values = [['2.000', '1,000,000', '$2.99']];

const range = sheet.getRange('B2:D2');
range.setValues(values);

Parámetros

NombreTipoDescripción
valuesObject[][]Es un array bidimensional de valores.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setVerticalAlignment(alignment)

Establece la alineación vertical (de arriba hacia abajo) para el rango determinado (arriba, medio o abajo).

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

const 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: Es el rango para el encadenamiento.

Autorización

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

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

setVerticalAlignments(alignments)

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

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

// The size of the two-dimensional array must match the size of the range.
const alignments = [['top', 'middle', 'bottom']];

const range = sheet.getRange('B2:D2');
range.setVerticalAlignments(alignments);

Parámetros

NombreTipoDescripción
alignmentsObject[][]Es un array bidimensional de alineaciones, ya sea 'top', 'middle' o 'bottom'. Un valor null restablece la alineación.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

Consulta también


setVerticalText(isVertical)

Establece si se debe apilar el texto de las celdas en el rango. Si el texto se apila verticalmente, se ignora el parámetro de configuración de rotación de texto en grados.

// Sets all cell's in range B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setVerticalText(true);

Parámetros

NombreTipoDescripción
isVerticalBooleanIndica si se debe apilar el texto.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setWrap(isWrapEnabled)

Establece el ajuste de celda del rango determinado.

Las celdas con el ajuste habilitado (la configuración predeterminada) cambian de tamaño para mostrar todo su contenido. Las celdas con el ajuste desactivado muestran la mayor cantidad de contenido posible sin cambiar de tamaño ni ocupar varias líneas.

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

const cell = sheet.getRange('B2');
cell.setWrap(true);

Parámetros

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setWrapStrategies(strategies)

Establece una cuadrícula rectangular de estrategias de ajuste.

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setWrapStrategies(range1.getWrapStrategies());

Parámetros

NombreTipoDescripción
strategiesWrapStrategy[][]Son las estrategias de ajuste deseadas.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setWrapStrategy(strategy)

Establece la estrategia de ajuste de texto para las celdas del rango.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Parámetros

NombreTipoDescripción
strategyWrapStrategyEs la estrategia de ajuste deseada.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

setWraps(isWrapEnabled)

Establece una cuadrícula rectangular de políticas de ajuste de texto (debe coincidir con las dimensiones de este rango). Las celdas con el ajuste habilitado (la configuración predeterminada) cambian de tamaño para mostrar todo su contenido. Las celdas con el ajuste desactivado muestran la mayor cantidad posible de contenido sin cambiar de tamaño ni ocupar varias líneas.

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

// The size of the two-dimensional array must match the size of the range.
const wraps = [[true, true, false]];

const range = sheet.getRange('B2:D2');
range.setWraps(wraps);

Parámetros

NombreTipoDescripción
isWrapEnabledObject[][]Es un array bidimensional de variables de ajuste que determinan si se ajusta el texto en una celda o no.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

Consulta también


shiftColumnGroupDepth(delta)

Cambia la profundidad de la agrupación de columnas del rango según la cantidad especificada.

Esto tiene el efecto de crear, modificar o borrar grupos que se intersecan con el rango. En el caso de los deltas positivos, se crean o modifican grupos; en el caso de los deltas negativos, se destruyen o modifican grupos.

Esto no tiene efecto cuando se disminuye la profundidad del grupo por debajo de cero o por encima de ocho.

Si column group control position es BEFORE, se genera un error cuando se intenta cambiar la profundidad de la primera fila.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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
deltaIntegerCantidad en la que se debe cambiar la profundidad del grupo de columnas de este rango.

Volver

Range: Es el rango para el encadenamiento.

Arroja

Error: Cuando se intenta cambiar la profundidad de la primera columna cuando la posición de control es GroupControlTogglePosition.BEFORE

Autorización

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

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

shiftRowGroupDepth(delta)

Cambia la profundidad de la agrupación de filas del rango según la cantidad especificada.

Esto tiene el efecto de crear, modificar o borrar grupos que se intersecan con el rango. En el caso de los deltas positivos, se crean o modifican grupos; en el caso de los deltas negativos, se destruyen o modifican grupos.

Esto no tiene efecto cuando se disminuye la profundidad del grupo por debajo de cero o por encima de ocho.

Si row group control position es BEFORE, se genera un error cuando se intenta cambiar la profundidad de la primera fila.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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
deltaIntegerCantidad en la que se cambiará la profundidad del grupo de filas de este rango.

Volver

Range: Es el rango para el encadenamiento.

Arroja

Error: Cuando se intenta cambiar la profundidad de la primera fila cuando la posición del control es GroupControlTogglePosition.BEFORE

Autorización

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

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

sort(sortSpecObj)

Ordena las celdas del rango determinado según la columna y el orden especificados.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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
sortSpecObjObjectSon las columnas por las que se ordenará.

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

splitTextToColumns()

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

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns();

// Result after splitting 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 usando la cadena 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|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns('#');

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Parámetros

NombreTipoDescripción
delimiterStringEs el delimitador personalizado para 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|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Parámetros

NombreTipoDescripción
delimiterTextToColumnsDelimiterEs el delimitador predeterminado para 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()

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

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

range.trimWhitespace();

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

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

uncheck()

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

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the range A1:B10 to 'unchecked'.
const range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

Volver

Range: Es el rango para el encadenamiento.

Autorización

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

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

Métodos obsoletos