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 incluyen cambiar el nombre de una hoja y acceder a objetos de rango desde la hoja.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`activate()`	`Sheet`	Activa esta hoja.
`addDeveloperMetadata(key)`	`Sheet`	Agrega metadatos del desarrollador con la clave especificada a la hoja.
`addDeveloperMetadata(key, visibility)`	`Sheet`	Agrega metadatos del desarrollador con la clave y la visibilidad especificadas a la hoja.
`addDeveloperMetadata(key, value)`	`Sheet`	Agrega metadatos del desarrollador con la clave y el valor especificados a la hoja.
`addDeveloperMetadata(key, value, visibility)`	`Sheet`	Agrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados a la hoja.
`appendRow(rowContents)`	`Sheet`	Agrega una fila en la parte inferior de la región de datos actual de la hoja.
`asDataSourceSheet()`	`DataSourceSheet`	Devuelve la hoja como un objeto `DataSourceSheet` si la hoja es de tipo `SheetType.DATASOURCE` o `null` en caso contrario.
`autoResizeColumn(columnPosition)`	`Sheet`	Establece 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 de columna determinada para que se ajusten a su contenido.
`autoResizeRows(startRow, numRows)`	`Sheet`	Establece la altura de todas las filas a partir de la posición de fila determinada para que se ajusten a su contenido.
`clear()`	`Sheet`	Borra la información de contenido y formato de la hoja.
`clear(options)`	`Sheet`	Borra el contenido o el formato de la hoja, según se especifica con las opciones avanzadas proporcionadas.
`clearConditionalFormatRules()`	`void`	Quita todas las reglas de formato condicional de la hoja.
`clearContents()`	`Sheet`	Borra el contenido de la hoja y conserva la información de formato.
`clearFormats()`	`Sheet`	Borra el formato de la hoja y 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 que la de origen.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Devuelve un `DeveloperMetadataFinder` para encontrar metadatos del desarrollador dentro del alcance de esta hoja.
`createTextFinder(findText)`	`TextFinder`	Crea un buscador de texto para la hoja, que puede buscar y reemplazar texto dentro de ella.
`deleteColumn(columnPosition)`	`Sheet`	Borra la columna en la posición especificada.
`deleteColumns(columnPosition, howMany)`	`void`	Borra una cantidad de columnas a partir de la posición de columna especificada.
`deleteRow(rowPosition)`	`Sheet`	Borra la fila en la posición especificada.
`deleteRows(rowPosition, howMany)`	`void`	Borra una cantidad de filas a partir de la posición de fila determinada.
`expandAllColumnGroups()`	`Sheet`	Expande todos los grupos de columnas de la hoja.
`expandAllRowGroups()`	`Sheet`	Expande todos los grupos de filas de la hoja.
`expandColumnGroupsUpToDepth(groupDepth)`	`Sheet`	Expande todos los grupos de columnas hasta la profundidad indicada y contrae todos los demás.
`expandRowGroupsUpToDepth(groupDepth)`	`Sheet`	Expande todos los grupos de filas hasta la profundidad indicada y contrae todos los demás.
`getActiveCell()`	`Range`	Devuelve la celda activa en esta hoja.
`getActiveRange()`	`Range`	Devuelve el rango seleccionado en la hoja activa o `null` si no hay un rango activo.
`getActiveRangeList()`	`RangeList`	Devuelve la lista de rangos activos en la hoja activa o `null` si no hay rangos activos.
`getBandings()`	`Banding[]`	Devuelve todas las bandas de esta hoja.
`getCharts()`	`EmbeddedChart[]`	Devuelve un array de gráficos en esta hoja.
`getColumnGroup(columnIndex, groupDepth)`	`Group`	Devuelve el grupo de columnas en el índice y la profundidad de grupo determinados.
`getColumnGroupControlPosition()`	`GroupControlTogglePosition`	Devuelve el `GroupControlTogglePosition` para todos los grupos de columnas de la hoja.
`getColumnGroupDepth(columnIndex)`	`Integer`	Devuelve 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[]`	Obtiene todas las reglas de formato condicional de esta hoja.
`getCurrentCell()`	`Range`	Devuelve la celda actual en la hoja activa o `null` si no hay una celda actual.
`getDataRange()`	`Range`	Devuelve un objeto `Range` que corresponde a las dimensiones en las que hay datos.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Obtiene todas las fórmulas de la fuente de datos.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Obtiene todas las tablas dinámicas de la fuente de datos.
`getDataSourceTables()`	`DataSourceTable[]`	Obtiene todas las tablas de la fuente de datos.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Obtiene todos los metadatos de desarrollador asociados con esta hoja.
`getDrawings()`	`Drawing[]`	Devuelve un array de dibujos en la hoja.
`getFilter()`	`Filter`	Devuelve el filtro de esta hoja o `null` si no hay filtro.
`getFormUrl()`	`String`	Devuelve la URL del formulario que envía sus respuestas a esta hoja o `null` si esta hoja no tiene un formulario asociado.
`getFrozenColumns()`	`Integer`	Devuelve la cantidad de columnas inmovilizadas.
`getFrozenRows()`	`Integer`	Devuelve la cantidad de filas inmovilizadas.
`getImages()`	`OverGridImage[]`	Devuelve todas las imágenes que se encuentran sobre la cuadrícula en la hoja.
`getIndex()`	`Integer`	Obtiene la posición de la hoja en su hoja de cálculo principal.
`getLastColumn()`	`Integer`	Devuelve la posición de la última columna que tiene contenido.
`getLastRow()`	`Integer`	Devuelve la posición de la última fila que tiene contenido.
`getMaxColumns()`	`Integer`	Devuelve la cantidad actual de columnas en la hoja, independientemente del contenido.
`getMaxRows()`	`Integer`	Devuelve la cantidad actual de filas en la hoja, independientemente del contenido.
`getName()`	`String`	Devuelve el nombre de la hoja.
`getNamedRanges()`	`NamedRange[]`	Obtiene todos los rangos con nombre de esta hoja.
`getParent()`	`Spreadsheet`	Devuelve el objeto `Spreadsheet` que contiene esta hoja.
`getPivotTables()`	`PivotTable[]`	Devuelve todas las tablas dinámicas de esta hoja.
`getProtections(type)`	`Protection[]`	Obtiene un array de objetos que representa todos los rangos protegidos en la hoja o un array de un solo elemento que representa la protección en la hoja en sí.
`getRange(row, column)`	`Range`	Devuelve el rango con la celda superior izquierda en las coordenadas proporcionadas.
`getRange(row, column, numRows)`	`Range`	Devuelve el rango con la celda superior izquierda en las coordenadas indicadas y con la cantidad de filas especificada.
`getRange(row, column, numRows, numColumns)`	`Range`	Devuelve el rango con la celda superior izquierda en las coordenadas especificadas y con la cantidad de filas y columnas indicadas.
`getRange(a1Notation)`	`Range`	Devuelve el rango como se especifica en la notación A1 o R1C1.
`getRangeList(a1Notations)`	`RangeList`	Devuelve la colección `RangeList` que representa los rangos en la misma hoja especificada por una lista no vacía de notaciones A1 o R1C1.
`getRowGroup(rowIndex, groupDepth)`	`Group`	Devuelve el grupo de filas en el índice y la profundidad de grupo determinados.
`getRowGroupControlPosition()`	`GroupControlTogglePosition`	Devuelve el `GroupControlTogglePosition` de todos los grupos de filas de la hoja.
`getRowGroupDepth(rowIndex)`	`Integer`	Devuelve 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`	Devuelve el `Selection` actual en la hoja de cálculo.
`getSheetId()`	`Integer`	Devuelve el ID de la hoja representada por este objeto.
`getSheetName()`	`String`	Devuelve el nombre de la hoja.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Devuelve la cuadrícula rectangular de valores para este rango a partir de las coordenadas proporcionadas.
`getSlicers()`	`Slicer[]`	Devuelve un array de segmentaciones 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`	Devuelve `true` si las líneas de la cuadrícula de la hoja están ocultas; de lo contrario, devuelve `false`.
`hideColumn(column)`	`void`	Oculta la columna o las columnas del rango determinado.
`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 del rango determinado.
`hideRows(rowIndex)`	`void`	Oculta la fila en el índice determinado.
`hideRows(rowIndex, numRows)`	`void`	Oculta una o más filas consecutivas a partir del í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 de columna determinada.
`insertColumnBefore(beforePosition)`	`Sheet`	Inserta una columna antes de la posición de columna determinada.
`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 una cantidad determinada de columnas después de la posición de columna especificada.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	Inserta una cantidad de columnas antes de la posición de columna especificada.
`insertImage(blobSource, column, row)`	`OverGridImage`	Inserta un `BlobSource` como imagen en el documento en una fila y columna determinadas.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	Inserta un `BlobSource` como una 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 un desplazamiento de píxeles.
`insertRowAfter(afterPosition)`	`Sheet`	Inserta una fila después de la posición de fila determinada.
`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 determinada.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	Inserta una cantidad de filas antes de la posición de fila determinada.
`insertSlicer(range, anchorRowPos, anchorColPos)`	`Slicer`	Agrega una segmentación nueva a esta hoja.
`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`	`Slicer`	Agrega una segmentación nueva a esta hoja.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	Devuelve si el usuario ocultó la columna determinada.
`isRightToLeft()`	`Boolean`	Devuelve `true` si el diseño de esta hoja es de derecha a izquierda.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	Devuelve si un filtro (no una vista de filtro) oculta la fila determinada.
`isRowHiddenByUser(rowPosition)`	`Boolean`	Devuelve si el usuario ocultó la fila determinada.
`isSheetHidden()`	`Boolean`	Devuelve `true` si la hoja está oculta.
`moveColumns(columnSpec, destinationIndex)`	`void`	Mueve las columnas seleccionadas por el rango determinado a la posición indicada por el `destinationIndex`.
`moveRows(rowSpec, destinationIndex)`	`void`	Mueve las filas seleccionadas por el rango determinado a la posición indicada por `destinationIndex`.
`newChart()`	`EmbeddedChartBuilder`	Devuelve un compilador para crear un gráfico nuevo para esta hoja.
`protect()`	`Protection`	Crea un objeto que puede proteger la hoja de edición, excepto para los usuarios que tienen permiso.
`removeChart(chart)`	`void`	Quita un gráfico de la hoja principal.
`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 la 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 R1C1.
`setColumnGroupControlPosition(position)`	`Sheet`	Establece la posición del botón de activación del control 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 especificadas 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 la cantidad de columnas especificada.
`setFrozenRows(rows)`	`void`	Inmoviliza la cantidad de filas indicada.
`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 quita el diseño de la hoja de derecha a izquierda.
`setRowGroupControlPosition(position)`	`Sheet`	Establece la posición del botón de activación del control 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 especificadas en píxeles.
`setRowHeightsForced(startRow, numRows, height)`	`Sheet`	Establece la altura de las filas especificadas 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 determinado.
`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 determinado.
`unhideRow(row)`	`void`	Muestra la fila en el rango determinado.
`updateChart(chart)`	`void`	Actualiza el gráfico en esta hoja.

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
`getSheetProtection()`	`PageProtection`	Devuelve una instancia de `PageProtection` que describe los permisos de la hoja 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 para la hoja actual.

Documentación detallada

`activate()`

Activa esta hoja. No altera la hoja en sí, solo la noción de la hoja activa del elemento superior.

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

Volver

Sheet: Es la hoja que se acaba de activar.

`addDeveloperMetadata(key)`

Agrega metadatos del desarrollador con la clave especificada 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' 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`	Es la clave de los metadatos para desarrolladores nuevos.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`addDeveloperMetadata(key, visibility)`

