Se usó la API de Cloud Translation para traducir esta página.

Class Sheet

Acceder a las hojas de cálculo y modificarlas Las operaciones comunes son cambiar el nombre de una hoja y acceder al rango objetos de la hoja.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`activate()`	`Sheet`	Activa esta hoja.
`addDeveloperMetadata(key)`	`Sheet`	Agrega a la hoja metadatos del programador con la clave especificada.
`addDeveloperMetadata(key, visibility)`	`Sheet`	Agrega metadatos del desarrollador con la clave y la visibilidad especificadas a la hoja.
`addDeveloperMetadata(key, value)`	`Sheet`	Agrega a la hoja metadatos del desarrollador con la clave y el valor especificados.
`addDeveloperMetadata(key, value, visibility)`	`Sheet`	Agrega a la hoja metadatos del desarrollador con la clave, el valor y la visibilidad especificados.
`appendRow(rowContents)`	`Sheet`	Agrega una fila al final de la región de datos actual en la hoja.
`asDataSourceSheet()`	`DataSourceSheet`	Muestra la hoja como `DataSourceSheet` si la hoja es del tipo `SheetType.DATASOURCE`; de lo contrario, muestra `null`.
`autoResizeColumn(columnPosition)`	`Sheet`	Configura el ancho de la columna determinada para que se ajuste a su contenido.
`autoResizeColumns(startColumn, numColumns)`	`Sheet`	Establece el ancho de todas las columnas a partir de la posición determinada para ajustarse a su contenido.
`autoResizeRows(startRow, numRows)`	`Sheet`	Establece la altura de todas las filas a partir de la posición de la fila determinada para que se ajuste a su contenido.
`clear()`	`Sheet`	Borra la hoja de información de contenido y formato.
`clear(options)`	`Sheet`	Borra la hoja de contenido o el formato, según se especifica en las opciones avanzadas indicadas.
`clearConditionalFormatRules()`	`void`	Quita todas las reglas de formato condicional de la hoja.
`clearContents()`	`Sheet`	Borra la hoja de contenido, pero conserva la información de formato.
`clearFormats()`	`Sheet`	Borra la hoja de formato, pero conserva el contenido.
`clearNotes()`	`Sheet`	Borra todas las notas de la hoja.
`collapseAllColumnGroups()`	`Sheet`	Contrae todos los grupos de columnas de la hoja.
`collapseAllRowGroups()`	`Sheet`	Contrae todos los grupos de filas de la hoja.
`copyTo(spreadsheet)`	`Sheet`	Copia la hoja en una hoja de cálculo determinada, que puede ser la misma hoja de cálculo que la fuente.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Muestra un `DeveloperMetadataFinder` para encontrar metadatos del desarrollador dentro del permiso de esta hoja.
`createTextFinder(findText)`	`TextFinder`	Crea un buscador de texto para la hoja, que puede buscar y reemplazar texto dentro de la hoja.
`deleteColumn(columnPosition)`	`Sheet`	Borra la columna en la posición dada.
`deleteColumns(columnPosition, howMany)`	`void`	Borra una cantidad de columnas que comienzan en la posición determinada de la columna.
`deleteRow(rowPosition)`	`Sheet`	Elimina la fila en la posición de fila especificada.
`deleteRows(rowPosition, howMany)`	`void`	Elimina una cantidad de filas que comienzan en la posición de fila especificada.
`expandAllColumnGroups()`	`Sheet`	Expande todos los grupos de columnas en la hoja.
`expandAllRowGroups()`	`Sheet`	Expande todos los grupos de filas en la hoja.
`expandColumnGroupsUpToDepth(groupDepth)`	`Sheet`	Expande todos los grupos de columnas hasta la profundidad determinada y contrae todos los demás.
`expandRowGroupsUpToDepth(groupDepth)`	`Sheet`	Expande todos los grupos de filas hasta la profundidad determinada y contrae todos los demás.
`getActiveCell()`	`Range`	Muestra la celda activa en esta hoja.
`getActiveRange()`	`Range`	Muestra el rango seleccionado en la hoja activa o `null` si no hay ningún rango activo.
`getActiveRangeList()`	`RangeList`	Muestra la lista de rangos activos en la hoja activa o `null` si no hay ningún rango activo o rangos.
`getBandings()`	`Banding[]`	Devuelve todas las bandas en esta hoja.
`getCharts()`	`EmbeddedChart[]`	Muestra un array de gráficos en esta hoja.
`getColumnGroup(columnIndex, groupDepth)`	`Group`	Muestra el grupo de columnas en el índice y la profundidad del grupo determinados.
`getColumnGroupControlPosition()`	`GroupControlTogglePosition`	Muestra el `GroupControlTogglePosition` de todos los grupos de columnas de la hoja.
`getColumnGroupDepth(columnIndex)`	`Integer`	Muestra la profundidad del grupo de la columna en el índice determinado.
`getColumnWidth(columnPosition)`	`Integer`	Obtiene el ancho en píxeles de la columna determinada.
`getConditionalFormatRules()`	`ConditionalFormatRule[]`	Obtén todas las reglas de formato condicional en esta hoja.
`getCurrentCell()`	`Range`	Muestra la celda actual en la hoja activa o `null` si no hay una celda actual.
`getDataRange()`	`Range`	Muestra un objeto `Range` que corresponde a las dimensiones en las que están presentes los datos.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Obtiene todas las fórmulas de fuente de datos.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Obtiene todas las tablas dinámicas de la fuente de datos.
`getDataSourceTables()`	`DataSourceTable[]`	Obtiene todas las tablas de fuentes de datos.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Obtén todos los metadatos del desarrollador asociados con esta hoja.
`getDrawings()`	`Drawing[]`	Devuelve una matriz de dibujos en la hoja.
`getFilter()`	`Filter`	Muestra el filtro en esta hoja o `null` si no hay ningún filtro.
`getFormUrl()`	`String`	Muestra la URL del formulario que envía sus respuestas a esta hoja o `null` si esta la hoja no tiene ningún formulario asociado.
`getFrozenColumns()`	`Integer`	Muestra el número de columnas inmovilizadas.
`getFrozenRows()`	`Integer`	Muestra el número de filas inmovilizadas.
`getImages()`	`OverGridImage[]`	Muestra todas las imágenes en la cuadrícula de la hoja.
`getIndex()`	`Integer`	Obtiene la posición de la hoja en la hoja de cálculo principal.
`getLastColumn()`	`Integer`	Muestra la posición de la última columna que tiene contenido.
`getLastRow()`	`Integer`	Muestra la posición de la última fila que tiene contenido.
`getMaxColumns()`	`Integer`	Muestra el número actual de columnas en la hoja, independientemente del contenido.
`getMaxRows()`	`Integer`	Muestra el número actual de filas en la hoja, independientemente del contenido.
`getName()`	`String`	Muestra el nombre de la hoja.
`getNamedRanges()`	`NamedRange[]`	Obtiene todos los rangos con nombre de esta hoja.
`getParent()`	`Spreadsheet`	Muestra el `Spreadsheet` que contiene esta hoja.
`getPivotTables()`	`PivotTable[]`	Muestra todas las tablas dinámicas de esta hoja.
`getProtections(type)`	`Protection[]`	Obtiene un array de objetos que representan todos los rangos protegidos de la hoja o un solo elemento. array que representa la protección de la propia hoja.
`getRange(row, column)`	`Range`	Muestra el rango con la celda superior izquierda en las coordenadas especificadas.
`getRange(row, column, numRows)`	`Range`	Devuelve el rango con la celda superior izquierda en las coordenadas determinadas y con el número determinado de filas.
`getRange(row, column, numRows, numColumns)`	`Range`	Devuelve el rango con la celda superior izquierda en las coordenadas determinadas con el número de filas determinado. y columnas.
`getRange(a1Notation)`	`Range`	Muestra el rango como se especifica en la notación A1 o en la notación R1C1.
`getRangeList(a1Notations)`	`RangeList`	Devuelve la colección `RangeList` que representa los rangos de la misma hoja especificada. con una lista no vacía de notaciones A1 o R1C1.
`getRowGroup(rowIndex, groupDepth)`	`Group`	Muestra el grupo de filas en el índice y la profundidad del grupo especificados.
`getRowGroupControlPosition()`	`GroupControlTogglePosition`	Muestra el `GroupControlTogglePosition` de todos los grupos de filas de la hoja.
`getRowGroupDepth(rowIndex)`	`Integer`	Muestra la profundidad del grupo de la fila en el índice determinado.
`getRowHeight(rowPosition)`	`Integer`	Obtiene la altura en píxeles de la fila determinada.
`getSelection()`	`Selection`	Muestra el `Selection` actual en la hoja de cálculo.
`getSheetId()`	`Integer`	Devuelve el ID de la hoja representada por este objeto.
`getSheetName()`	`String`	Muestra el nombre de la hoja.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Muestra la cuadrícula rectangular de valores para este rango a partir de las coordenadas proporcionadas.
`getSlicers()`	`Slicer[]`	Muestra un array de controles de filtro en la hoja.
`getTabColorObject()`	`Color`	Obtiene el color de la pestaña de la hoja, o `null` si la pestaña de la hoja no tiene color.
`getType()`	`SheetType`	Devuelve el tipo de hoja.
`hasHiddenGridlines()`	`Boolean`	Muestra `true` si las líneas de cuadrícula de la hoja están ocultas. De lo contrario, muestra `false`.
`hideColumn(column)`	`void`	Oculta las columnas del rango especificado.
`hideColumns(columnIndex)`	`void`	Oculta una sola columna en el índice determinado.
`hideColumns(columnIndex, numColumns)`	`void`	Oculta una o más columnas consecutivas a partir del índice determinado.
`hideRow(row)`	`void`	Oculta las filas en el rango especificado.
`hideRows(rowIndex)`	`void`	Oculta la fila en el índice determinado.
`hideRows(rowIndex, numRows)`	`void`	Oculta una o más filas consecutivas que comienzan en el índice determinado.
`hideSheet()`	`Sheet`	Oculta esta hoja.
`insertChart(chart)`	`void`	Agrega un gráfico nuevo a esta hoja.
`insertColumnAfter(afterPosition)`	`Sheet`	Inserta una columna después de la posición dada de la columna.
`insertColumnBefore(beforePosition)`	`Sheet`	Inserta una columna antes de la posición de la columna especificada.
`insertColumns(columnIndex)`	`void`	Inserta una columna en blanco en una hoja en la ubicación especificada.
`insertColumns(columnIndex, numColumns)`	`void`	Inserta una o más columnas en blanco consecutivas en una hoja a partir de la ubicación especificada.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	Inserta un número determinado de columnas después de la posición de la columna especificada.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	Inserta una cantidad de columnas antes de la posición de la columna especificada.
`insertImage(blobSource, column, row)`	`OverGridImage`	Inserta un objeto `BlobSource` como imagen en el documento en una fila y columna determinadas.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	Inserta un elemento `BlobSource` como imagen en el documento en una fila y columna determinadas, con un desplazamiento de píxeles.
`insertImage(url, column, row)`	`OverGridImage`	Inserta una imagen en el documento en una fila y columna determinadas.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	Inserta una imagen en el documento en una fila y columna determinadas, con desplazamiento de píxeles.
`insertRowAfter(afterPosition)`	`Sheet`	Inserta una fila después de la posición de fila especificada.
`insertRowBefore(beforePosition)`	`Sheet`	Inserta una fila antes de la posición de fila especificada.
`insertRows(rowIndex)`	`void`	Inserta una fila en blanco en una hoja en la ubicación especificada.
`insertRows(rowIndex, numRows)`	`void`	Inserta una o más filas en blanco consecutivas en una hoja a partir de la ubicación especificada.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	Inserta una cantidad de filas después de la posición de fila especificada.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	Inserta una cantidad de filas antes de la posición de fila especificada.
`insertSlicer(range, anchorRowPos, anchorColPos)`	`Slicer`	Agrega un nuevo control de filtro a la hoja.
`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`	`Slicer`	Agrega un nuevo control de filtro a la hoja.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	Muestra si el usuario ocultó la columna especificada.
`isRightToLeft()`	`Boolean`	Muestra `true` si este diseño de hoja es de derecha a izquierda.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	Muestra si un filtro (no una vista de filtro) ocultó la fila especificada.
`isRowHiddenByUser(rowPosition)`	`Boolean`	Muestra si el usuario ocultó la fila especificada.
`isSheetHidden()`	`Boolean`	Muestra `true` si la hoja está oculta actualmente.
`moveColumns(columnSpec, destinationIndex)`	`void`	Mueve las columnas seleccionadas por el rango dado a la posición indicada por `destinationIndex`.
`moveRows(rowSpec, destinationIndex)`	`void`	Mueve las filas seleccionadas por el rango determinado a la posición indicada por `destinationIndex`.
`newChart()`	`EmbeddedChartBuilder`	Muestra un compilador para crear un gráfico nuevo para esta hoja.
`protect()`	`Protection`	Crea un objeto que puede impedir que se edite la hoja, excepto por los usuarios que hayan permiso.
`removeChart(chart)`	`void`	Quita un gráfico de la hoja superior.
`setActiveRange(range)`	`Range`	Establece el rango especificado como `active range` en la hoja activa, con la celda superior izquierda del rango como `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	Establece la lista especificada de rangos como `active ranges` en el hoja activa.
`setActiveSelection(range)`	`Range`	Establece la región de selección activa para esta hoja.
`setActiveSelection(a1Notation)`	`Range`	Establece la selección activa, como se especifica en la notación A1 o la notación R1C1.
`setColumnGroupControlPosition(position)`	`Sheet`	Establece la posición del control de activación de grupo de columnas en la hoja.
`setColumnWidth(columnPosition, width)`	`Sheet`	Establece el ancho de la columna determinada en píxeles.
`setColumnWidths(startColumn, numColumns, width)`	`Sheet`	Establece el ancho de las columnas determinadas en píxeles.
`setConditionalFormatRules(rules)`	`void`	Reemplaza todas las reglas de formato condicional existentes en la hoja por las reglas de entrada.
`setCurrentCell(cell)`	`Range`	Establece la celda especificada como `current cell`.
`setFrozenColumns(columns)`	`void`	Inmoviliza el número determinado de columnas.
`setFrozenRows(rows)`	`void`	Inmoviliza la cantidad de filas especificada.
`setHiddenGridlines(hideGridlines)`	`Sheet`	Oculta o muestra las líneas de cuadrícula de la hoja.
`setName(name)`	`Sheet`	Establece el nombre de la hoja.
`setRightToLeft(rightToLeft)`	`Sheet`	Establece o anula la configuración del diseño de hoja de derecha a izquierda.
`setRowGroupControlPosition(position)`	`Sheet`	Establece la posición del control de activación de grupo de filas en la hoja.
`setRowHeight(rowPosition, height)`	`Sheet`	Establece la altura de la fila determinada en píxeles.
`setRowHeights(startRow, numRows, height)`	`Sheet`	Establece la altura de las filas determinadas en píxeles.
`setRowHeightsForced(startRow, numRows, height)`	`Sheet`	Establece la altura de las filas determinadas en píxeles.
`setTabColor(color)`	`Sheet`	Establece el color de la pestaña de la hoja.
`setTabColorObject(color)`	`Sheet`	Establece el color de la pestaña de la hoja.
`showColumns(columnIndex)`	`void`	Muestra la columna en el índice dado.
`showColumns(columnIndex, numColumns)`	`void`	Muestra una o más columnas consecutivas a partir del índice determinado.
`showRows(rowIndex)`	`void`	Muestra la fila en el índice determinado.
`showRows(rowIndex, numRows)`	`void`	Muestra una o más filas consecutivas a partir del índice determinado.
`showSheet()`	`Sheet`	Hace que la hoja sea visible.
`sort(columnPosition)`	`Sheet`	Ordena una hoja por columna, de forma ascendente.
`sort(columnPosition, ascending)`	`Sheet`	Ordena una hoja por columna.
`unhideColumn(column)`	`void`	Muestra la columna en el rango especificado.
`unhideRow(row)`	`void`	Muestra la fila en el rango especificado.
`updateChart(chart)`	`void`	Actualiza el gráfico de esta hoja.

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
`getSheetProtection()`	`PageProtection`	Muestra una instancia de `PageProtection` que describe los permisos de la hoja de cálculo actual.
`getTabColor()`	`String`	Obtiene el color de la pestaña de la hoja, o `null` si la pestaña de la hoja no tiene color.
`setSheetProtection(permissions)`	`void`	Establece los permisos de la hoja actual.

Documentación detallada

`activate()`

Activa esta hoja. No altera la hoja en sí, solo la noción de la madre o el padre del activo de la hoja de cálculo.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.activate();

Volver

Sheet: Es la hoja recién activa.

`addDeveloperMetadata(key)`

Agrega a la hoja metadatos del programador con la clave 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('NAME');

// Gets the updated metadata info and logs it to the console.
console.log(sheet.getDeveloperMetadata()[0].getKey());

Parámetros

Nombre	Tipo	Descripción
`key`	`String`	La clave para los nuevos metadatos del desarrollador.

Volver

Sheet: Esta hoja, 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 a la hoja.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT
// for the sheet.
sheet.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.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

Sheet: Esta hoja, 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 a la hoja metadatos del desarrollador con la clave y el valor especificados.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('COMPANY', 'TECH');

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.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

Sheet: Esta hoja, 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 a la hoja metadatos del desarrollador con la clave, el valor y la visibilidad especificados.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and sets the
// visibility to DOCUMENT for the sheet.
sheet.addDeveloperMetadata(
  'COMPANY',
  'TECH',
  SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.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

Sheet: Esta hoja, 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

`appendRow(rowContents)`

Agrega una fila al final de la región de datos actual en la hoja. Si el contenido de una celda comienza con =, se interpreta como una fórmula.

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

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

Parámetros

Nombre	Tipo	Descripción
`rowContents`	`Object[]`	Un array de valores para insertar después de la última fila de la hoja.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`asDataSourceSheet()`

Muestra la hoja como DataSourceSheet si la hoja es del tipo SheetType.DATASOURCE; de lo contrario, muestra null.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

Volver

DataSourceSheet: Es una hoja 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

`autoResizeColumn(columnPosition)`

Configura el ancho de la columna determinada para que se ajuste a su contenido.

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

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la columna determinada a la que se debe cambiar el tamaño.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`autoResizeColumns(startColumn, numColumns)`

Establece el ancho de todas las columnas a partir de la posición determinada para ajustarse a su contenido.

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

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

Parámetros

Nombre	Tipo	Descripción
`startColumn`	`Integer`	La columna inicial para la que se cambiará el tamaño automáticamente.
`numColumns`	`Integer`	La cantidad de columnas para las que se cambiará automáticamente el tamaño.

Volver

Sheet: Esta hoja, 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

`autoResizeRows(startRow, numRows)`

Establece la altura de todas las filas a partir de la posición de la fila determinada para que se ajuste a su contenido.

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

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

Parámetros

Nombre	Tipo	Descripción
`startRow`	`Integer`	La fila inicial para cambiar el tamaño automáticamente.
`numRows`	`Integer`	La cantidad de filas para cambiar el tamaño automáticamente.

Volver

Sheet: Esta hoja, 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 la hoja de información de contenido y formato.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clear();

Volver

Sheet: Indica la hoja borrada.

Autorización

Las secuencias de comandos que usan este método requieren 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 la hoja de contenido o el formato, según se especifica en las opciones avanzadas indicadas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.clear({ formatOnly: true, contentsOnly: true });

Parámetros

Nombre	Tipo	Descripción
`options`	`Object`	Mapa de JavaScript con las opciones avanzadas que se indican a continuación.

Parámetros avanzados

Nombre	Tipo	Descripción
`contentsOnly`	`Boolean`	Especifica si se debe borrar el contenido.
`formatOnly`	`Boolean`	Establece si se debe borrar el formato.

Volver

Sheet: Esta hoja, 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

`clearConditionalFormatRules()`

Quita todas las reglas de formato condicional de la hoja. Equivale a llamar a setConditionalFormatRules(rules) con un array vacío como entrada.

var sheet = SpreadsheetApp.getActiveSheet();
sheet.clearConditionalFormatRules();

Autorización

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

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

`clearContents()`

Borra la hoja de contenido, pero conserva la información de formato.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearContents();

Volver

Sheet: Esta hoja, 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

`clearFormats()`

Borra la hoja de formato, pero conserva el contenido.

El formato se refiere a cómo se les da formato a los datos según lo permitido por las opciones en la sección "Formato". menú (p. ej., negrita, cursiva o formato condicional) y no el ancho ni la altura de las celdas.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearFormats();

Volver

Sheet: Esta hoja, 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

`clearNotes()`

Borra todas las notas de la hoja.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearNotes();

Volver

Sheet: Esta hoja, 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

`collapseAllColumnGroups()`

Contrae todos los grupos de columnas de la hoja.

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

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

Volver

Sheet: Esta hoja, 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

`collapseAllRowGroups()`

Contrae todos los grupos de filas de la hoja.

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

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

Volver

Sheet: Esta hoja, 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

`copyTo(spreadsheet)`

Copia la hoja en una hoja de cálculo determinada, que puede ser la misma hoja de cálculo que la fuente. El la hoja copiada se llama "Copia de [nombre original]".

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

var destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

Parámetros

Nombre	Tipo	Descripción
`spreadsheet`	`Spreadsheet`	La hoja de cálculo en la que se copiará esta hoja, que puede ser la misma que de la fuente.

Volver

Sheet: Es la hoja nueva 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

`createDeveloperMetadataFinder()`

Muestra un DeveloperMetadataFinder para encontrar metadatos del desarrollador dentro del permiso de esta hoja. Los metadatos se encuentran dentro del alcance de una hoja en particular si están asociados con el hoja propiamente dicha o asociada a una fila, columna o rango de esa hoja.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

Volver

DeveloperMetadataFinder: Es un buscador de metadatos del desarrollador para buscar metadatos dentro del alcance de esta hoja.

`createTextFinder(findText)`

Crea un buscador de texto para la hoja, que puede buscar y reemplazar texto dentro de la hoja.

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

// Creates  a text finder.
var textFinder = sheet.createTextFinder('dog');

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

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

Parámetros

Nombre	Tipo	Descripción
`findText`	`String`	El texto que se va a buscar

Volver

TextFinder: Es el TextFinder de la hoja.

`deleteColumn(columnPosition)`

Borra la columna en la posición dada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la columna, que comienza en 1 para la primera columna.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`deleteColumns(columnPosition, howMany)`

Borra una cantidad de columnas que comienzan en la posición determinada de la columna.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la primera columna que se borrará.
`howMany`	`Integer`	La cantidad de columnas que se borrará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

`deleteRow(rowPosition)`

Elimina la fila en la posición de fila especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	La posición de la fila, que comienza en 1 para la primera fila.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`deleteRows(rowPosition, howMany)`

Elimina una cantidad de filas que comienzan en la posición de fila especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	La posición de la primera fila que se borrará.
`howMany`	`Integer`	La cantidad de filas que se borrará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

`expandAllColumnGroups()`

Expande todos los grupos de columnas en la hoja. Este método requiere al menos un grupo de columnas.

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

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

Volver

Sheet: Esta hoja, 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

`expandAllRowGroups()`

Expande todos los grupos de filas en la hoja. Este método requiere al menos un grupo de filas.

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

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

Volver

Sheet: Esta hoja, 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

`expandColumnGroupsUpToDepth(groupDepth)`

Expande todos los grupos de columnas hasta la profundidad determinada y contrae todos los demás.

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

// All column groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandColumnGroupsUpToDepth(2);

Parámetros

Nombre	Tipo	Descripción
`groupDepth`	`Integer`	Es la profundidad del grupo hasta la que se expanden los grupos de columnas.

Volver

Sheet: Esta hoja, 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

`expandRowGroupsUpToDepth(groupDepth)`

Expande todos los grupos de filas hasta la profundidad determinada y contrae todos los demás.

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

// All row groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandRowGroupsUpToDepth(2);

Parámetros

Nombre	Tipo	Descripción
`groupDepth`	`Integer`	La profundidad del grupo hasta la que se expandirán los grupos de filas.

Volver

Sheet: Esta hoja, 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

`getActiveCell()`

Muestra la celda activa en esta hoja.

Nota: Es preferible usar getCurrentCell(), que muestra el valor actual celda destacada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

Volver

Range: Es la celda activa actual.

Autorización

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

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

`getActiveRange()`

Muestra el rango seleccionado en la hoja activa o null si no hay ningún rango activo. Si cuando se seleccionan varios rangos, este método devuelve solo el último rango seleccionado.

El término "rango activo" se refiere al rango que un usuario seleccionó en la hoja activa pero, en una función personalizada, se refiere a la celda que se vuelve a calcular de forma activa.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

Volver

Range: Es el rango activo.

Autorización

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

setActiveRange(range)

`getActiveRangeList()`

Muestra la lista de rangos activos en la hoja activa o null si no hay ningún rango activo o rangos.

Si hay un solo rango seleccionado, se comporta como una llamada getActiveRange().

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

Volver

RangeList: Es la lista de rangos activos.

Autorización

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

setActiveRangeList(rangeList)

`getBandings()`

Devuelve todas las bandas en esta hoja.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

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

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Volver

Banding[]: Todas las bandas de esta hoja.

Autorización

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

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

`getCharts()`

Muestra un array de gráficos en esta hoja.

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

for (var i in charts) {
  var chart = charts[i];
  // Do something with the chart
}

Volver

EmbeddedChart[]: Indica un array 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

`getColumnGroup(columnIndex, groupDepth)`

Muestra el grupo de columnas en el índice y la profundidad del grupo determinados.

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

// Returns the group whose control index is at column 2 and has a depth of 1, or
// null if the group doesn’t exist.
var columnGroup = sheet.getColumnGroup(2, 1);

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	El índice de columna del botón de activación del control de grupo o un índice dentro del grupo.
`groupDepth`	`Integer`	La profundidad del grupo.

Volver

Group: Es el grupo de columnas en el índice y la profundidad de control, o arroja una excepción si el grupo no existe.

Autorización

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

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

`getColumnGroupControlPosition()`

Muestra el GroupControlTogglePosition de todos los grupos de columnas de la hoja.

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

// GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the
// group.
var columnGroupControlPosition = sheet.getColumnGroupControlPosition();

Volver

GroupControlTogglePosition: true si el botón de activación del control de agrupación de columnas se muestra después del grupo en esta hoja de cálculo y, 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

`getColumnGroupDepth(columnIndex)`

Muestra la profundidad del grupo de la columna en el índice determinado.

La profundidad del grupo indica cuántos grupos se superponen con la columna. Puede variar entre cero y ocho.

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

// 1 if there is a group over columns 1 through 3
var groupDepth = sheet.getColumnGroupDepth(1);

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	El índice de la columna.

Volver

Integer: la profundidad del grupo de la columna en el índice determinado.

Autorización

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

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

`getColumnWidth(columnPosition)`

Obtiene el ancho en píxeles de la columna determinada.

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

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la columna que se debe examinar.

Volver

Integer: Ancho de columna en píxeles

Autorización

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

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

`getConditionalFormatRules()`

Obtén todas las reglas de formato condicional en esta hoja.

// Logs the conditional format rules in a sheet.
var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (var i = 0; i < rules.length; i++) {
  var rule = rules[i];
  Logger.log(rule);
}

Volver

ConditionalFormatRule[]: Es un array de todas las reglas de la hoja.

Autorización

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

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

`getCurrentCell()`

Muestra la celda actual en la hoja activa o null si no hay una celda actual. El la celda actual es la que está enfocada en la IU de Hojas de cálculo de Google y está destacada con una luz borde. Nunca hay más de una celda actual. Cuando un usuario selecciona uno o más rangos de celdas, una de las celdas de la selección es la celda actual.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = sheet.getCurrentCell();

Volver

Range: Es la celda actual.

Autorización

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

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

`getDataRange()`

Muestra un objeto Range que corresponde a las dimensiones en las que están presentes los datos.

Esto es funcionalmente equivalente a crear un rango delimitado por A1 y (Sheet.getLastColumn(), Sheet.getLastRow()).

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

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

Volver

Range: Un rango que consta de todos los datos 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

`getDataSourceFormulas()`

Obtiene todas las fórmulas de fuente de datos.

// Opens the spreadsheet by its ID. If you created your script from within 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 an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

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

Volver

DataSourceFormula[]: Es una lista de fórmulas 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

`getDataSourcePivotTables()`

Obtiene todas las tablas dinámicas de la 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 an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.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.

// 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 an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].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

`getDeveloperMetadata()`

Obtén todos los metadatos del desarrollador asociados con esta hoja.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

Volver

DeveloperMetadata[]: Son los metadatos del desarrollador asociados con esta hoja.

Autorización

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

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

`getDrawings()`

Devuelve una matriz de dibujos en la hoja.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

 // Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

Volver

Drawing[]: Es la lista de dibujos de esta hoja.

Autorización

Las secuencias de comandos que usan este método requieren 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 esta hoja o null si no hay ningún filtro.

// Gets the filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.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

`getFormUrl()`

Muestra la URL del formulario que envía sus respuestas a esta hoja o null si esta la hoja no tiene ningún formulario asociado.

var sheet = SpreadsheetApp.getActiveSheet();
var url = sheet.getFormUrl();

Volver

String: Es la URL del formulario que coloca sus respuestas en esta hoja, o null si se trata de la hoja no tiene un formulario asociado.

Autorización

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

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

`getFrozenColumns()`

Muestra el número de columnas inmovilizadas.

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

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

Volver

Integer: La cantidad de columnas inmovilizadas

Autorización

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

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

`getFrozenRows()`

Muestra el número de filas inmovilizadas.

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

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

Volver

Integer: Es la cantidad de filas inmovilizadas.

Autorización

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

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

`getImages()`

Muestra todas las imágenes sobre la cuadrícula de la hoja.

// Opens the spreadsheet file 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 over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

Volver

OverGridImage[]: Es un array de imágenes sobre la cuadrícula.

Autorización

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

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

`getIndex()`

Obtiene la posición de la hoja en la hoja de cálculo principal. Desde 1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
var sheet = ss.getSheets()[0];
// ... because spreadsheets are 1-indexed
Logger.log(sheet.getIndex());

Volver

Integer: Indica la posición de la hoja en su hoja de cálculo 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

`getLastColumn()`

Muestra la posición de la última columna que tiene contenido.

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Volver

Integer: Es la última columna de la hoja que incluye 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

`getLastRow()`

Muestra la posición de la última fila que tiene contenido.

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Volver

Integer: Es la última fila de la hoja que incluye 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

`getMaxColumns()`

Muestra el número actual de columnas en la hoja, independientemente del contenido.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxColumns());

Volver

Integer: Es el ancho máximo de la hoja.

Autorización

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

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

`getMaxRows()`

Muestra el número actual de filas en la hoja, independientemente del contenido.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxRows());

Volver

Integer: Es la altura máxima de la hoja.

Autorización

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

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

`getName()`

Muestra el nombre de la hoja.

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

Volver

String: Es el nombre de la hoja.

Autorización

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

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

`getNamedRanges()`

Obtiene todos los rangos con nombre de esta hoja.

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

Volver

NamedRange[]: Es un array de todos los rangos con nombre de la hoja.

Autorización

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

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

`getParent()`

Muestra el Spreadsheet que contiene esta hoja.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// parent is identical to ss
var parent = sheet.getParent();

Volver

Spreadsheet: Es la hoja de cálculo superior.

Autorización

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

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

`getPivotTables()`

Muestra todas las tablas dinámicas de esta hoja.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

Volver

PivotTable[]: Son las tablas dinámicas de esta hoja.

Autorización

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

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

`getProtections(type)`

Obtiene un array de objetos que representan todos los rangos protegidos de la hoja o un solo elemento. array que representa la protección de la propia hoja.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var sheet = SpreadsheetApp.getActiveSheet();
var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove sheet protection from the active sheet, if the user has permission to edit it.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection && protection.canEdit()) {
  protection.remove();
}

Parámetros

Nombre	Tipo	Descripción
`type`	`ProtectionType`	El tipo de área protegida, ya sea `SpreadsheetApp.ProtectionType.RANGE` o `SpreadsheetApp.ProtectionType.SHEET`

Volver

Protection[]: Es un array de objetos que representa todos los rangos protegidos de la hoja o un solo elemento. array que representa la protección de la propia hoja.

Autorización

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

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

`getRange(row, column)`

Muestra el rango con la celda superior izquierda en las coordenadas especificadas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
var range = sheet.getRange(1, 1);
var values = range.getValues();
Logger.log(values[0][0]);

Parámetros

Nombre	Tipo	Descripción
`row`	`Integer`	El índice de fila de la celda que se va a mostrar la indexación de filas comienza con 1.
`column`	`Integer`	El índice de columna de la celda que se va a mostrar la indexación de columnas comienza con 1.

Volver

Range: Indica un rango que contiene solo 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

`getRange(row, column, numRows)`

Devuelve el rango con la celda superior izquierda en las coordenadas determinadas y con el número determinado de filas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is returned.
var range = sheet.getRange(1, 1, 3);
var values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parámetros

Nombre	Tipo	Descripción
`row`	`Integer`	El índice de fila inicial del rango; la indexación de filas comienza con 1.
`column`	`Integer`	El índice de columna del rango; la indexación de columnas comienza con 1.
`numRows`	`Integer`	Número de filas que se mostrarán.

Volver

Range: Es un rango que contiene una sola columna de datos con la cantidad de filas especificada.

Autorización

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

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

`getRange(row, column, numRows, numColumns)`

Devuelve el rango con la celda superior izquierda en las coordenadas determinadas con el número de filas determinado. y columnas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 3, 3);
var values = range.getValues();

// Print values from a 3x3 box.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parámetros

Nombre	Tipo	Descripción
`row`	`Integer`	El índice de fila inicial del rango; la indexación de filas comienza con 1.
`column`	`Integer`	El índice de columna inicial del rango; la indexación de columnas comienza con 1.
`numRows`	`Integer`	Número de filas que se mostrarán.
`numColumns`	`Integer`	Número de columnas que se mostrarán.

Volver

Range: Indica un rango que corresponde al área especificada.

Autorización

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

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

`getRange(a1Notation)`

Muestra el rango como se especifica en la notación A1 o en la notación R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

Parámetros

Nombre	Tipo	Descripción
`a1Notation`	`String`	Rango que se va a mostrar, como se especifica en la notación A1 o en la notación R1C1.

Volver

Range: Es el rango en la ubicación designada.

Autorización

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

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

`getRangeList(a1Notations)`

Devuelve la colección RangeList que representa los rangos de la misma hoja especificada. con una lista no vacía de notaciones A1 o R1C1.

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

Parámetros

Nombre	Tipo	Descripción
`a1Notations`	`String[]`	La lista de rangos que se mostrarán, como se especifica en la notación A1 o en la notación R1C1.

Volver

RangeList: Es la lista de rangos en la ubicación designada.

Autorización

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

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

`getRowGroup(rowIndex, groupDepth)`

Muestra el grupo de filas en el índice y la profundidad del grupo especificados.

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

// Returns the group whose control index is at row 2 and has a depth of 1, or
// null if the group doesn’t exist.
var rowGroup = sheet.getRowGroup(2, 1);

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	El índice de fila del botón de activación del control de grupo o un índice dentro del grupo.
`groupDepth`	`Integer`	La profundidad del grupo.

Volver

Group: Es el grupo de filas en el índice y la profundidad de control, o arroja una excepción si el grupo no existe.

Autorización

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

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

`getRowGroupControlPosition()`

Muestra el GroupControlTogglePosition de todos los grupos de filas de la hoja.

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

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the
// group.
var rowGroupControlPosition = sheet.getRowGroupControlPosition();

Volver

GroupControlTogglePosition: true si el botón de activación del control de agrupación de filas se muestra después del grupo en esta hoja y, 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

`getRowGroupDepth(rowIndex)`

Muestra la profundidad del grupo de la fila en el índice determinado.

La profundidad del grupo indica cuántos grupos se superponen con la fila. Puede ser un valor entre cero y ocho.

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

// 1 if there is a group over rows 1 through 3
var groupDepth = sheet.getRowGroupDepth(1);

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	El índice de la fila.

Volver

Integer: la profundidad del grupo de la fila en el índice determinado.

Autorización

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

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

`getRowHeight(rowPosition)`

Obtiene la altura en píxeles de la fila determinada.

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

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	La posición de la fila que se debe examinar.

Volver

Integer: La altura de las filas en píxeles

Autorización

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

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

`getSelection()`

Muestra el Selection actual en la hoja de cálculo.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var currentCell = selection.getCurrentCell();

Volver

Selection: Es la selección actual.

Autorización

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

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

`getSheetId()`

Devuelve el ID de la hoja representada por este objeto.

Este es un ID de hoja que es exclusivo de la hoja de cálculo. El ID es una forma monótona Es un número entero creciente que se asigna al momento de crear la hoja y que es independiente de su posición. Esta es útil junto con métodos como Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd), que toman un parámetro gridId en lugar de una instancia Sheet.

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

Logger.log(sheet.getSheetId());

Volver

Integer: Es un ID de la hoja único 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

`getSheetName()`

Muestra el nombre de la hoja.

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

Logger.log(sheet.getSheetName());

Volver

String: Es el nombre de la hoja.

Autorización

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

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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

Muestra la cuadrícula rectangular de valores para este rango a partir de las coordenadas proporcionadas. A -1 valor dado que la posición de la fila o columna es equivalente a obtener la última fila o columna que tiene datos en la hoja.

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

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Parámetros

Nombre	Tipo	Descripción
`startRow`	`Integer`	La posición de la fila inicial.
`startColumn`	`Integer`	La posición de la columna inicial.
`numRows`	`Integer`	La cantidad de filas para las que se mostrarán valores.
`numColumns`	`Integer`	La cantidad de columnas para las que se muestran valores.

Volver

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

Autorización

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

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

`getSlicers()`

Muestra un array de controles de filtro en la hoja.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

Volver

Slicer[]: Es la lista de controles de filtro de esta hoja.

Autorización

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

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

`getTabColorObject()`

Obtiene el color de la pestaña de la hoja, o null si la pestaña de la hoja no tiene color.

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = first.getTabColorObject();

Volver

Color: Indica el color de la pestaña de la hoja, o null si la pestaña de la hoja no tiene color.

Autorización

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

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

`getType()`

Devuelve el tipo de hoja.

El tipo de hoja predeterminado es SheetType.GRID. Es una hoja que contiene un solo elemento como EmbeddedChart, es una hoja SheetType.OBJECT.

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

Volver

SheetType: Es el tipo de hoja.

Autorización

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

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

`hasHiddenGridlines()`

Muestra true si las líneas de cuadrícula de la hoja están ocultas. De lo contrario, muestra false. Las líneas de cuadrícula son visibles de forma predeterminada.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if the spreadsheet has hidden gridelines and logs the result to the console.
console.log(sheet.hasHiddenGridlines());

Volver

Boolean: true si las líneas de cuadrícula están ocultas; 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

`hideColumn(column)`

Oculta las columnas del rango especificado.

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

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

Parámetros

Nombre	Tipo	Descripción
`column`	`Range`	El rango de columnas que se ocultará.

Autorización

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

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

`hideColumns(columnIndex)`

Oculta una sola columna en el índice determinado. Usa el índice 1 para este método.

Para ocultar más de una columna con un índice, usa hideColumns(columnIndex, numColumns).

Para ocultar más de una columna con un rango, usa hideColumn().

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	El índice de la columna que se ocultará.

Autorización

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

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

`hideColumns(columnIndex, numColumns)`

Oculta una o más columnas consecutivas a partir del índice determinado. Usa el índice 1 para este método.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	El índice inicial de las columnas que se ocultarán.
`numColumns`	`Integer`	Número de columnas que se ocultará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

`hideRow(row)`

Oculta las filas en el rango especificado.

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

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

Parámetros

Nombre	Tipo	Descripción
`row`	`Range`	El rango de filas que se ocultará.

Autorización

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

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

`hideRows(rowIndex)`

Oculta la fila en el índice determinado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	El índice de la fila que se ocultará.

Autorización

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

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

`hideRows(rowIndex, numRows)`

Oculta una o más filas consecutivas que comienzan en el índice determinado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	El índice inicial de las filas que se ocultarán.
`numRows`	`Integer`	La cantidad de filas que se ocultará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

`hideSheet()`

Oculta esta hoja. No tiene ningún efecto si la hoja ya está oculta. Si se llama a este método en la solo una hoja visible, arroja una excepción.

var sheet = SpreadsheetApp.getActiveSheet();
sheet.hideSheet();

Volver

Sheet: Es la hoja actual.

Autorización

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

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

`insertChart(chart)`

Agrega un gráfico nuevo a esta hoja.

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B4"))
    .setPosition(5, 5, 0, 0)
    .setOption("title", "Dynamic Chart")
    .build();
sheet.insertChart(chart);

Parámetros

Nombre	Tipo	Descripción
`chart`	`EmbeddedChart`	El gráfico que se insertará.

Autorización

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

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

`insertColumnAfter(afterPosition)`

Inserta una columna después de la posición dada de la columna.

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

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	Columna después de la cual se debe agregar la nueva columna.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`insertColumnBefore(beforePosition)`

Inserta una columna antes de la posición de la columna especificada.

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

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	La columna antes de la que se debe agregar la nueva columna.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`insertColumns(columnIndex)`

Inserta una columna en blanco en una hoja en la ubicación especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	El índice que indica dónde insertar una columna.

Autorización

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

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

`insertColumns(columnIndex, numColumns)`

Inserta una o más columnas en blanco consecutivas en una hoja a partir de la ubicación especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	El índice que indica dónde insertar una columna.
`numColumns`	`Integer`	Número de columnas que se insertará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

`insertColumnsAfter(afterPosition, howMany)`

Inserta un número determinado de columnas después de la posición de la columna especificada.

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

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	Columna después de la cual se debe agregar la nueva columna.
`howMany`	`Integer`	Número de columnas que se insertarán.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`insertColumnsBefore(beforePosition, howMany)`

Inserta una cantidad de columnas antes de la posición de la columna especificada.

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

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	La columna antes de la que se debe agregar la nueva columna.
`howMany`	`Integer`	Número de columnas que se insertarán.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`insertImage(blobSource, column, row)`

Inserta un objeto BlobSource como imagen en el documento en una fila y columna determinadas. La imagen el tamaño se recupera del contenido del BLOB. El tamaño máximo permitido para un BLOB es 2 MB.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parámetros

Nombre	Tipo	Descripción
`blobSource`	`BlobSource`	El BLOB que incluye el contenido de la imagen, el tipo de MIME y el nombre (opcional).
`column`	`Integer`	La posición de la columna.
`row`	`Integer`	La posición de la fila.

Volver

OverGridImage: Es la imagen insertada.

Autorización

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

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

`insertImage(blobSource, column, row, offsetX, offsetY)`

Inserta un elemento BlobSource como imagen en el documento en una fila y columna determinadas, con un desplazamiento de píxeles. El tamaño de la imagen se recupera del contenido del BLOB. El BLOB máximo admitido es de 2 MB.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parámetros

Nombre	Tipo	Descripción
`blobSource`	`BlobSource`	El BLOB que incluye el contenido de la imagen, el tipo de MIME y el nombre (opcional).
`column`	`Integer`	La posición de la columna.
`row`	`Integer`	La posición de la fila.
`offsetX`	`Integer`	Desplazamiento horizontal a partir de la esquina de la celda en píxeles.
`offsetY`	`Integer`	Desplazamiento vertical desde la esquina de la celda en píxeles.

Volver

OverGridImage: Es la imagen insertada.

Autorización

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

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

`insertImage(url, column, row)`

Inserta una imagen en el documento en una fila y columna determinadas.

La URL proporcionada debe ser de acceso público.

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

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	Es la URL de la imagen.
`column`	`Integer`	La posición de la columna de la cuadrícula.
`row`	`Integer`	La posición de la fila de la cuadrícula.

Volver

OverGridImage: Es la imagen insertada.

Autorización

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

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

`insertImage(url, column, row, offsetX, offsetY)`

Inserta una imagen en el documento en una fila y columna determinadas, con desplazamiento de píxeles.

La URL proporcionada debe ser de acceso público.

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

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	Es la URL de la imagen.
`column`	`Integer`	La posición de la columna.
`row`	`Integer`	La posición de la fila.
`offsetX`	`Integer`	Desplazamiento horizontal a partir de la esquina de la celda en píxeles.
`offsetY`	`Integer`	Desplazamiento vertical desde la esquina de la celda en píxeles.

Volver

OverGridImage: Es la imagen insertada.

Autorización

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

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

`insertRowAfter(afterPosition)`

Inserta una fila después de la posición de fila especificada.

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

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	La fila después de la cual se debe agregar la nueva fila.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`insertRowBefore(beforePosition)`

Inserta una fila antes de la posición de fila especificada.

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

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	La fila antes de la cual se debe agregar la nueva fila.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`insertRows(rowIndex)`

Inserta una fila en blanco en una hoja en la ubicación especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	El índice que indica dónde insertar una fila.

Autorización

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

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

`insertRows(rowIndex, numRows)`

Inserta una o más filas en blanco consecutivas en una hoja a partir de la ubicación especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	El índice que indica dónde insertar una fila.
`numRows`	`Integer`	La cantidad de filas que se insertará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

`insertRowsAfter(afterPosition, howMany)`

Inserta una cantidad de filas después de la posición de fila especificada.

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

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	La fila después de la cual se deben agregar las nuevas filas.
`howMany`	`Integer`	La cantidad de filas que se insertarán.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`insertRowsBefore(beforePosition, howMany)`

Inserta una cantidad de filas antes de la posición de fila especificada.

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

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	La fila antes de la que se deben agregar las filas nuevas.
`howMany`	`Integer`	La cantidad de filas que se insertarán.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`insertSlicer(range, anchorRowPos, anchorColPos)`

Agrega un nuevo control de filtro a la hoja.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

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

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Parámetros

Nombre	Tipo	Descripción
`range`	`Range`	El rango en el que se crea el control de filtro.
`anchorRowPos`	`Integer`	La parte superior del control de filtro está anclada en esta fila.
`anchorColPos`	`Integer`	La parte superior del control de filtro está anclada en esta columna.

Volver

Slicer: Es el control de filtro que se acaba de insertar.

Autorización

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

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

`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`

Agrega un nuevo control de filtro a la hoja.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

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

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Parámetros

Nombre	Tipo	Descripción
`range`	`Range`	El rango en el que se crea el control de filtro.
`anchorRowPos`	`Integer`	La parte superior del control de filtro está anclada en esta fila.
`anchorColPos`	`Integer`	La parte superior del control de filtro está anclada en esta columna.
`offsetX`	`Integer`	Desplazamiento horizontal a partir de la esquina de la celda en píxeles.
`offsetY`	`Integer`	Desplazamiento vertical desde la esquina de la celda en píxeles.

Volver

Slicer: Es el control de filtro que se acaba de insertar.

Autorización

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

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

`isColumnHiddenByUser(columnPosition)`

Muestra si el usuario ocultó la columna especificada.

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

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la columna que se debe examinar.

Volver

Boolean: true si la columna está oculta, 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

`isRightToLeft()`

Muestra true si este diseño de hoja es de derecha a izquierda. Muestra false si la hoja usa el diseño predeterminado de izquierda a derecha.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if a spreadsheet is ordered from right to left and logs the result to the console.
console.log(sheet.isRightToLeft());

Volver

Boolean: true si es de derecha a izquierda; 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

`isRowHiddenByFilter(rowPosition)`

Muestra si un filtro (no una vista de filtro) ocultó la fila especificada.

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	La posición de la fila que se debe examinar.

Volver

Boolean: true si la fila está oculta; 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

`isRowHiddenByUser(rowPosition)`

Muestra si el usuario ocultó la fila especificada.

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	La posición de la fila que se debe examinar.

Volver

Boolean: true si la fila está oculta; 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

`isSheetHidden()`

Muestra true si la hoja está oculta actualmente.

var sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

Volver

Boolean: true si la hoja está oculta; 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

`moveColumns(columnSpec, destinationIndex)`

Mueve las columnas seleccionadas por el rango dado a la posición indicada por destinationIndex. El columnSpec en sí no tiene que representar de manera exacta un columna o grupo de columnas que se moverán: se seleccionan todas las columnas que abarca el rango.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
var columnSpec = sheet.getRange("A1:B1");
sheet.moveColumns(columnSpec, 5);

Parámetros

Nombre	Tipo	Descripción
`columnSpec`	`Range`	Un rango que abarca las columnas que se deben mover.
`destinationIndex`	`Integer`	El índice al que se deben mover las columnas. Ten en cuenta que este índice según las coordenadas antes de que se muevan las columnas. Los datos existentes se desplazan hacia la derecha a hacer lugar para las columnas movidas, mientras que las columnas de origen se quitan de la cuadrícula. Por lo tanto, los datos pueden terminar en un índice diferente al que se especificó en un principio.

Autorización

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

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

`moveRows(rowSpec, destinationIndex)`

Mueve las filas seleccionadas por el rango determinado a la posición indicada por destinationIndex. El rowSpec no tiene que representar exactamente una fila completa. o grupo de filas que se moverán, se seleccionan todas las filas que abarca el rango.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
var rowSpec = sheet.getRange("A1:A2");
sheet.moveRows(rowSpec, 5);

Parámetros

Nombre	Tipo	Descripción
`rowSpec`	`Range`	Un rango que abarca las filas que se deben mover.
`destinationIndex`	`Integer`	El índice al que se deben mover las filas. Ten en cuenta que este índice según las coordenadas antes de que se muevan las filas. Los datos existentes se desplazan hacia abajo para hacer espacio para las filas que se movieron, mientras que las filas de origen se quitan de la cuadrícula. Por lo tanto, el es posible que los datos terminen en un índice diferente del que se especificó en un principio.

Autorización

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

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

`newChart()`

Muestra un compilador para crear un gráfico nuevo para esta hoja.

En este ejemplo, se muestra cómo crear un gráfico nuevo:

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

Volver

EmbeddedChartBuilder: Es un compilador que sirve para crear un gráfico nuevo.

`protect()`

Crea un objeto que puede impedir que se edite la hoja, excepto por los usuarios que hayan permiso. Hasta que la secuencia de comandos cambie la lista de editores de la hoja (llamando a Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user) o Protection.addEditors(emailAddresses), o puedes establecer una nueva valor para Protection.setDomainEdit(editable)), los permisos replican los de la hoja de cálculo propiamente dicha, lo que efectivamente significa que la hoja permanece desprotegida. Si la hoja es ya está protegido, muestra un objeto que representa su configuración de protección existente. Una hoja protegida puede incluir regiones desprotegidas.

// Protect the active sheet, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.protect().setDescription('Sample protected sheet');

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

Volver

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

Autorización

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

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

`removeChart(chart)`

Quita un gráfico de la hoja superior.

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

// This removes all the embedded charts from the spreadsheet
var charts = sheet.getCharts();
for (var i in charts) {
  sheet.removeChart(charts[i]);
}

Parámetros

Nombre	Tipo	Descripción
`chart`	`EmbeddedChart`	El gráfico que se quitará.

Autorización

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

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

`setActiveRange(range)`

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

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

Parámetros

Nombre	Tipo	Descripción
`range`	`Range`	El rango que se establecerá como activo.

Volver

Range: Es el rango recién activo.

Autorización

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

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

`setActiveRangeList(rangeList)`

Establece la lista especificada de rangos como active ranges en el hoja activa. El último rango de la lista se establece como active range.

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

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

Parámetros

Nombre	Tipo	Descripción
`rangeList`	`RangeList`	La lista de rangos para seleccionar.

Volver

RangeList: Es la lista de rangos recién seleccionada.

Autorización

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

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

`setActiveSelection(range)`

Establece la región de selección activa para esta hoja.

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

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

Parámetros

Nombre	Tipo	Descripción
`range`	`Range`	El rango que se establecerá como la selección activa.

Volver

Range: Es el rango recién activo.

Autorización

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

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

`setActiveSelection(a1Notation)`

Establece la selección activa, como se especifica en la notación A1 o la notación R1C1.

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

sheet.setActiveSelection("A1:D4");

Parámetros

Nombre	Tipo	Descripción
`a1Notation`	`String`	El rango que se establecerá como activo, según se especifica en la notación A1 o la notación R1C1.

Volver

Range: Es el rango recién activo.

Autorización

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

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

`setColumnGroupControlPosition(position)`

Establece la posición del control de activación de grupo de columnas en la hoja.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);

Parámetros

Nombre	Tipo	Descripción
`position`	`GroupControlTogglePosition`	La posición del control de activación del grupo de columnas.

Volver

Sheet: Esta hoja, 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

`setColumnWidth(columnPosition, width)`

Establece el ancho de la columna determinada en píxeles.

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

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la columna determinada que se establecerá.
`width`	`Integer`	Es el ancho en píxeles que se establecerá.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`setColumnWidths(startColumn, numColumns, width)`

Establece el ancho de las columnas determinadas en píxeles.

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

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

Parámetros

Nombre	Tipo	Descripción
`startColumn`	`Integer`	La posición de la columna inicial que se cambiará.
`numColumns`	`Integer`	Número de columnas que se cambiarán.
`width`	`Integer`	Es el ancho en píxeles que se establecerá.

Volver

Sheet: Esta hoja, 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

`setConditionalFormatRules(rules)`

Reemplaza todas las reglas de formato condicional existentes en la hoja por las reglas de entrada. Las reglas se evalúan en su orden de entrada.

// Remove one of the existing conditional format rules.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
rules.splice(1, 1); // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

Parámetros

Nombre	Tipo	Descripción
`rules`	`ConditionalFormatRule[]`	Las nuevas reglas de formato condicional

Autorización

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

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

`setCurrentCell(cell)`

Establece la celda especificada como current cell.

Si la celda especificada se encuentra en un rango ya seleccionado, ese rango se convierte en rango activo con la celda como celda actual.

Si la celda especificada no está presente en ningún rango seleccionado, entonces cualquier selección existente se 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.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

Parámetros

Nombre	Tipo	Descripción
`cell`	`Range`	La celda que se establecerá como la celda actual.

Volver

Range: Es la celda actual recién configurada.

Autorización

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

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

`setFrozenColumns(columns)`

Inmoviliza el número determinado de columnas. Si es cero, no se inmoviliza ninguna columna.

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

// Freezes the first column
sheet.setFrozenColumns(1);

Parámetros

Nombre	Tipo	Descripción
`columns`	`Integer`	La cantidad de columnas que se inmovilizará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

`setFrozenRows(rows)`

Inmoviliza la cantidad de filas especificada. Si es cero, no se inmovilizará ninguna fila.

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

// Freezes the first row
sheet.setFrozenRows(1);

Parámetros

Nombre	Tipo	Descripción
`rows`	`Integer`	La cantidad de filas que se inmovilizará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

`setHiddenGridlines(hideGridlines)`

Oculta o muestra las líneas de cuadrícula de la hoja.

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

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

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

Parámetros

Nombre	Tipo	Descripción
`hideGridlines`	`Boolean`	Si es `true`, ocultar las líneas de cuadrícula en esta hoja. De lo contrario, muestra las líneas de cuadrícula.

Volver

Sheet: Esta hoja, 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

`setName(name)`

Establece el nombre de la hoja.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setName("not first anymore");

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre nuevo de la hoja.

Volver

Sheet: Esta hoja, 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

`setRightToLeft(rightToLeft)`

Establece o anula la configuración del diseño de hoja de derecha a izquierda.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

Parámetros

Nombre	Tipo	Descripción
`rightToLeft`	`Boolean`	Si es `true`, el diseño de la hoja se establece de derecha a izquierda, con la celda A1 en en la esquina superior derecha. Si es `false`, el diseño de la hoja se establece como predeterminado. de izquierda a derecha, con la celda A1 en la parte superior izquierda.

Volver

Sheet: Esta hoja, 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

`setRowGroupControlPosition(position)`

Establece la posición del control de activación de grupo de filas en la hoja.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);

Parámetros

Nombre	Tipo	Descripción
`position`	`GroupControlTogglePosition`	La posición del control de activación del grupo de filas.

Volver

Sheet: Esta hoja, 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

`setRowHeight(rowPosition, height)`

Establece la altura de la fila determinada en píxeles. De forma predeterminada, las filas se expanden para ajustarse al contenido de las celdas. Si Si deseas forzar las filas a una altura específica, usa setRowHeightsForced(startRow, numRows, height).

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	La posición de la fila que se cambiará.
`height`	`Integer`	Indica la altura en píxeles que se debe establecer.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`setRowHeights(startRow, numRows, height)`

Establece la altura de las filas determinadas en píxeles. De forma predeterminada, las filas se expanden para ajustarse al contenido de las celdas. Si si quieres forzar las filas a una altura específica, usa setRowHeightsForced(startRow, numRows, height).

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

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

Parámetros

Nombre	Tipo	Descripción
`startRow`	`Integer`	La posición de la fila inicial que se cambiará.
`numRows`	`Integer`	Número de filas que se cambiarán.
`height`	`Integer`	Indica la altura en píxeles que se debe establecer.

Volver

Sheet: Esta hoja, 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

`setRowHeightsForced(startRow, numRows, height)`

Establece la altura de las filas determinadas en píxeles. De forma predeterminada, las filas se expanden para ajustarse al contenido de las celdas. Cuándo Si usas setRowHeightsForced, las filas se fuerzan a la altura especificada aun si la el contenido de la celda sea más alto que la altura de la fila.

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

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

Parámetros

Nombre	Tipo	Descripción
`startRow`	`Integer`	La posición de la fila inicial que se cambiará.
`numRows`	`Integer`	Número de filas que se cambiarán.
`height`	`Integer`	Indica la altura en píxeles que se debe establecer.

Volver

Sheet: Esta hoja, 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

`setTabColor(color)`

Establece el color de la pestaña de la hoja.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setTabColor("ff0000"); // Set the color to red.
first.setTabColor(null); // Unset the color.

Parámetros

Nombre	Tipo	Descripción
`color`	`String`	Un código de color en notación CSS (como `'#ffffff'` o `'white'`) `null` para restablecer el color de la pestaña.

Volver

Sheet: Esta hoja, 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

`setTabColorObject(color)`

Establece el color de la pestaña de la hoja.

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
first.setTabColorObject(color); // Set the color to theme accent 1.
first.setTabColorObject(null); // Unset the color.

Parámetros

Nombre	Tipo	Descripción
`color`	`Color`	El color de pestaña de la hoja que se establecerá.

Volver

Sheet: Esta hoja, 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

`showColumns(columnIndex)`

Muestra la columna en el índice dado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	El índice de la columna que se mostrará.

Autorización

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

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

`showColumns(columnIndex, numColumns)`

Muestra una o más columnas consecutivas a partir del índice determinado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	El índice inicial de las columnas que se mostrarán.
`numColumns`	`Integer`	La cantidad de columnas que se mostrará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

`showRows(rowIndex)`

Muestra la fila en el índice determinado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	El índice de la fila que se mostrará.

Autorización

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

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

`showRows(rowIndex, numRows)`

Muestra una o más filas consecutivas a partir del índice determinado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	El índice inicial de las filas que se mostrarán.
`numRows`	`Integer`	La cantidad de filas que se mostrará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

`showSheet()`

Hace que la hoja sea visible. No tiene ningún efecto si la hoja ya está visible.

var sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

Volver

Sheet: Es la hoja actual.

Autorización

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

Ordena una hoja por columna, de forma ascendente.

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La columna por la que se va a ordenar.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

Ordena una hoja por columna. Toma un parámetro para especificar el orden ascendente o descendente.

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La columna por la que se va a ordenar.
`ascending`	`Boolean`	`true` para orden ascendente, `false` para orden descendente.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

Autorización

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

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

`unhideColumn(column)`

Muestra la columna en el rango especificado.

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

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

Parámetros

Nombre	Tipo	Descripción
`column`	`Range`	El rango que se mostrará, si está oculto.

Autorización

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

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

`unhideRow(row)`

Muestra la fila en el rango especificado.

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

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

Parámetros

Nombre	Tipo	Descripción
`row`	`Range`	El rango que se mostrará, si está oculto.

Autorización

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

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

`updateChart(chart)`

Actualiza el gráfico de esta hoja.

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

// This code is going to loop through all the charts and change them to
// column charts
var charts = sheet.getCharts();
for (var i in charts) {
  var chart = charts[i];
  var newChart = chart
      .modify()
      .setChartType(Charts.ChartType.COLUMN)
      .build();
  sheet.updateChart(newChart);
}

Parámetros

Nombre	Tipo	Descripción
`chart`	`EmbeddedChart`	El gráfico que se actualizará.

Autorización

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

`getSheetProtection()`

Obsoleto. Para las hojas de cálculo creadas en la versión más reciente de Hojas de cálculo de Google, usa getProtections(type), que muestra la clase Protection más potente. Aunque este método dejó de estar disponible, permanece disponible para compatibilidad con la versión anterior de Hojas de cálculo

Muestra una instancia de PageProtection que describe los permisos de la hoja de cálculo actual.

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

var permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser("user@example.com");

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
var users = permissions.getUsers();
Logger.log(users);

Volver

PageProtection: Es un objeto que describe los permisos de acceso a hojas 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

`getTabColor()`

Obsoleto. Se reemplazó por getTabColorObject()

Obtiene el color de la pestaña de la hoja, o null si la pestaña de la hoja no tiene color.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
var color = first.getTabColor();

Volver

String: Es el código de color en notación CSS (como '#ffffff').

Autorización

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

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

`setSheetProtection(permissions)`

Obsoleto. Para las hojas de cálculo creadas en la versión más reciente de Hojas de cálculo de Google, usa protect(), que muestra la clase Protection más potente. Si bien este método dejó de estar disponible, seguirá estando disponible para brindar compatibilidad con la versión anterior de Hojas de cálculo

Establece los permisos de la hoja actual.

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

var permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
var sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

Parámetros

Nombre	Tipo	Descripción
`permissions`	`PageProtection`	El objeto de permisos de acceso que se configurará en esta hoja.

Autorización

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

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