Permite acceder a rangos de la hoja de cálculo y modificarlos. Un rango puede ser una sola celda en una hoja o un grupo de celdas adyacentes de una hoja.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
activate() | Range | Establece el rango especificado como active range , con la parte superior.
celda izquierda del rango como current cell . |
activateAsCurrentCell() | Range | Establece la celda especificada como current cell . |
addDeveloperMetadata(key) | Range | Agrega metadatos del desarrollador con la clave especificada al rango. |
addDeveloperMetadata(key, visibility) | Range | Agrega metadatos del desarrollador con la clave y la visibilidad especificadas al rango. |
addDeveloperMetadata(key, value) | Range | Agrega metadatos del desarrollador con la clave y el valor especificados al rango. |
addDeveloperMetadata(key, value, visibility) | Range | Agrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados al rango. |
applyColumnBanding() | Banding | Aplica un tema de bandas de columnas predeterminado al rango. |
applyColumnBanding(bandingTheme) | Banding | Aplica un tema de banda de columnas específico al rango. |
applyColumnBanding(bandingTheme, showHeader, showFooter) | Banding | Aplica un tema de banda de columnas específico al rango con el encabezado y el pie de página especificados configuración. |
applyRowBanding() | Banding | Aplica un tema predeterminado de banda de filas al rango. |
applyRowBanding(bandingTheme) | Banding | Aplica un tema de banda de filas específico al rango. |
applyRowBanding(bandingTheme, showHeader, showFooter) | Banding | Aplica un tema específico de banda de filas al rango con la configuración especificada de encabezado y pie de página. |
autoFill(destination, series) | void | Completa el destinationRange con datos basados en los datos de este rango. |
autoFillToNeighbor(series) | void | Calcula un rango para completar con datos nuevos en función de celdas vecinas y rellena automáticamente que varían con valores nuevos basados en los datos contenidos en ese rango. |
breakApart() | Range | Vuelve a dividir en celdas individuales las celdas de varias columnas del rango. |
canEdit() | Boolean | Determina si el usuario tiene permiso para editar todas las celdas del rango. |
check() | Range | Cambia el estado de las casillas de verificación del rango a “marcado”. |
clear() | Range | Borra el rango de contenido y formatos. |
clear(options) | Range | Borra el rango de contenidos, el formato, las reglas de validación de datos o los comentarios, como se especifica con las opciones avanzadas indicadas. |
clearContent() | Range | Borra el contenido del rango y deja el formato intacto. |
clearDataValidations() | Range | Borra las reglas de validación de datos del rango. |
clearFormat() | Range | Borra el formato de este rango. |
clearNote() | Range | Borra la nota en una o varias celdas específicas. |
collapseGroups() | Range | Contrae todos los grupos contenidos por completo dentro del rango. |
copyFormatToRange(gridId, column, columnEnd, row, rowEnd) | void | Copia el formato del rango en la ubicación especificada. |
copyFormatToRange(sheet, column, columnEnd, row, rowEnd) | void | Copia el formato del rango en la ubicación especificada. |
copyTo(destination) | void | Copia los datos de un rango de celdas a otro rango de celdas. |
copyTo(destination, copyPasteType, transposed) | void | Copia los datos de un rango de celdas a otro rango de celdas. |
copyTo(destination, options) | void | Copia los datos de un rango de celdas a otro rango de celdas. |
copyValuesToRange(gridId, column, columnEnd, row, rowEnd) | void | Copia el contenido del rango en la ubicación especificada. |
copyValuesToRange(sheet, column, columnEnd, row, rowEnd) | void | Copia el contenido del rango en la ubicación especificada. |
createDataSourcePivotTable(dataSource) | DataSourcePivotTable | Crea una tabla dinámica de fuente de datos vacía a partir de la fuente de datos, anclada en la primera celda de este rango. |
createDataSourceTable(dataSource) | DataSourceTable | Crea una tabla de fuente de datos vacía a partir de la fuente de datos, anclada en la primera celda de esta del rango de destino de la ruta. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Muestra una DeveloperMetadataFinderApi para encontrar metadatos del desarrollador dentro del alcance de este. del rango de destino de la ruta. |
createFilter() | Filter | Crea un filtro y lo aplica al rango especificado en la hoja. |
createPivotTable(sourceData) | PivotTable | Crea una tabla dinámica vacía a partir del sourceData especificado anclado en la primera celda
en este rango. |
createTextFinder(findText) | TextFinder | Crea un buscador de texto para el intervalo, que puede buscar y reemplazar texto. |
deleteCells(shiftDimension) | void | Elimina este rango de celdas. |
expandGroups() | Range | Expande los grupos contraídos cuyo rango o botón de activación de control se cruza con este rango. |
getA1Notation() | String | Muestra una descripción de cadena del rango, en notación A1. |
getBackground() | String | Muestra el color de fondo de la celda superior izquierda del rango (por ejemplo, '#ffffff' ). |
getBackgroundObject() | Color | Muestra el color de fondo de la celda superior izquierda del rango. |
getBackgroundObjects() | Color[][] | Devuelve los colores de fondo de las celdas en el rango. |
getBackgrounds() | String[][] | Muestra los colores de fondo de las celdas en el rango (por ejemplo, '#ffffff' ). |
getBandings() | Banding[] | Muestra todas las bandas que se aplican a cualquier celda en este rango. |
getCell(row, column) | Range | Muestra una celda determinada dentro de un rango. |
getColumn() | Integer | Muestra la posición de la columna inicial para este rango. |
getDataRegion() | Range | Muestra una copia del rango expandido en los cuatro Direction cardinales para abarcar todo
celdas adyacentes con datos. |
getDataRegion(dimension) | Range | Muestra una copia del rango expandido Direction.UP y Direction.DOWN si el
la dimensión especificada es Dimension.ROWS o Direction.NEXT y Direction.PREVIOUS si la dimensión es Dimension.COLUMNS . |
getDataSourceFormula() | DataSourceFormula | Muestra el DataSourceFormula para la primera celda en el rango o null si
la celda no contiene una fórmula de fuente de datos. |
getDataSourceFormulas() | DataSourceFormula[] | Muestra los DataSourceFormula de las celdas en el rango. |
getDataSourcePivotTables() | DataSourcePivotTable[] | Obtiene todas las tablas dinámicas de la fuente de datos que se cruzan con el rango. |
getDataSourceTables() | DataSourceTable[] | Obtiene todas las tablas de fuentes de datos que se cruzan con el rango. |
getDataSourceUrl() | String | Muestra una URL para los datos de este rango, que se puede usar para crear gráficos y consultas. |
getDataTable() | DataTable | Muestra los datos dentro de este objeto como una DataTable. |
getDataTable(firstRowIsHeader) | DataTable | Muestra los datos dentro de este rango como una DataTable. |
getDataValidation() | DataValidation | Devuelve 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 del programador asociados con este rango. |
getDisplayValue() | String | Muestra el valor que se muestra de la celda superior izquierda del rango. |
getDisplayValues() | String[][] | Muestra la cuadrícula rectangular de los valores de este rango. |
getFilter() | Filter | Muestra el filtro en la hoja a la que pertenece este rango, o null si no hay ningún filtro en
la hoja. |
getFontColorObject() | Color | Muestra el color de fuente de la celda en la esquina superior izquierda del rango. |
getFontColorObjects() | Color[][] | Muestra los colores de fuente de las celdas en el rango. |
getFontFamilies() | String[][] | Muestra las familias de fuentes de las celdas del rango. |
getFontFamily() | String | Muestra la familia de fuentes de la celda de la esquina superior izquierda del rango. |
getFontLine() | String | Obtiene 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() | Integer | Muestra el tamaño de fuente en tamaño de punto de la celda en la esquina superior izquierda del rango. |
getFontSizes() | Integer[][] | Muestra los tamaños de fuente de las celdas del rango. |
getFontStyle() | String | Devuelve el estilo de fuente ('italic' o 'normal' ) de la celda en la parte superior izquierda.
en la esquina superior del rango. |
getFontStyles() | String[][] | Muestra los estilos de fuente de las celdas del rango. |
getFontWeight() | String | Muestra el grosor de la fuente (normal/negrita) de la celda ubicada en la esquina superior izquierda del rango. |
getFontWeights() | String[][] | Muestra el peso de la fuente de las celdas en el rango. |
getFormula() | String | Devuelve la fórmula (notación A1) para la celda superior izquierda del rango, o una cadena vacía si el está vacía o no contiene ninguna fórmula. |
getFormulaR1C1() | String | Muestra la fórmula (notación R1C1) para una celda determinada o null si no hay ninguna. |
getFormulas() | String[][] | Muestra las fórmulas (notación A1) para las celdas en el rango. |
getFormulasR1C1() | String[][] | Muestra las fórmulas (notación R1C1) para las celdas en el rango. |
getGridId() | Integer | Muestra el ID de la cuadrícula de la hoja superior del rango. |
getHeight() | Integer | Muestra la altura del rango. |
getHorizontalAlignment() | String | Devuelve la alineación horizontal del texto (izquierda/centro/derecha) de la celda en la parte superior izquierda. en la esquina superior del rango. |
getHorizontalAlignments() | String[][] | Muestra las alineaciones horizontales de las celdas en el rango. |
getLastColumn() | Integer | Muestra la posición de la columna final. |
getLastRow() | Integer | Muestra la posición de la fila final. |
getMergedRanges() | Range[] | Muestra un array de objetos Range que representan celdas combinadas que están completas.
dentro del rango actual o contener al menos una celda en el rango actual. |
getNextDataCell(direction) | Range | Comenzando en la celda de la primera columna y fila del rango, devuelve la siguiente celda en la dirección determinada que es el borde de un rango contiguo de celdas con datos o la celda en el borde de la hoja de cálculo en esa dirección. |
getNote() | String | Muestra la nota asociada al rango especificado. |
getNotes() | String[][] | Devuelve las notas asociadas con las celdas del rango. |
getNumColumns() | Integer | Muestra el número de columnas en este rango. |
getNumRows() | Integer | Muestra el número de filas en este rango. |
getNumberFormat() | String | Obtiene el formato de número o de fecha de la celda superior izquierda del rango especificado. |
getNumberFormats() | String[][] | Muestra los formatos de número o fecha de las celdas del rango. |
getRichTextValue() | RichTextValue | Muestra el valor de texto enriquecido de la celda superior izquierda del rango o null si la celda
el valor no es texto. |
getRichTextValues() | RichTextValue[][] | Devuelve los valores de texto enriquecido para las celdas en el rango. |
getRow() | Integer | Muestra la posición de la fila para este rango. |
getRowIndex() | Integer | Muestra la posición de la fila para este rango. |
getSheet() | Sheet | Muestra la hoja a la que pertenece este rango. |
getTextDirection() | TextDirection | Muestra la dirección del texto de la celda superior izquierda del rango. |
getTextDirections() | TextDirection[][] | Devuelve las instrucciones de texto para las celdas en el rango. |
getTextRotation() | TextRotation | Muestra la configuración de rotación de texto de la celda superior izquierda del rango. |
getTextRotations() | TextRotation[][] | Muestra la configuración de rotación de texto de las celdas en el rango. |
getTextStyle() | TextStyle | Muestra el estilo de texto de la celda superior izquierda del rango. |
getTextStyles() | TextStyle[][] | Muestra los estilos de texto de las celdas del rango. |
getValue() | Object | Muestra el valor de la celda superior izquierda del rango. |
getValues() | Object[][] | Muestra la cuadrícula rectangular de los valores de este rango. |
getVerticalAlignment() | String | Devuelve la alineación vertical (parte superior/central/inferior) de la celda en la esquina superior izquierda de del rango de destino de la ruta. |
getVerticalAlignments() | String[][] | Muestra las alineaciones verticales de las celdas en el rango. |
getWidth() | Integer | Muestra el ancho del rango en columnas. |
getWrap() | Boolean | Muestra si se ajusta el texto de la celda. |
getWrapStrategies() | WrapStrategy[][] | Muestra las estrategias de ajuste de texto para las celdas del rango. |
getWrapStrategy() | WrapStrategy | Muestra la estrategia de ajuste de texto para la celda superior izquierda del rango. |
getWraps() | Boolean[][] | Muestra si se ajusta el texto de las celdas. |
insertCells(shiftDimension) | Range | Inserta celdas vacías en este rango. |
insertCheckboxes() | Range | Inserta casillas de verificación en cada celda del rango, configuradas con true para elementos marcados y
false para elementos desmarcados. |
insertCheckboxes(checkedValue) | Range | Inserta casillas de verificación en cada celda del rango configuradas con un valor personalizado para las celdas marcadas y la cadena vacía es desmarcada. |
insertCheckboxes(checkedValue, uncheckedValue) | Range | Inserta casillas de verificación en cada celda del rango configuradas con valores personalizados para las casillas marcadas. y sin marcar. |
isBlank() | Boolean | Muestra true si el rango está completamente en blanco. |
isChecked() | Boolean | Muestra si todas las celdas del rango tienen su estado de casilla de verificación como "marcado". |
isEndColumnBounded() | Boolean | Determina si el final del rango está vinculado a una columna en particular. |
isEndRowBounded() | Boolean | Determina si el final del rango está vinculado a una fila en particular. |
isPartOfMerge() | Boolean | Muestra true si las celdas del rango actual se superponen con alguna celda combinada. |
isStartColumnBounded() | Boolean | Determina si el inicio del rango está vinculado a una columna en particular. |
isStartRowBounded() | Boolean | Determina si el inicio del rango está vinculado a una fila en particular. |
merge() | Range | Combina las celdas del rango en un solo bloque. |
mergeAcross() | Range | Combina las celdas del rango en las columnas del rango. |
mergeVertically() | Range | Combina las celdas en el rango. |
moveTo(target) | void | Corta y pega (tanto el formato como los valores) de este rango en el rango objetivo. |
offset(rowOffset, columnOffset) | Range | Devuelve un nuevo rango que se desplaza de este rango por el número dado de filas y columnas (que puede ser negativo). |
offset(rowOffset, columnOffset, numRows) | Range | Devuelve un nuevo rango relativo al rango actual, cuyo punto superior izquierdo está desplazado. del rango actual por las filas y columnas determinadas, y con la altura determinada en las celdas. |
offset(rowOffset, columnOffset, numRows, numColumns) | Range | Devuelve un nuevo rango relativo al rango actual, cuyo punto superior izquierdo está desplazado. del rango actual por las filas y columnas determinadas, y con la altura y el ancho dados celdas. |
protect() | Protection | Crea un objeto que puede proteger el rango para que no se pueda editar, excepto por los usuarios que tengan permiso. |
randomize() | Range | Aleatoriza el orden de las filas en el rango determinado. |
removeCheckboxes() | Range | Quita todas las casillas de verificación del rango. |
removeDuplicates() | Range | Elimina las filas dentro de este rango que contienen valores que son duplicados de valores en cualquier fila anterior. |
removeDuplicates(columnsToCompare) | Range | Quita las filas dentro de este rango que contienen valores duplicados en las columnas especificadas de valores de cualquier fila anterior. |
setBackground(color) | Range | Establece el color de fondo de todas las celdas del rango en notación CSS (como '#ffffff' ).
o 'white' ). |
setBackgroundObject(color) | Range | Establece el color de fondo de todas las celdas del rango. |
setBackgroundObjects(color) | Range | Establece una cuadrícula rectangular de los colores de fondo (debe coincidir con las dimensiones de este rango). |
setBackgroundRGB(red, green, blue) | Range | Establece el fondo en el color determinado mediante valores RGB (números enteros entre 0 y 255 inclusive). |
setBackgrounds(color) | Range | Establece una cuadrícula rectangular de los colores de fondo (debe coincidir con las dimensiones de este rango). |
setBorder(top, left, bottom, right, vertical, horizontal) | Range | Establece la propiedad del borde. |
setBorder(top, left, bottom, right, vertical, horizontal, color, style) | Range | Establece la propiedad de borde con color o estilo. |
setDataValidation(rule) | Range | Establece una regla de validación de datos para todas las celdas del rango. |
setDataValidations(rules) | Range | Establece las reglas de validación de datos para todas las celdas del rango. |
setFontColor(color) | Range | Establece el color de la fuente en la notación CSS (como '#ffffff' o 'white' ). |
setFontColorObject(color) | Range | Establece el color de fuente del rango especificado. |
setFontColorObjects(colors) | Range | Establece una cuadrícula rectangular de los colores de fuente (debe coincidir con las dimensiones de este rango). |
setFontColors(colors) | Range | Establece una cuadrícula rectangular de los colores de fuente (debe coincidir con las dimensiones de este rango). |
setFontFamilies(fontFamilies) | Range | Establece una cuadrícula rectangular de las familias de fuentes (debe coincidir con las dimensiones de este rango). |
setFontFamily(fontFamily) | Range | Configura la familia de fuentes, como "Arial". o "Helvetica". |
setFontLine(fontLine) | Range | Establece el estilo de línea de fuente de un rango determinado ('underline' , 'line-through' o
'none' ). |
setFontLines(fontLines) | Range | Establece una cuadrícula rectangular de los estilos de línea (debe coincidir con las dimensiones de este rango). |
setFontSize(size) | Range | Establece el tamaño de fuente, que corresponde al tamaño de punto que se usará. |
setFontSizes(sizes) | Range | Establece una cuadrícula rectangular de los tamaños de fuente (debe coincidir con las dimensiones de este rango). |
setFontStyle(fontStyle) | Range | Establece el estilo de fuente para el rango especificado ('italic' o 'normal' ). |
setFontStyles(fontStyles) | Range | Establece una cuadrícula rectangular de estilos de fuente (debe coincidir con las dimensiones de este rango). |
setFontWeight(fontWeight) | Range | Define el grosor de la fuente para el rango especificado (normal/negrita). |
setFontWeights(fontWeights) | Range | Establece una cuadrícula rectangular de los tamaños de fuente (debe coincidir con las dimensiones de este rango). |
setFormula(formula) | Range | Actualiza la fórmula de este rango. |
setFormulaR1C1(formula) | Range | Actualiza la fórmula de este rango. |
setFormulas(formulas) | Range | Establece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango). |
setFormulasR1C1(formulas) | Range | Establece una cuadrícula rectangular de fórmulas (debe coincidir con las dimensiones de este rango). |
setHorizontalAlignment(alignment) | Range | Establece la alineación horizontal (de izquierda a derecha) para el rango determinado (izquierda/centro/derecha). |
setHorizontalAlignments(alignments) | Range | Establece una cuadrícula rectangular de alineaciones horizontales. |
setNote(note) | Range | Establece la nota en el valor dado. |
setNotes(notes) | Range | Establece una cuadrícula rectangular de notas (debe coincidir con las dimensiones de este rango). |
setNumberFormat(numberFormat) | Range | Establece el formato de número o fecha en la cadena de formato especificada. |
setNumberFormats(numberFormats) | Range | Establece una cuadrícula rectangular en formato de número o fecha (debe coincidir con las dimensiones de este período). |
setRichTextValue(value) | Range | Establece el valor de texto enriquecido para las celdas en el rango. |
setRichTextValues(values) | Range | Establece una cuadrícula rectangular de los valores de texto enriquecido. |
setShowHyperlink(showHyperlink) | Range | Establece si el rango debe mostrar hipervínculos o no. |
setTextDirection(direction) | Range | Establece la dirección del texto de las celdas en el rango. |
setTextDirections(directions) | Range | Establece una cuadrícula rectangular de las direcciones de texto. |
setTextRotation(degrees) | Range | Establece la configuración de rotación de texto de las celdas del rango. |
setTextRotation(rotation) | Range | Establece la configuración de rotación de texto de las celdas del rango. |
setTextRotations(rotations) | Range | Establece una cuadrícula rectangular de las rotaciones de texto. |
setTextStyle(style) | Range | Establece el estilo de texto para las celdas del rango. |
setTextStyles(styles) | Range | Establece una cuadrícula rectangular de estilos de texto. |
setValue(value) | Range | Establece el valor del rango. |
setValues(values) | Range | Establece una cuadrícula rectangular de valores (debe coincidir con las dimensiones de este rango). |
setVerticalAlignment(alignment) | Range | Establece la alineación vertical (de arriba a abajo) para el rango especificado (parte superior/medio/inferior). |
setVerticalAlignments(alignments) | Range | Establece una cuadrícula rectangular de alineamientos verticales (debe coincidir con las dimensiones de este rango). |
setVerticalText(isVertical) | Range | Establece si se apilan o no el texto de las celdas del rango. |
setWrap(isWrapEnabled) | Range | Configura la unión de celdas para el rango determinado. |
setWrapStrategies(strategies) | Range | Establece una cuadrícula rectangular de las estrategias de ajuste. |
setWrapStrategy(strategy) | Range | Establece la estrategia de ajuste de texto para las celdas del rango. |
setWraps(isWrapEnabled) | Range | Establece una cuadrícula rectangular de las políticas de ajuste de palabra (debe coincidir con las dimensiones de este rango). |
shiftColumnGroupDepth(delta) | Range | Cambia la profundidad de agrupamiento de columnas del rango según la cantidad especificada. |
shiftRowGroupDepth(delta) | Range | Cambia la profundidad de agrupación de filas del rango en la cantidad especificada. |
sort(sortSpecObj) | Range | Ordena las celdas en el rango dado, por columna y orden especificados. |
splitTextToColumns() | void | Divide una columna de texto en varias columnas según un delimitador detectado automáticamente. |
splitTextToColumns(delimiter) | void | Divide una columna de texto en varias columnas con la cadena especificada como delimitador personalizado. |
splitTextToColumns(delimiter) | void | Divide una columna de texto en varias columnas según el delimitador especificado. |
trimWhitespace() | Range | Corta los espacios en blanco (como espacios, tabulaciones o líneas nuevas) en todas las celdas de este rango. |
uncheck() | Range | Cambia el estado de las casillas de verificación del rango a "desmarcado". |
Documentación detallada
activate()
Establece el rango especificado como active range
, con la parte superior.
celda izquierda del rango como current cell
.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getRange('A1:D10'); range.activate(); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D10 var activeRange = selection.getActiveRange();
Volver
Range
: Este rango para el encadenamiento.
activateAsCurrentCell()
Establece la celda especificada como current cell
.
Si la celda especificada se encuentra en un rango existente, ese rango se convierte en el activo. rango con la celda como celda actual.
Si la celda especificada no está presente en ningún rango existente, entonces la selección existente es y la celda se convierte en la celda actual y en el rango activo.
Nota: El Range
especificado debe constar de una celda; de lo contrario, arrojará un
excepción.
// Gets the first sheet of the spreadsheet. var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Gets the cell B5 and sets it as the active cell. var range = sheet.getRange('B5'); var currentCell = range.activateAsCurrentCell(); // Logs the activated cell. console.log(currentCell.getA1Notation());
Volver
Range
: Este rango para el encadenamiento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key)
Agrega metadatos del desarrollador con la clave especificada al rango.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on the sheet. const range = sheet.getRange('2:2'); // Adds the key 'NAME' to the developer metadata for row 2. range.addDeveloperMetadata('NAME'); // Gets the metadata and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
key | String | La clave para los nuevos metadatos del desarrollador. |
Volver
Range
: Este 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
Nombre | Tipo | Descripción |
---|---|---|
key | String | La clave para los nuevos metadatos del desarrollador. |
visibility | DeveloperMetadataVisibility | La visibilidad de los nuevos metadatos del desarrollador |
Volver
Range
: Este 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 del desarrollador con la clave y el valor especificados al rango.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 of Sheet1. const range = sheet.getRange('2:2'); // Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2. range.addDeveloperMetadata('NAME', 'GOOGLE'); // Gets the metadata and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
key | String | La clave para los nuevos metadatos del desarrollador. |
value | String | El valor de los nuevos metadatos del desarrollador. |
Volver
Range
: Este 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
Nombre | Tipo | Descripción |
---|---|---|
key | String | La clave para los nuevos metadatos del desarrollador. |
value | String | El valor de los nuevos metadatos del desarrollador. |
visibility | DeveloperMetadataVisibility | La visibilidad de los nuevos metadatos del desarrollador |
Volver
Range
: Este 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 de bandas de columnas predeterminado al rango. De forma predeterminada, las bandas tienen encabezado y no color del 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
: Las nuevas bandas.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyColumnBanding(bandingTheme)
Aplica un tema de bandas de columnas específico al rango. De forma predeterminada, las bandas tienen encabezado y sin 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
Nombre | Tipo | Descripción |
---|---|---|
bandingTheme | BandingTheme | Un tema de color para aplicar a las columnas del rango. |
Volver
Banding
: Las nuevas bandas.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyColumnBanding(bandingTheme, showHeader, showFooter)
Aplica un tema de banda de columnas específico al rango con el encabezado y el pie de página especificados configuración.
// 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
Nombre | Tipo | Descripción |
---|---|---|
bandingTheme | BandingTheme | Un tema de color para aplicar a las columnas del rango. |
showHeader | Boolean | Si es true , el color del encabezado del tema de bandas se aplica al primer
. |
showFooter | Boolean | Si es true , el color del pie de página del tema de bandas se aplica al último
. |
Volver
Banding
: Las nuevas bandas.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyRowBanding()
Aplica un tema predeterminado de banda de filas al rango. De forma predeterminada, las bandas tienen encabezado y no color del pie de página.
// Opens the spreadsheet by its URL. If you created your script from within a Google Sheets // spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets rows 1-30 on Sheet1. const range = sheet.getRange('1:30'); // Applies row banding to rows 1-30. range.applyRowBanding(); // Gets the hex color of the second banded row. const secondRowColor = range.getBandings()[0] .getSecondRowColorObject() .asRgbColor() .asHexString(); // Logs the hex color to console. console.log(secondRowColor);
Volver
Banding
: Las bandas.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyRowBanding(bandingTheme)
Aplica un tema de banda de filas específico al rango. De forma predeterminada, las bandas tienen encabezado y no color del 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
Nombre | Tipo | Descripción |
---|---|---|
bandingTheme | BandingTheme | Un tema de color para aplicar a las filas del rango. |
Volver
Banding
: Las nuevas bandas.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyRowBanding(bandingTheme, showHeader, showFooter)
Aplica un tema específico de banda de filas al rango con la configuración especificada de encabezado y pie de página.
// Opens the spreadsheet by its URL. If you created your script from within a Google Sheets // spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets rows 1-30 on Sheet1. const range = sheet.getRange('1:30'); // Applies the INDIGO row banding to rows 1-30 and // specifies to hide the header and show the footer. range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
bandingTheme | BandingTheme | Un tema de color para aplicar a las filas del rango. |
showHeader | Boolean | Si es true , el color del encabezado del tema de bandas se aplica a la primera fila. |
showFooter | Boolean | Si es true , el color del pie de página del tema de bandas se aplica a la última fila. |
Volver
Banding
: Las nuevas bandas.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoFill(destination, series)
Completa el destinationRange
con datos basados en los datos de este rango. Los valores nuevos
también están determinadas por el tipo de series
especificado. El rango de destino debe contener
este rango y lo extienden en una sola dirección. Por ejemplo, lo siguiente completa A1:A20
con una serie de números crecientes basados en los valores actuales en A1:A4
:
var sheet = SpreadsheetApp.getActiveSheet(); // Has values [1, 2, 3, 4]. var sourceRange = sheet.getRange("A1:A4"); // The range to fill with values. var destination = sheet.getRange("A1:A20"); // Inserts new values in A5:A20, continuing the pattern expressed in A1:A4 sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
destination | Range | El rango que se completará automáticamente con los valores El rango de destino debe contener este rango y extenderlo solo en una dirección (hacia arriba, hacia abajo, hacia la izquierda o derecha). |
series | AutoFillSeries | El tipo de serie de autocompletar que se debe usar para calcular valores nuevos. El efecto de esta serie difiere según el tipo y la cantidad de datos de origen. |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoFillToNeighbor(series)
Calcula un rango para completar con datos nuevos en función de celdas vecinas y rellena automáticamente
que varían con valores nuevos basados en los datos contenidos en ese rango. Estos nuevos valores también son
determinados por el tipo series
especificado.
El rango de destino calculado considera los datos del entorno para determinar dónde se encuentra si hay datos inmediatos a la izquierda o derecha de una columna que Los valores nuevos solo se extienden hasta estos 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, los valores nuevos solo se
se insertó en B5:B20
. De esta manera, estos nuevos valores se quedan a las celdas que contienen
valores en la columna A.
var sheet = SpreadsheetApp.getActiveSheet(); // A1:A20 has values [1, 2, 3, ... 20]. // B1:B4 has values [1/1/2017, 1/2/2017, ...] var sourceRange = sheet.getRange("B1:B4"); // Results in B5:B20 having values [1/5/2017, ... 1/20/2017] sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
series | AutoFillSeries | El tipo de serie de autocompletar que se debe usar para calcular valores nuevos. El efecto de esta serie difiere según el tipo y la cantidad de datos de origen. |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
breakApart()
Vuelve a dividir en celdas individuales las celdas de varias columnas del rango.
Llamar a esta función en un rango equivale a seleccionar un rango y hacer clic Formato > Combinar celdas > Separar.
// Opens the spreadsheet by its URL. If you created your script from within a Google Sheets // spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:C6 on Sheet1. const range = sheet.getRange('A1:C6'); // Unmerges the range A1:C6 into individual cells. range.breakApart();
Volver
Range
: Este rango para el encadenamiento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
canEdit()
Determina si el usuario tiene permiso para editar todas las celdas del rango. La hoja de cálculo el propietario siempre puede editar rangos y 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
: Es true
si el usuario tiene permiso para editar todas las celdas del rango. false
de lo 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 incluyen el valor configurado ni el que está marcado ni desmarcado.
// Changes the state of cells which currently contain either the checked or unchecked value // configured in the range A1:B10 to 'checked'. var range = SpreadsheetApp.getActive().getRange('A1:B10'); range.check();
Volver
Range
: Este 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.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.clear();
Volver
Range
: Este 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 contenidos, el formato, las reglas de validación de datos o los comentarios, como se especifica con las opciones avanzadas indicadas. Se borran todos los datos de forma predeterminada.
// 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
Nombre | Tipo | Descripción |
---|---|---|
options | Object | Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación. |
Parámetros avanzados
Nombre | Tipo | Descripción |
---|---|---|
commentsOnly | Boolean | Especifica si se deben borrar solo los comentarios. |
contentsOnly | Boolean | Establece si solo se borran los contenidos. |
formatOnly | Boolean | Si se borra solo el formato ten en cuenta que borrar también borra las reglas de validación de datos. |
validationsOnly | Boolean | Especifica si se deben borrar solo las reglas de validación de datos. |
skipFilteredRows | Boolean | Especifica si se debe evitar borrar las filas filtradas. |
Volver
Range
: Este 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.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.clearContent();
Volver
Range
: Este 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. var range = SpreadsheetApp.getActive().getRange('A1:B5'); range.clearDataValidations();
Volver
Range
: Este 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.
Esta acción borra el formato de texto de las celdas del rango, pero no restablece ninguna. las reglas de formato de número.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.clearFormat();
Volver
Range
: Este rango para el encadenamiento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearNote()
Borra la nota en una o varias celdas específicas.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.clearNote();
Volver
Range
: Este 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 contenidos por completo dentro del rango. Si ningún grupo está completamente en el rango, el grupo expandido más profundo que se encuentra parcialmente dentro del rango se contrae.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getActiveRange(); // All row and column groups within the range are collapsed. range.collapseGroups();
Volver
Range
: Este rango para 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, la fuente se repite o se trunca según corresponda. Ten en cuenta que esta solo copia el formato.
Para obtener una descripción detallada del parámetro gridId, consulta getGridId()
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var source = ss.getSheets()[0]; var range = source.getRange("B2:D4"); // This copies the formatting in B2:D4 in the source sheet to // D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId // of a sheet by calling sheet.getSheetId() or range.getGridId(). range.copyFormatToRange(1555299895, 4, 6, 4, 6);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
gridId | Integer | El ID único de la hoja dentro de la hoja de cálculo, independientemente de la posición. |
column | Integer | La primera columna del rango objetivo. |
columnEnd | Integer | La columna final del rango objetivo. |
row | Integer | Es la fila inicial del rango objetivo. |
rowEnd | Integer | Es la fila final del rango objetivo. |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Consulta también
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)
Copia el formato del rango en la ubicación especificada. Si el destino es más grande o más pequeño que el rango de origen, la fuente se repite o se trunca según corresponda. Ten en cuenta que esta solo copia el formato.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var source = ss.getSheets()[0]; var destination = ss.getSheets()[1]; var range = source.getRange("B2:D4"); // This copies the formatting in B2:D4 in the source sheet to // D4:F6 in the second sheet range.copyFormatToRange(destination, 4, 6, 4, 6);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
sheet | Sheet | La hoja de destino. |
column | Integer | La primera columna del rango objetivo. |
columnEnd | Integer | La columna final del rango objetivo. |
row | Integer | Es la fila inicial del rango objetivo. |
rowEnd | Integer | Es la fila final del rango objetivo. |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyTo(destination)
Copia los datos de un rango de celdas a otro rango de celdas. Tanto los valores como el formato se copian.
// The code below copies the first 5 columns over to the 6th column. var sheet = SpreadsheetApp.getActiveSheet(); var rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5); rangeToCopy.copyTo(sheet.getRange(1, 6));
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
destination | Range | Un rango de destino al cual copiar; solo es relevante la posición de la celda superior izquierda. |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyTo(destination, copyPasteType, transposed)
Copia los datos de un rango de celdas a otro rango de celdas.
// The code below copies only the values of the first 5 columns over to the 6th column. var sheet = SpreadsheetApp.getActiveSheet(); sheet.getRange("A:E").copyTo(sheet.getRange("F1"), SpreadsheetApp.CopyPasteType.PASTE_VALUES, false);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
destination | Range | Un rango de destino al cual copiar; solo es relevante la posición de la celda superior izquierda. |
copyPasteType | CopyPasteType | Un tipo que especifica cómo se pega el contenido del rango en la destino. |
transposed | Boolean | Indica si el rango debe pegarse en su orientación transpuesta. |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyTo(destination, options)
Copia los datos de un rango de celdas a otro rango de celdas. De forma predeterminada, los valores y pero el formato se copia, pero se puede anular con argumentos avanzados.
// The code below copies only the values of the first 5 columns over to the 6th column. var sheet = SpreadsheetApp.getActiveSheet(); sheet.getRange("A:E").copyTo(sheet.getRange("F1"), {contentsOnly:true});
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
destination | Range | Un rango de destino al cual copiar; solo es relevante la posición de la celda superior izquierda. |
options | Object | Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación. |
Parámetros avanzados
Nombre | Tipo | Descripción |
---|---|---|
formatOnly | Boolean | designa que solo se debe copiar el formato |
contentsOnly | Boolean | designa 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, la fuente se repite o se trunca según corresponda.
Para obtener una descripción detallada del parámetro gridId, consulta getGridId()
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var source = ss.getSheets()[0]; var range = source.getRange("B2:D4"); // This copies the data in B2:D4 in the source sheet to // D4:F6 in the sheet with gridId 0 range.copyValuesToRange(0, 4, 6, 4, 6);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
gridId | Integer | El ID único de la hoja dentro de la hoja de cálculo, independientemente de la posición. |
column | Integer | La primera columna del rango objetivo. |
columnEnd | Integer | La columna final del rango objetivo. |
row | Integer | Es la fila inicial del rango objetivo. |
rowEnd | Integer | Es la fila final del rango objetivo. |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Consulta también
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)
Copia el contenido del rango en la ubicación especificada. Si el destino es más grande o más pequeño que el rango de origen, la fuente se repite o se trunca según corresponda.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var source = ss.getSheets()[0]; var destination = ss.getSheets()[1]; var range = source.getRange("B2:D4"); // This copies the data in B2:D4 in the source sheet to // D4:F6 in the second sheet range.copyValuesToRange(destination, 4, 6, 4, 6);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
sheet | Sheet | La hoja de destino. |
column | Integer | La primera columna del rango objetivo. |
columnEnd | Integer | La columna final del rango objetivo. |
row | Integer | Es la fila inicial del rango objetivo. |
rowEnd | Integer | Es la fila final del rango objetivo. |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDataSourcePivotTable(dataSource)
Crea una tabla dinámica de fuente de datos vacía a partir de la fuente de datos, anclada en la primera celda de este rango.
En este ejemplo, se muestra cómo crear y configurar una nueva tabla dinámica de fuente de datos.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); var anchorCell = spreadsheet.getSheets()[0].getRange('A1'); var dataSource = spreadsheet.getDataSources()[0]; var pivotTable = anchorCell.createDataSourcePivotTable(dataSource); pivotTable.addRowGroup('dataColumnA'); pivotTable.addColumnGroup('dataColumnB'); pivotTable.addPivotValue('dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM); pivotTable.addFilter('dataColumnA', SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
dataSource | DataSource | La fuente de datos a partir de la cual se creará la tabla dinámica. |
Volver
DataSourcePivotTable
: Es la tabla dinámica de fuente de datos recién creada.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDataSourceTable(dataSource)
Crea una tabla de fuente de datos vacía a partir de la fuente de datos, anclada en la primera celda de esta del rango de destino de la ruta.
En este ejemplo, se muestra cómo crear y configurar una nueva tabla de fuente de datos.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); var anchorCell = spreadsheet.getSheets()[0].getRange('A1'); var dataSource = spreadsheet.getDataSources()[0]; var dataSourceTable = anchorCell.createDataSourceTable(dataSource); .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC') .addSortSpec('dataColumnA', /* ascending= *\/ true) .addSortSpec('dataColumnB', /* ascending= *\/ false);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
dataSource | DataSource | La fuente de datos a partir de la cual se creará la tabla dinámica. |
Volver
DataSourceTable
: la tabla de fuente de datos recién creada.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDeveloperMetadataFinder()
Muestra una DeveloperMetadataFinderApi para encontrar metadatos del desarrollador dentro del alcance de este. del rango de destino de la ruta. Los metadatos están dentro del alcance del rango solo si están completamente contenidos dentro de ese rango. del rango de destino de la ruta. Por ejemplo, los metadatos asociados con la fila “3:3” no están dentro del alcance de un rango. “A1:D5”, pero está 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 dentro del 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 por hoja. Para acceder al filtro y modificarlo después de crearlo, usa getFilter()
o Sheet.getFilter()
.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); // Creates a new filter and applies it to the range A1:C20 on the active sheet. function createFilter() { range.createFilter(); } // Gets the filter and applies criteria that only shows cells that aren't empty. function getFilterAddCriteria() { let filter = range.getFilter(); let criteria = SpreadsheetApp.newFilterCriteria() .whenCellNotEmpty() .build(); filter.setColumnFilterCriteria(2, criteria); }
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:
- Crea un filtro de tabla dinámica con
PivotTable.addFilter(sourceDataColumn, filterCriteria)
- Crea un filtro para una hoja conectada a una base de datos con
DataSourceSheet.addFilter(columnName, filterCriteria)
- Crea un filtro para una tabla dinámica conectada a una base de datos con
DataSourcePivotTable.addFilter(columnName, filterCriteria)
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 anclado en la primera celda
en este rango.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // 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
Nombre | Tipo | Descripción |
---|---|---|
sourceData | Range | Los datos a partir de los cuales se creará la tabla dinámica. |
Volver
PivotTable
: 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 intervalo, que puede buscar y reemplazar texto.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getActiveRange(); // Creates a text finder for the range. var textFinder = range.createTextFinder('dog'); // Returns the first occurrence of 'dog'. var firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. var numOccurrencesReplaced = textFinder.replaceWith('cat');
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
findText | String | El texto que se va a buscar |
Volver
TextFinder
: Es el TextFinder
del rango.
deleteCells(shiftDimension)
Elimina este rango de celdas. Se cambian los datos existentes en la hoja junto con la dimensión proporcionada hacia el rango borrado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
shiftDimension | Dimension | La dimensión a lo que se deben desplazar 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 cruza con este rango. El 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, justo antes o después del grupo según la configuración. Si hay más de un grupo en la misma ubicación, el grupo más bajo se expande.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getActiveRange(); // All row and column groups within the range are expanded. range.expandGroups();
Volver
Range
: Este rango para el encadenamiento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getA1Notation()
Muestra una descripción de cadena del rango, en notación A1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange(1, 1, 2, 5); // Logs "A1:E2" Logger.log(range.getA1Notation());
Volver
String
: la descripción de la 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()
Muestra el color de fondo de la celda superior izquierda del rango (por ejemplo, '#ffffff'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B5"); Logger.log(cell.getBackground());
Volver
String
: Indica el código de color del fondo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getBackgroundObject()
Muestra el color de fondo de la celda superior izquierda del rango.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B5"); Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());
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 en el rango.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B5:C6"); var bgColors = range.getBackgroundObjects(); for (var i in bgColors) { for (var j in bgColors[i]) { Logger.log(bgColors[i][j].asRgbColor().asHexString()); } }
Volver
Color[][]
: Es un array bidimensional de colores de fondo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getBackgrounds()
Muestra los colores de fondo de las celdas en el rango (por ejemplo, '#ffffff'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B5:C6"); var bgColors = range.getBackgrounds(); for (var i in bgColors) { for (var j in bgColors[i]) { Logger.log(bgColors[i][j]); } }
Volver
String[][]
: Es un array bidimensional de códigos de color de los fondos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getBandings()
Muestra todas las bandas que se aplican a cualquier celda en este rango.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets a range. const range = sheet.getRange('A1:K50'); // Gets the banding info for the range. const bandings = range.getBandings(); // Logs the second row color for each banding to the console. for (let banding of bandings) { console.log(banding.getSecondRowColor()); }
Volver
Banding[]
: Todas las bandas que se aplican a cualquier celda 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
getCell(row, column)
Muestra una celda determinada dentro de un rango.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); // The row and column here are relative to the range // getCell(1,1) in this code returns the cell at B2 var cell = range.getCell(1, 1); Logger.log(cell.getValue());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
row | Integer | Fila de la celda en relación con el rango. |
column | Integer | Columna de la celda en relación con el rango |
Volver
Range
: Indica un rango que contiene una sola celda en las coordenadas especificadas.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumn()
Muestra la posición de la columna inicial para este rango.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); // Logs "2.0" Logger.log(range.getColumn());
Volver
Integer
: Indica 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()
Muestra una copia del rango expandido en los cuatro Direction
cardinales para abarcar todo
celdas adyacentes con datos. Si el rango está rodeado de celdas vacías sin incluir aquellas
a lo largo de las diagonales, se devuelve el rango mismo. Esto es similar a seleccionar el rango y
Escribe Ctrl+A
en el editor.
// Assume the active spreadsheet is blank. var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.getRange("C2").setValue(100); sheet.getRange("B3").setValue(100); sheet.getRange("D3").setValue(100); sheet.getRange("C4").setValue(100); // Logs "B2:D4" Logger.log(sheet.getRange("C3").getDataRegion().getA1Notation());
Volver
Range
: Indica la región de datos del rango o un rango de toda la hoja de cálculo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataRegion(dimension)
Muestra una copia del rango expandido Direction.UP
y Direction.DOWN
si el
la dimensión especificada es Dimension.ROWS
o Direction.NEXT
y Direction.PREVIOUS
si la dimensión es Dimension.COLUMNS
. La expansión del rango
se basa en la detección de datos junto al rango que se organiza como una tabla. El rango expandido
abarca todas las celdas adyacentes con datos en ellas a lo largo de la dimensión especificada, incluida la tabla
límites. Si el rango original está rodeado de celdas vacías en 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. var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.getRange("C2").setValue(100); sheet.getRange("B3").setValue(100); sheet.getRange("D3").setValue(100); sheet.getRange("C4").setValue(100); // Logs "C2:C4" Logger.log(sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.ROWS).getA1Notation()); // Logs "B3:D3" Logger.log( sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.COLUMNS).getA1Notation());
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
dimension | Dimension | Es la dimensión en la que se expande el rango. |
Volver
Range
: Indica la región de datos del rango o un rango que cubre cada columna o cada fila que abarca la
rango original.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormula()
Muestra el DataSourceFormula
para la primera celda en el rango o null
si
la celda no contiene una fórmula de fuente de datos.
// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file, // use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1 on Sheet1. const range = sheet.getRange('A1'); // Gets the data source formula from cell A1. const dataSourceFormula = range.getDataSourceFormula(); // Gets the formula. const formula = dataSourceFormula.getFormula(); // Logs the formula. console.log(formula);
Volver
DataSourceFormula
: Es el DataSourceFormula
de la celda.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormulas()
Muestra los DataSourceFormula
de las celdas en el rango.
// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file, // use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:B5 on Sheet1. const range = sheet.getRange('A1:B5'); // Gets an array of the data source formulas in the range A1:B5. const dataSourceFormulas = range.getDataSourceFormulas(); // Logs the first formula in the array. console.log(dataSourceFormulas[0].getFormula());
Volver
DataSourceFormula[]
: Es un array de DataSourceFormula
.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourcePivotTables()
Obtiene todas las tablas dinámicas de la fuente de datos que se cruzan con el rango.
// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file, // use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:G50 on Sheet1. const range = sheet.getRange('A1:G50'); // Gets an array of the data source pivot tables in the range A1:G50. const dataSourcePivotTables = range.getDataSourcePivotTables(); // Logs the last time that the first pivot table in the array was refreshed. console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());
Volver
DataSourcePivotTable[]
: Es una lista de tablas dinámicas de fuente de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceTables()
Obtiene todas las tablas de fuentes de datos que se cruzan con el rango.
// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file, // use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:G50 on Sheet1. const range = sheet.getRange('A1:G50'); // Gets the first data source table in the range A1:G50. const dataSourceTable = range.getDataSourceTables()[0]; // Logs the time of the last completed data execution on the data source table. console.log(dataSourceTable.getStatus().getLastExecutionTime());
Volver
DataSourceTable[]
: Es una lista de tablas de fuentes de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceUrl()
Muestra una URL para los datos de este rango, que se puede usar para crear gráficos y consultas.
Code.gs
function doGet() { var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c'); var sheet = ss.getSheetByName('ContinentData'); var range = sheet.getRange('A1:B8'); var template = HtmlService.createTemplateFromFile('piechart'); template.dataSourceUrl = range.getDataSourceUrl(); return template.evaluate(); }
piechart.html
<!DOCTYPE html> <html> <head> <!--Load the AJAX API--> <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script> <script type="text/javascript"> // Load the Visualization API and the corechart package. google.charts.load('current', {'packages': ['corechart']}); // Set a callback to run when the Google Visualization API is loaded. google.charts.setOnLoadCallback(queryData); function queryData() { var query = new google.visualization.Query('<?= dataSourceUrl ?>'); query.send(drawChart); } // Callback that creates and populates a data table, // instantiates the pie chart, passes in the data and // draws it. function drawChart(response) { if (response.isError()) { alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage()); return; } var data = response.getDataTable(); // Set chart options. var options = { title: 'Population by Continent', width: 400, height: 300 }; // Instantiate and draw the chart, passing in some options. var chart = new google.visualization.PieChart(document.getElementById('chart_div')); chart.draw(data, options); } </script> </head> <body> <!-- Div that holds the pie chart. --> <div id="chart_div"></div> </body> </html>
Volver
String
: Es una URL para este rango como una fuente de datos que se puede pasar a otras APIs, como gráficos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataTable()
Muestra los datos dentro de este objeto como una DataTable.
// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file, // use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:B7 on Sheet1. const range = sheet.getRange('A1:B7'); // Gets the range A1:B7 as a data table. The values in each column must be of the same type. const datatable = range.getDataTable(); // Uses the Charts service to build a bar chart from the data table. // This doesn't build an embedded chart. To do that, use sheet.newChart().addRange() instead. const chart = Charts.newBarChart() .setDataTable(datatable) .setOption('title', 'Your Chart Title Here') .build();
Volver
DataTable
: Son los datos como una tabla de datos.
getDataTable(firstRowIsHeader)
Muestra los datos dentro de este rango como una DataTable.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B7"); // Calling this method with "true" sets the first line to be the title of the axes var datatable = range.getDataTable(true); // Note that this doesn't build an EmbeddedChart, so you can't just use // Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead. var chart = Charts.newBarChart() .setDataTable(datatable) .setOption("title", "Your Title Here") .build();
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
firstRowIsHeader | Boolean | Establece si se debe tratar la primera fila como un encabezado. |
Volver
DataTable
: Son los datos como una tabla de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataValidation()
Devuelve la regla de validación de datos para la celda superior izquierda del rango. Si la validación de datos no
en la celda, este método muestra null
.
// Log information about the data validation rule for cell A1. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = cell.getDataValidation(); if (rule != null) { var criteria = rule.getCriteriaType(); var args = rule.getCriteriaValues(); Logger.log('The data validation rule is %s %s', criteria, args); } else { Logger.log('The cell does not have a data validation rule.') }
Volver
DataValidation
: Es la regla de validación de datos de la celda superior izquierda del rango.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataValidations()
Devuelve las reglas de validación de datos para todas las celdas del rango. Si la validación de datos no se ha
establecido en una celda determinada, este método muestra null
para la posición de esa celda en el array.
// Change existing data validation rules that require a date in 2013 to require a date in 2014. var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')]; var newDates = [new Date('1/1/2014'), new Date('12/31/2014')]; var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns()); var rules = range.getDataValidations(); for (var i = 0; i < rules.length; i++) { for (var j = 0; j < rules[i].length; j++) { var rule = rules[i][j]; if (rule != null) { var criteria = rule.getCriteriaType(); var args = rule.getCriteriaValues(); if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN && args[0].getTime() == oldDates[0].getTime() && args[1].getTime() == oldDates[1].getTime()) { // Create a builder from the existing rule, then change the dates. rules[i][j] = rule.copy().withCriteria(criteria, newDates).build(); } } } } range.setDataValidations(rules);
Volver
DataValidation[][]
: Es un array bidimensional de reglas de validación de datos asociadas con las celdas de la
del rango de destino de la ruta.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDeveloperMetadata()
Obtiene los metadatos del programador 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[]
: los metadatos del programador asociados con este rango.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDisplayValue()
Muestra el valor que se muestra de la celda superior izquierda del rango. El valor es String
.
El valor que se muestra tiene en cuenta el formato de fecha, hora y moneda, lo que incluye
formatos aplicados automáticamente por la configuración regional de la hoja de cálculo. Las celdas vacías muestran un mensaje vacío
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
: el valor que se muestra en esta celda.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDisplayValues()
Muestra la cuadrícula rectangular de los valores de este rango.
Muestra un array bidimensional de los valores que se muestran, indexados por fila y, luego, por columna. El
los valores son objetos String
. El valor que se muestra tiene en cuenta la fecha, la hora y
formato de moneda, incluidos los formatos que se aplican automáticamente según la configuración regional de la hoja de cálculo
del lugar. Las celdas vacías se representan con una cadena vacía en el array. Recuerda que, si bien
índice de rango comienza en 1, 1
, el array de JavaScript se indexa desde [0][0]
.
// The code below gets the displayed values for the range C2:G8 // in the active spreadsheet. Note that this is a JavaScript array. var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues(); Logger.log(values[0][0]);
Volver
String[][]
: Es un array de valores bidimensional.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilter()
Muestra el filtro en la hoja a la que pertenece este rango, o null
si no hay ningún filtro en
la hoja.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); // Gets the existing filter on the sheet that the given range belongs to. let filter = range.getFilter();
Volver
Filter
: Es el filtro.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontColorObject()
Muestra el color de fuente de la celda en la esquina superior izquierda del rango.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getFontColorObject().asRgbColor().asHexString());
Volver
Color
: Indica el color de fuente de la celda superior izquierda del rango.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontColorObjects()
Muestra los colores de fuente de las celdas en el rango.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getFontColorObjects(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j].asRgbColor().asHexString()); } }
Volver
Color[][]
: Es un array bidimensional de colores de fuente asociados con celdas del rango.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontFamilies()
Muestra las familias de fuentes de las celdas del rango.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getFontFamilies(); for (var i in results) {