Agrega metadatos del desarrollador con la clave 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`	Es la clave de los metadatos para desarrolladores nuevos.
`visibility`	`DeveloperMetadataVisibility`	Es la visibilidad de los metadatos del desarrollador nuevos.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`addDeveloperMetadata(key, value)`

Agrega metadatos del desarrollador con la clave y el valor especificados 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 '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`	Es la clave de los metadatos para desarrolladores nuevos.
`value`	`String`	Es el valor de los metadatos del desarrollador nuevos.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`addDeveloperMetadata(key, value, visibility)`

Agrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados 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 '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`	Es la clave de los metadatos para desarrolladores nuevos.
`value`	`String`	Es el valor de los metadatos del desarrollador nuevos.
`visibility`	`DeveloperMetadataVisibility`	Es la visibilidad de los metadatos del desarrollador nuevos.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`appendRow(rowContents)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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[]`	Es un array de valores que se insertarán 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()`

Devuelve la hoja como un objeto DataSourceSheet si la hoja es de tipo SheetType.DATASOURCE o null en caso contrario.

// 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)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Posición de la columna determinada a la que se le 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 de columna determinada para que se ajusten a su contenido.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Es la columna inicial para cambiar el tamaño automáticamente.
`numColumns`	`Integer`	Cantidad de columnas cuyo tamaño se cambiará automáticamente.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`autoResizeRows(startRow, numRows)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Es la fila inicial a la que se le cambiará el tamaño automáticamente.
`numRows`	`Integer`	Es la cantidad de filas cuyo tamaño se ajustará automáticamente.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`clear()`

Borra la información de contenido y formato de la hoja.

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

Volver

Sheet: Es 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 el contenido o el formato de la hoja, según se especifica con las opciones avanzadas proporcionadas.

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

Parámetros

Nombre	Tipo	Descripción
`options`	`Object`	Es un mapa de JavaScript que contiene opciones avanzadas, que se indican a continuación.

Parámetros avanzados

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`clearConditionalFormatRules()`

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

const 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 el contenido de la hoja y conserva la información de formato.

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`clearFormats()`

Borra el formato de la hoja y conserva el contenido.

El formato se refiere a cómo se formatean los datos según las opciones permitidas en el menú "Formato" (p. ej., negrita, cursiva, formato condicional) y no al ancho o la altura de las celdas.

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`clearNotes()`

Borra todas las notas de la hoja.

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`collapseAllColumnGroups()`

Contrae todos los grupos de columnas de la hoja.

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

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`collapseAllRowGroups()`

Contrae todos los grupos de filas de la hoja.

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

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`copyTo(spreadsheet)`

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

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

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

Parámetros

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

Volver

Sheet: La nueva hoja, para encadenar.

Autorización

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

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

`createDeveloperMetadataFinder()`

Devuelve un DeveloperMetadataFinder para encontrar metadatos del desarrollador dentro del alcance de esta hoja. Los metadatos se encuentran dentro del alcance de una hoja en particular si están asociados a la hoja en sí o 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 en el alcance de esta hoja.

`createTextFinder(findText)`

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

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

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

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

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

Parámetros

Nombre	Tipo	Descripción
`findText`	`String`	Es el texto que se buscará.

Volver

TextFinder: Es el TextFinder de la hoja.

`deleteColumn(columnPosition)`

Borra la columna en la posición especificada.

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

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	Posición de la columna, comenzando 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 a partir de la posición de columna especificada.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Es la posición de la primera columna que se borrará.
`howMany`	`Integer`	Es 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)`

Borra la fila en la posición especificada.

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

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	Posición de la fila, comenzando 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)`

Borra una cantidad de filas a partir de la posición de fila determinada.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Posición de la primera fila que se borrará.
`howMany`	`Integer`	Es 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 de la hoja. Este método requiere al menos un grupo de columnas.

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

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`expandAllRowGroups()`

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

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

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`expandColumnGroupsUpToDepth(groupDepth)`

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

const 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`	Profundidad del grupo hasta la que se expandirán los grupos de columnas.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`expandRowGroupsUpToDepth(groupDepth)`

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

const 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`	Profundidad del grupo hasta la que se expanden los grupos de filas.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`getActiveCell()`

Devuelve la celda activa en esta hoja.

Nota: Es preferible usar getCurrentCell(), que devuelve la celda destacada actual.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Returns the active cell
const 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()`

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

El término "rango activo" hace referencia al rango que un usuario seleccionó en la hoja activa, pero, en una función personalizada, hace referencia a la celda que se está recalculando de forma activa.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const 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()`

Devuelve la lista de rangos activos en la hoja activa o null si no hay rangos activos.

Si se selecciona un solo rango, se comporta como una llamada a getActiveRange().

const sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
const 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 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 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[]: Son 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()`

Devuelve un array de gráficos en esta hoja.

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

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

Volver

EmbeddedChart[]: Es 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)`

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

const 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.
const columnGroup = sheet.getColumnGroup(2, 1);

Parámetros

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

Volver

Group: Es el grupo de columnas en el índice y la profundidad de control, o bien 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()`

Devuelve el GroupControlTogglePosition para todos los grupos de columnas de la hoja.

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

// GroupControlTogglePosition.AFTER if the column grouping control toggle is
// shown after the group.
const 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 y false en caso contrario.

Autorización

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

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

`getColumnGroupDepth(columnIndex)`

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

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

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

Parámetros

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

Volver

Integer: Es 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.

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

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

Parámetros

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

Volver

Integer: Ancho de la 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()`

Obtiene todas las reglas de formato condicional de esta hoja.

// Logs the conditional format rules in a sheet.
const rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
  const 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()`

Devuelve la celda actual en la hoja activa o null si no hay una celda actual. La celda actual es la que tiene el enfoque en la IU de Hojas de cálculo de Google y se destaca con un borde oscuro. 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.

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

Volver

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

Devuelve un objeto Range que corresponde a las dimensiones en las que hay datos.

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

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

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

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

Volver

Range: Es un rango que incluye 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 la 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 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

`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 fuentes de datos.

Autorización

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

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

`getDataSourceTables()`

Obtiene todas las tablas de la fuente de datos.

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

Obtiene todos los metadatos de 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 a 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 un array 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 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

`getFilter()`

Devuelve el filtro de esta hoja o null si no hay filtro.

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

Devuelve la URL del formulario que envía sus respuestas a esta hoja o null si esta hoja no tiene un formulario asociado. Arroja una excepción si el usuario no tiene permiso para editar la hoja de cálculo.

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

Volver

String: Es la URL del formulario que coloca sus respuestas en esta hoja o null si esta 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()`

Devuelve la cantidad de columnas inmovilizadas.

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

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

Volver

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

Devuelve la cantidad de filas inmovilizadas.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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()`

Devuelve todas las imágenes que se encuentran sobre la cuadrícula en 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 su hoja de cálculo principal. Comienza en 1.

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

Volver

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

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

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

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

Volver

Integer: Es la última columna de la hoja que contiene 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()`

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

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

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

Volver

Integer: Es la última fila de la hoja que contiene 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()`

Devuelve la cantidad actual de columnas en la hoja, independientemente del contenido.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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()`

Devuelve la cantidad actual de filas en la hoja, independientemente del contenido.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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()`

Devuelve el nombre de la hoja.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.
const 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()`

Devuelve el objeto Spreadsheet que contiene esta hoja.

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

Volver

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

`getPivotTables()`

Devuelve 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 representa todos los rangos protegidos en la hoja o un array de un solo elemento que representa la protección en la hoja en sí.

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

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

Parámetros

Nombre	Tipo	Descripción
`type`	`ProtectionType`	Es 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 en la hoja o un array de un solo elemento que representa la protección en 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

`getRange(row, column)`

Devuelve el rango con la celda superior izquierda en las coordenadas proporcionadas.

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

Parámetros

Nombre	Tipo	Descripción
`row`	`Integer`	Es el índice de fila de la celda que se devolverá. El índice de fila comienza con 1.
`column`	`Integer`	Es el índice de columna de la celda que se devolverá. La indexación de columnas comienza con el número 1.

Volver

Range: Es 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 indicadas y con la cantidad de filas especificada.

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

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

Parámetros

Nombre	Tipo	Descripción
`row`	`Integer`	Índice de la fila inicial del rango. El índice de filas comienza con 1.
`column`	`Integer`	Índice de columna del rango. La indexación de columnas comienza con 1.
`numRows`	`Integer`	Cantidad de filas que se devolverá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 especificadas y con la cantidad de filas y columnas indicadas.

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

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

Parámetros

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

Volver

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

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

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

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

Parámetros

Nombre	Tipo	Descripción
`a1Notation`	`String`	Es el rango que se devolverá, especificado en notación A1 o 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 en la misma hoja especificada por una lista no vacía de notaciones A1 o R1C1.

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

Parámetros

Nombre	Tipo	Descripción
`a1Notations`	`String[]`	Es la lista de rangos que se devolverán, especificados en notación A1 o 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)`

Devuelve el grupo de filas en el índice y la profundidad de grupo determinados.

const 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.
const rowGroup = sheet.getRowGroup(2, 1);

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	Índice de fila del botón de activación o desactivación del control de grupo, o bien un índice dentro del grupo.
`groupDepth`	`Integer`	Es la profundidad del grupo.

Volver

Group: Es el grupo de filas en el índice y la profundidad de control, o bien 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()`

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

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

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown
// after the group.
const 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 false en otros casos

Autorización

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

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

`getRowGroupDepth(rowIndex)`

Devuelve 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 variar entre cero y ocho.

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

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

Parámetros

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

Volver

Integer: Es 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.

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

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

Parámetros

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

Volver

Integer: Altura de la fila 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()`

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

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const 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.

Es un ID de la hoja que es único para la hoja de cálculo. El ID es un número entero que aumenta de forma monótona y se asigna en el momento de la creación de la hoja, independientemente de su posición. Esto 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.

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

Logger.log(sheet.getSheetId());

Volver

Integer: Es un ID de la hoja que es único para 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()`

Devuelve el nombre de la hoja.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

Devuelve la cuadrícula rectangular de valores para este rango a partir de las coordenadas proporcionadas. Un valor de -1 proporcionado como la posición de la fila o la columna equivale a obtener la última fila o columna que tiene datos en la hoja.

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

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

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

Parámetros

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

Volver

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

Autorización

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

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

`getSlicers()`

Devuelve un array de segmentaciones 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 segmentaciones 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

`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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = first.getTabColorObject();

Volver

Color: Es 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. Una hoja que contiene un solo objeto incorporado, como un EmbeddedChart, es una hoja SheetType.OBJECT.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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()`

Devuelve true si las líneas de la cuadrícula de la hoja están ocultas; de lo contrario, devuelve false. Las cuadrículas 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 cuadrículas están ocultas; false en caso contrario.

Autorización

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

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

`hideColumn(column)`

Oculta la columna o las columnas del rango determinado.

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

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

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

Parámetros

Nombre	Tipo	Descripción
`column`	`Range`	Es 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 un índice basado en 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().

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

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	Í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 un índice basado en 1 para este método.

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

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	Índice inicial de las columnas que se ocultarán.
`numColumns`	`Integer`	Es la cantidad 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 del rango determinado.

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

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

Parámetros

Nombre	Tipo	Descripción
`row`	`Range`	Es 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.

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

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	Í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 a partir del índice determinado.

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

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	Índice inicial de las filas que se ocultarán.
`numRows`	`Integer`	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 efecto si la hoja ya está oculta. Si se llama a este método en la única hoja visible, se genera una excepción.

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

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
const 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`	Es 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 de columna determinada.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 columna nueva.

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 columna determinada.

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

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

Parámetros

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

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.

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

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	Índice que indica dónde se debe 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.

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

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	Índice que indica dónde se debe insertar una columna.
`numColumns`	`Integer`	Es la cantidad 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 una cantidad determinada de columnas después de la posición de columna especificada.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 columna nueva.
`howMany`	`Integer`	Es la cantidad 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 columna especificada.

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

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

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	Columna antes de la que se debe agregar la columna nueva.
`howMany`	`Integer`	Es la cantidad 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 BlobSource como imagen en el documento en una fila y columna determinadas. El tamaño de la imagen se recupera del contenido del BLOB. El tamaño máximo permitido para un BLOB es 2 MB.

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parámetros

Nombre	Tipo	Descripción
`blobSource`	`BlobSource`	Es el BLOB que contiene el contenido, el tipo MIME y (opcionalmente) el nombre de la imagen.
`column`	`Integer`	Es la posición de la columna.
`row`	`Integer`	Es 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 BlobSource como una 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 tamaño máximo permitido para un BLOB es 2 MB.

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parámetros

Nombre	Tipo	Descripción
`blobSource`	`BlobSource`	Es el BLOB que contiene el contenido, el tipo MIME y (opcionalmente) el nombre de la imagen.
`column`	`Integer`	Es la posición de la columna.
`row`	`Integer`	Es la posición de la fila.
`offsetX`	`Integer`	Es el desplazamiento horizontal desde la esquina de la celda en píxeles.
`offsetY`	`Integer`	Es el 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Es la posición de la columna de la cuadrícula.
`row`	`Integer`	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 un desplazamiento de píxeles.

La URL proporcionada debe ser de acceso público.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Es la posición de la columna.
`row`	`Integer`	Es la posición de la fila.
`offsetX`	`Integer`	Es el desplazamiento horizontal desde la esquina de la celda en píxeles.
`offsetY`	`Integer`	Es el 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 determinada.

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

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

Parámetros

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

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.

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

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

Parámetros

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

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.

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

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	Í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.

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

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	Índice que indica dónde insertar una fila.
`numRows`	`Integer`	Es 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 determinada.

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

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

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	Es la fila después de la cual se deben agregar las filas nuevas.
`howMany`	`Integer`	Es 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 determinada.

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

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

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	Es la fila antes de la cual se deben agregar las filas nuevas.
`howMany`	`Integer`	Es 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 una segmentación nueva a 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 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`	Es el rango en el que se crea el segmentador.
`anchorRowPos`	`Integer`	La parte superior del segmentador está anclada en esta fila.
`anchorColPos`	`Integer`	La parte superior del cortador está anclada en esta columna.

Volver

Slicer: Es el control de filtro recién insertado.

Autorización

Las secuencias de comandos que usan este método requieren 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 una segmentación nueva a 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 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`	Es el rango en el que se crea el segmentador.
`anchorRowPos`	`Integer`	La parte superior del segmentador está anclada en esta fila.
`anchorColPos`	`Integer`	La parte superior del cortador está anclada en esta columna.
`offsetX`	`Integer`	Es el desplazamiento horizontal desde la esquina de la celda en píxeles.
`offsetY`	`Integer`	Es el desplazamiento vertical desde la esquina de la celda en píxeles.

Volver

Slicer: Es el control de filtro recién insertado.

Autorización

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

Devuelve si el usuario ocultó la columna determinada.

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

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

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	Es la posición de la columna que se 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()`

Devuelve true si el diseño de esta hoja es de derecha a izquierda. Devuelve 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; false en caso contrario.

Autorización

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

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

`isRowHiddenByFilter(rowPosition)`

Devuelve si un filtro (no una vista de filtro) oculta la fila determinada.

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

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

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	Es la posición de la fila que se 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)`

Devuelve si el usuario ocultó la fila determinada.

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

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

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	Es la posición de la fila que se 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()`

Devuelve true si la hoja está oculta.

const 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 determinado a la posición indicada por el destinationIndex. El columnSpec no tiene que representar exactamente una columna completa o un grupo de columnas para moverse, ya que selecciona 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.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
const columnSpec = sheet.getRange('A1:B1');
sheet.moveColumns(columnSpec, 5);

Parámetros

Nombre	Tipo	Descripción
`columnSpec`	`Range`	Es un rango que abarca las columnas que se deben mover.
`destinationIndex`	`Integer`	Índice al que se deben mover las columnas. Ten en cuenta que este índice se basa en las coordenadas antes de que se muevan las columnas. Los datos existentes se desplazan hacia la derecha para dejar espacio 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 especificado originalmente.

Autorización

Las secuencias de comandos que usan este método requieren 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 en sí no tiene que representar exactamente una fila completa o un grupo de filas para moverse, sino que selecciona 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.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
const rowSpec = sheet.getRange('A1:A2');
sheet.moveRows(rowSpec, 5);

Parámetros

Nombre	Tipo	Descripción
`rowSpec`	`Range`	Es un rango que abarca las filas que se deben mover.
`destinationIndex`	`Integer`	Índice al que se deben mover las filas. Ten en cuenta que este índice se basa en las coordenadas antes de que se muevan las filas. Los datos existentes se desplazan hacia abajo para dejar espacio para las filas movidas, mientras que las filas de origen se quitan de la cuadrícula. Por lo tanto, los datos pueden terminar en un índice diferente del que se especificó originalmente.

Autorización

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

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

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

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
const 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 para crear un gráfico nuevo.

`protect()`

Crea un objeto que puede proteger la hoja de edición, excepto para los usuarios que tienen permiso. Hasta que la secuencia de comandos cambie realmente la lista de editores de la hoja (llamando a Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) o estableciendo un nuevo valor para Protection.setDomainEdit(editable)), los permisos reflejan los de la propia hoja de cálculo, lo que significa que la hoja permanece desprotegida. Si la hoja ya está protegida, este método devuelve un objeto que representa su configuración de protección existente. Una hoja protegida puede incluir regiones sin protección.

// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const 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.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Volver

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

Autorización

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

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

`removeChart(chart)`

Quita un gráfico de la hoja principal.

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

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

Parámetros

Nombre	Tipo	Descripción
`chart`	`EmbeddedChart`	Es 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.

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

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

Parámetros

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

Volver

Range: Es el rango recién activado.

Autorización

Las secuencias de comandos que usan este método requieren 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 la hoja activa. El último rango de la lista se establece como active range.

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

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

Parámetros

Nombre	Tipo	Descripción
`rangeList`	`RangeList`	Es la lista de rangos que se seleccionarán.

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.

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

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

Parámetros

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

Volver

Range: Es el rango recién activado.

Autorización

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

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

sheet.setActiveSelection('A1:D4');

Parámetros

Nombre	Tipo	Descripción
`a1Notation`	`String`	Es el rango que se configurará como activo, especificado en notación A1 o R1C1.

Volver

Range: Es el rango recién activado.

Autorización

Las secuencias de comandos que usan este método requieren 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 botón de activación del control de grupo de columnas en la hoja.

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

Parámetros

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`setColumnWidth(columnPosition, width)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Posición de la columna determinada que se establecerá.
`width`	`Integer`	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 especificadas en píxeles.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Es la posición de la columna inicial que se cambiará.
`numColumns`	`Integer`	Cantidad de columnas que se cambiarán.
`width`	`Integer`	Ancho en píxeles que se establecerá.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`setConditionalFormatRules(rules)`

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

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

Parámetros

Nombre	Tipo	Descripción
`rules`	`ConditionalFormatRule[]`	Son 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 está presente en un rango ya seleccionado, ese rango se convierte en el rango activo con la celda como la celda actual.

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

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

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

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

Parámetros

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

Volver

Range: Es la celda actual recién establecida.

Autorización

Las secuencias de comandos que usan este método requieren 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 la cantidad de columnas especificada. Si es cero, no se inmoviliza ninguna columna.

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

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

Parámetros

Nombre	Tipo	Descripción
`columns`	`Integer`	Es 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 indicada. Si es cero, no se inmoviliza ninguna fila.

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

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

Parámetros

Nombre	Tipo	Descripción
`rows`	`Integer`	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`, oculta las líneas de cuadrícula en esta hoja; de lo contrario, muestra las líneas de cuadrícula.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`setName(name)`

Establece el nombre de la hoja.

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

Parámetros

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`setRightToLeft(rightToLeft)`

Establece o quita el diseño de la 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 la esquina superior derecha. Si es `false`, el diseño de la hoja se establece de forma predeterminada de izquierda a derecha, con la celda A1 en la parte superior izquierda.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`setRowGroupControlPosition(position)`

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

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

Parámetros

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

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`setRowHeight(rowPosition, height)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Posición de la fila que se cambiará.
`height`	`Integer`	Altura 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

`setRowHeights(startRow, numRows, height)`

Establece la altura de las filas especificadas en píxeles. De forma predeterminada, las filas crecen para adaptarse al contenido de las celdas. Si deseas forzar que las filas tengan una altura específica, usa setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Es la posición de la fila inicial que se cambiará.
`numRows`	`Integer`	Es la cantidad de filas que se cambiarán.
`height`	`Integer`	Altura en píxeles que se establecerá.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`setRowHeightsForced(startRow, numRows, height)`

Establece la altura de las filas especificadas en píxeles. De forma predeterminada, las filas crecen para adaptarse al contenido de las celdas. Cuando usas setRowHeightsForced, las filas se fuerzan a la altura especificada, incluso si el contenido de las celdas es más alto que la altura de la fila.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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`	Es la posición de la fila inicial que se cambiará.
`numRows`	`Integer`	Es la cantidad de filas que se cambiarán.
`height`	`Integer`	Altura en píxeles que se establecerá.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`setTabColor(color)`

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

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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'`), o `null` para restablecer el color de la pestaña

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`setTabColorObject(color)`

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

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const 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`	Color de la pestaña de la hoja que se establecerá.

Volver

Sheet: Esta hoja, para encadenar.

Autorización

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

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

`showColumns(columnIndex)`

Muestra la columna en el índice determinado.

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

Parámetros

Nombre	Tipo	Descripción
`columnIndex`	`Integer`	Í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.

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

Parámetros

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

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

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	Í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.

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

Parámetros

Nombre	Tipo	Descripción
`rowIndex`	`Integer`	Índice inicial de las filas que se mostrarán.
`numRows`	`Integer`	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 efecto si la hoja ya está visible.

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

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

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

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	Columna por la que se 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.

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

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

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	Columna por la que se ordenará.
`ascending`	`Boolean`	`true` para orden ascendente y `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 determinado.

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

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

Parámetros

Nombre	Tipo	Descripción
`column`	`Range`	Es 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 determinado.

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

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

Parámetros

Nombre	Tipo	Descripción
`row`	`Range`	Es 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 en esta hoja.

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

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

Parámetros

Nombre	Tipo	Descripción
`chart`	`EmbeddedChart`	Es 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 devuelve la clase Protection más potente. Aunque este método está obsoleto, sigue disponible para brindar compatibilidad con la versión anterior de Hojas de cálculo.

Devuelve una instancia de PageProtection que describe los permisos de la hoja actual.

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

const 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.
const users = permissions.getUsers();
Logger.log(users);

Volver

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

`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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
const color = first.getTabColor();

Volver

String: 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 devuelve la clase Protection más potente. Aunque este método está obsoleto, sigue disponible para brindar compatibilidad con la versión anterior de Hojas de cálculo.

Establece los permisos para la hoja actual.

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

const permissions = sheet.getSheetProtection();

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

Parámetros

Nombre	Tipo	Descripción
`permissions`	`PageProtection`	Es el objeto de permisos de acceso que se establecerá 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

Class Sheet Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Métodos

Métodos obsoletos

Documentación detallada

activate()

Volver

addDeveloperMetadata(key)

Parámetros

Volver

Autorización

addDeveloperMetadata(key, visibility)

Parámetros

Volver

Autorización

addDeveloperMetadata(key, value)

Parámetros

Volver

Autorización

addDeveloperMetadata(key, value, visibility)

Parámetros

Volver

Autorización

appendRow(rowContents)

Parámetros

Volver

Autorización

asDataSourceSheet()

Volver

Autorización

autoResizeColumn(columnPosition)

Parámetros

Volver

Autorización

autoResizeColumns(startColumn, numColumns)

Parámetros

Volver

Autorización

autoResizeRows(startRow, numRows)

Parámetros

Volver

Autorización

clear()

Volver

Autorización

clear(options)

Parámetros

Parámetros avanzados

Volver

Autorización

clearConditionalFormatRules()

Autorización

clearContents()

Volver

Autorización

clearFormats()

Volver

Autorización

clearNotes()

Volver

Autorización

collapseAllColumnGroups()

Volver

Autorización

collapseAllRowGroups()

Volver

Autorización

copyTo(spreadsheet)

Parámetros

Volver

Autorización

createDeveloperMetadataFinder()

Volver

createTextFinder(findText)

Parámetros

Volver

deleteColumn(columnPosition)

Parámetros

Volver

Autorización

deleteColumns(columnPosition, howMany)

Class Sheet

`activate()`

`addDeveloperMetadata(key)`

`addDeveloperMetadata(key, visibility)`

`addDeveloperMetadata(key, value)`

`addDeveloperMetadata(key, value, visibility)`

`appendRow(rowContents)`

`asDataSourceSheet()`

`autoResizeColumn(columnPosition)`

`autoResizeColumns(startColumn, numColumns)`

`autoResizeRows(startRow, numRows)`

`clear()`

`clear(options)`

`clearConditionalFormatRules()`

`clearContents()`

`clearFormats()`

`clearNotes()`

`collapseAllColumnGroups()`

`collapseAllRowGroups()`

`copyTo(spreadsheet)`

`createDeveloperMetadataFinder()`

`createTextFinder(findText)`

`deleteColumn(columnPosition)`

`deleteColumns(columnPosition, howMany)`

`deleteRow(rowPosition)`

`deleteRows(rowPosition, howMany)`

`expandAllColumnGroups()`

`expandAllRowGroups()`

`expandColumnGroupsUpToDepth(groupDepth)`

`expandRowGroupsUpToDepth(groupDepth)`

`getActiveCell()`

`getActiveRange()`

`getActiveRangeList()`

`getBandings()`

`getCharts()`

`getColumnGroup(columnIndex, groupDepth)`

`getColumnGroupControlPosition()`

`getColumnGroupDepth(columnIndex)`

`getColumnWidth(columnPosition)`

`getConditionalFormatRules()`

`getCurrentCell()`

`getDataRange()`

`getDataSourceFormulas()`

`getDataSourcePivotTables()`