Acessar e modificar páginas de planilhas. As operações comuns são renomear uma página e acessar objetos de intervalo dela.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
activate() | Sheet | Ativa a página. |
addDeveloperMetadata(key) | Sheet | Adiciona metadados do desenvolvedor com a chave especificada à planilha. |
addDeveloperMetadata(key, visibility) | Sheet | Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha. |
addDeveloperMetadata(key, value) | Sheet | Adiciona metadados do desenvolvedor com a chave e o valor especificados à planilha. |
addDeveloperMetadata(key, value, visibility) | Sheet | Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha. |
appendRow(rowContents) | Sheet | Anexa uma linha à parte inferior da região de dados atual na página. |
asDataSourceSheet() | DataSourceSheet | Retorna a página como um DataSourceSheet , se ela for do tipo SheetType.DATASOURCE . Caso contrário, retorna null . |
autoResizeColumn(columnPosition) | Sheet | Define a largura da coluna especificada para ajustar o conteúdo. |
autoResizeColumns(startColumn, numColumns) | Sheet | Define a largura de todas as colunas começando na posição especificada para ajustar o conteúdo delas. |
autoResizeRows(startRow, numRows) | Sheet | Define a altura de todas as linhas começando na posição da linha especificada para ajustar o conteúdo. |
clear() | Sheet | Limpa a página com o conteúdo e as informações de formatação. |
clear(options) | Sheet | Limpa a página de conteúdo e/ou formato, conforme especificado com as opções avançadas fornecidas. |
clearConditionalFormatRules() | void | Remove todas as regras de formatação condicional da página. |
clearContents() | Sheet | Limpa a página de conteúdo, preservando as informações de formatação. |
clearFormats() | Sheet | Limpa a página de formatação, preservando o conteúdo. |
clearNotes() | Sheet | Limpa a página de todas as notas. |
collapseAllColumnGroups() | Sheet | Recolhe todos os grupos de colunas na página. |
collapseAllRowGroups() | Sheet | Recolhe todos os grupos de linhas na página. |
copyTo(spreadsheet) | Sheet | Copia a página para uma determinada planilha, que pode ser a mesma planilha da fonte. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Retorna um DeveloperMetadataFinder para encontrar metadados de desenvolvedor no escopo desta planilha. |
createTextFinder(findText) | TextFinder | Cria um localizador de texto para a folha, que pode localizar e substituir texto dentro da planilha. |
deleteColumn(columnPosition) | Sheet | Exclui a coluna na posição de coluna especificada. |
deleteColumns(columnPosition, howMany) | void | Exclui várias colunas começando na posição de coluna especificada. |
deleteRow(rowPosition) | Sheet | Exclui a linha na posição da linha especificada. |
deleteRows(rowPosition, howMany) | void | Exclui várias linhas começando na posição de linha especificada. |
expandAllColumnGroups() | Sheet | Expande todos os grupos de colunas na página. |
expandAllRowGroups() | Sheet | Expande todos os grupos de linhas na página. |
expandColumnGroupsUpToDepth(groupDepth) | Sheet | Expande todos os grupos de colunas até a profundidade especificada e recolhe todas as outras. |
expandRowGroupsUpToDepth(groupDepth) | Sheet | Expande todos os grupos de linhas até a profundidade especificada e recolhe todos os outros. |
getActiveCell() | Range | Retorna a célula ativa nesta planilha. |
getActiveRange() | Range | Retorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo. |
getActiveRangeList() | RangeList | Retorna a lista de intervalos ativos na página ativa ou null se não houver intervalos
ativos. |
getBandings() | Banding[] | Retorna todas as faixas nessa planilha. |
getCharts() | EmbeddedChart[] | Retorna uma matriz de gráficos nesta página. |
getColumnGroup(columnIndex, groupDepth) | Group | Retorna o grupo de colunas no índice e na profundidade de grupo especificados. |
getColumnGroupControlPosition() | GroupControlTogglePosition | Retorna o GroupControlTogglePosition de todos os grupos de colunas na página. |
getColumnGroupDepth(columnIndex) | Integer | Retorna a profundidade do grupo da coluna no índice especificado. |
getColumnWidth(columnPosition) | Integer | Recebe a largura em pixels da coluna especificada. |
getConditionalFormatRules() | ConditionalFormatRule[] | Receba todas as regras de formatação condicional nesta página. |
getCurrentCell() | Range | Retorna a célula atual na página ativa ou null se não houver célula atual. |
getDataRange() | Range | Retorna um Range correspondente às dimensões em que os dados estão presentes. |
getDataSourceFormulas() | DataSourceFormula[] | Extrai todas as fórmulas da fonte de dados. |
getDataSourcePivotTables() | DataSourcePivotTable[] | Recebe todas as tabelas dinâmicas da fonte de dados. |
getDataSourceTables() | DataSourceTable[] | Extrai todas as tabelas da fonte de dados. |
getDeveloperMetadata() | DeveloperMetadata[] | Receba todos os metadados do desenvolvedor associados a esta planilha. |
getDrawings() | Drawing[] | Retorna uma matriz de desenhos na página. |
getFilter() | Filter | Retorna o filtro nesta página ou null se não houver filtro. |
getFormUrl() | String | Retorna o URL do formulário que envia as respostas a essa página ou null se a planilha não tiver um formulário associado. |
getFrozenColumns() | Integer | Retorna o número de colunas congeladas. |
getFrozenRows() | Integer | Retorna o número de linhas congeladas. |
getImages() | OverGridImage[] | Retorna todas as imagens sobre a grade da página. |
getIndex() | Integer | Recebe a posição da página na planilha pai. |
getLastColumn() | Integer | Retorna a posição da última coluna que possui conteúdo. |
getLastRow() | Integer | Retorna a posição da última linha que tem conteúdo. |
getMaxColumns() | Integer | Retorna o número atual de colunas na página, independentemente do conteúdo. |
getMaxRows() | Integer | Retorna o número atual de linhas na página, independentemente do conteúdo. |
getName() | String | Retorna o nome da planilha. |
getNamedRanges() | NamedRange[] | Extrai todos os intervalos nomeados nesta página. |
getParent() | Spreadsheet | Retorna o Spreadsheet que contém a página. |
getPivotTables() | PivotTable[] | Retorna todas as tabelas dinâmicas nesta página. |
getProtections(type) | Protection[] | Recebe uma matriz de objetos que representam todos os intervalos protegidos na página ou uma matriz de elemento único que representa a proteção na própria página. |
getRange(row, column) | Range | Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas. |
getRange(row, column, numRows) | Range | Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas e com o número de linhas especificado. |
getRange(row, column, numRows, numColumns) | Range | Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas com o número especificado de linhas e colunas. |
getRange(a1Notation) | Range | Retorna o intervalo conforme especificado na notação A1 ou R1C1. |
getRangeList(a1Notations) | RangeList | Retorna a coleção RangeList que representa os intervalos na mesma página especificada por uma lista não vazia de notações A1 ou R1C1. |
getRowGroup(rowIndex, groupDepth) | Group | Retorna o grupo de linhas com o índice e a profundidade do grupo especificados. |
getRowGroupControlPosition() | GroupControlTogglePosition | Retorna GroupControlTogglePosition para todos os grupos de linhas na página. |
getRowGroupDepth(rowIndex) | Integer | Retorna a profundidade do grupo da linha no índice especificado. |
getRowHeight(rowPosition) | Integer | Recebe a altura em pixels da linha especificada. |
getSelection() | Selection | Retorna o Selection atual na planilha. |
getSheetId() | Integer | Retorna o ID da página representada por esse objeto. |
getSheetName() | String | Retorna o nome da página. |
getSheetValues(startRow, startColumn, numRows, numColumns) | Object[][] | Retorna a grade retangular de valores para este intervalo a partir das coordenadas fornecidas. |
getSlicers() | Slicer[] | Retorna uma matriz de controles de filtros na página. |
getTabColorObject() | Color | Recebe a cor da guia da página ou null se ela não tiver cor. |
getType() | SheetType | Retorna o tipo da planilha. |
hasHiddenGridlines() | Boolean | Retornará true se as linhas de grade da página estiverem ocultas. Caso contrário, retornará false . |
hideColumn(column) | void | Oculta a coluna ou as colunas no intervalo especificado. |
hideColumns(columnIndex) | void | Oculta uma única coluna no índice especificado. |
hideColumns(columnIndex, numColumns) | void | Oculta uma ou mais colunas consecutivas a partir do índice especificado. |
hideRow(row) | void | Oculta as linhas no intervalo especificado. |
hideRows(rowIndex) | void | A linha no índice especificado é oculta. |
hideRows(rowIndex, numRows) | void | Oculta uma ou mais linhas consecutivas começando no índice especificado. |
hideSheet() | Sheet | Oculta esta página. |
insertChart(chart) | void | Adiciona um novo gráfico à página. |
insertColumnAfter(afterPosition) | Sheet | Insere uma coluna após a posição de coluna especificada. |
insertColumnBefore(beforePosition) | Sheet | Insere uma coluna antes da posição da coluna especificada. |
insertColumns(columnIndex) | void | Insere uma coluna em branco em uma página no local especificado. |
insertColumns(columnIndex, numColumns) | void | Insere uma ou mais colunas em branco consecutivas em uma página, começando no local especificado. |
insertColumnsAfter(afterPosition, howMany) | Sheet | Insere várias colunas após a posição de coluna especificada. |
insertColumnsBefore(beforePosition, howMany) | Sheet | Insere várias colunas antes da posição especificada. |
insertImage(blobSource, column, row) | OverGridImage | Insere um BlobSource como uma imagem no documento em uma determinada linha e coluna. |
insertImage(blobSource, column, row, offsetX, offsetY) | OverGridImage | Insere um BlobSource como uma imagem no documento em uma determinada linha e coluna, com um
deslocamento de pixels. |
insertImage(url, column, row) | OverGridImage | Insere uma imagem no documento em uma determinada linha e coluna. |
insertImage(url, column, row, offsetX, offsetY) | OverGridImage | Insere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixels. |
insertRowAfter(afterPosition) | Sheet | Insere uma linha após a posição da linha especificada. |
insertRowBefore(beforePosition) | Sheet | Insere uma linha antes da posição da linha especificada. |
insertRows(rowIndex) | void | Insere uma linha em branco em uma página no local especificado. |
insertRows(rowIndex, numRows) | void | Insere uma ou mais linhas em branco consecutivas em uma página, começando no local especificado. |
insertRowsAfter(afterPosition, howMany) | Sheet | Insere várias linhas após a posição da linha especificada. |
insertRowsBefore(beforePosition, howMany) | Sheet | Insere várias linhas antes da posição da linha especificada. |
insertSlicer(range, anchorRowPos, anchorColPos) | Slicer | Adiciona um novo controle de filtros à página. |
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Adiciona um novo controle de filtros à página. |
isColumnHiddenByUser(columnPosition) | Boolean | Retorna se a coluna especificada está oculta pelo usuário. |
isRightToLeft() | Boolean | Retorna true se esse layout de página for da direita para a esquerda. |
isRowHiddenByFilter(rowPosition) | Boolean | Retorna se a linha especificada está oculta por um filtro (não por uma visualização com filtro). |
isRowHiddenByUser(rowPosition) | Boolean | Retorna se a linha fornecida está oculta pelo usuário. |
isSheetHidden() | Boolean | Retorna true se a página estiver oculta no momento. |
moveColumns(columnSpec, destinationIndex) | void | Move as colunas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex . |
moveRows(rowSpec, destinationIndex) | void | Move as linhas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex . |
newChart() | EmbeddedChartBuilder | Retorna um construtor para criar um novo gráfico para esta planilha. |
protect() | Protection | Cria um objeto que pode impedir que a página seja editada, exceto por usuários com permissão. |
removeChart(chart) | void | Remove um gráfico da página pai. |
setActiveRange(range) | Range | Define o intervalo especificado como o active range na página ativa, com
a célula superior esquerda no intervalo como current cell . |
setActiveRangeList(rangeList) | RangeList | Define a lista especificada de intervalos como o active ranges na
página ativa. |
setActiveSelection(range) | Range | Define a região de seleção ativa para a planilha. |
setActiveSelection(a1Notation) | Range | Define a seleção ativa, conforme especificado na notação A1 ou R1C1. |
setColumnGroupControlPosition(position) | Sheet | Define a posição do botão de alternância do controle do grupo de colunas na página. |
setColumnWidth(columnPosition, width) | Sheet | Define a largura da coluna especificada em pixels. |
setColumnWidths(startColumn, numColumns, width) | Sheet | Define a largura das colunas especificadas em pixels. |
setConditionalFormatRules(rules) | void | Substitui todas as regras de formatação condicional existentes na página pelas regras de entrada. |
setCurrentCell(cell) | Range | Define a célula especificada como current cell . |
setFrozenColumns(columns) | void | Congela o número determinado de colunas. |
setFrozenRows(rows) | void | Congela o número fornecido de linhas. |
setHiddenGridlines(hideGridlines) | Sheet | Oculta ou revela as linhas de grade da página. |
setName(name) | Sheet | Define o nome da página. |
setRightToLeft(rightToLeft) | Sheet | Define ou cancela a configuração do layout da página da direita para a esquerda. |
setRowGroupControlPosition(position) | Sheet | Define a posição do botão de alternância do controle do grupo de linhas na página. |
setRowHeight(rowPosition, height) | Sheet | Define a altura da linha especificada em pixels. |
setRowHeights(startRow, numRows, height) | Sheet | Define a altura das linhas fornecidas em pixels. |
setRowHeightsForced(startRow, numRows, height) | Sheet | Define a altura das linhas fornecidas em pixels. |
setTabColor(color) | Sheet | Define a cor da guia da página. |
setTabColorObject(color) | Sheet | Define a cor da guia da página. |
showColumns(columnIndex) | void | Reexibe a coluna no índice especificado. |
showColumns(columnIndex, numColumns) | void | Reexibe uma ou mais colunas consecutivas a partir do índice especificado. |
showRows(rowIndex) | void | Reexibe a linha no índice especificado. |
showRows(rowIndex, numRows) | void | Mostra uma ou mais linhas consecutivas a partir do índice especificado. |
showSheet() | Sheet | Torna a página visível. |
sort(columnPosition) | Sheet | Classifica uma página por coluna, em ordem crescente. |
sort(columnPosition, ascending) | Sheet | Classifica uma página por coluna. |
unhideColumn(column) | void | Reexibe a coluna no intervalo especificado. |
unhideRow(row) | void | Mostra a linha no intervalo especificado. |
updateChart(chart) | void | Atualiza o gráfico nesta página. |
Documentação detalhada
activate()
Ativa a página. Não altera a página em si, apenas a noção pai da página ativa.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.activate();
Retornar
Sheet
: a página recém-ativa.
addDeveloperMetadata(key)
Adiciona metadados do desenvolvedor com a chave especificada à planilha.
// 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
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave dos novos metadados do desenvolvedor. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, visibility)
Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha.
// 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
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave dos novos metadados do desenvolvedor. |
visibility | DeveloperMetadataVisibility | A visibilidade dos novos metadados do desenvolvedor. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, value)
Adiciona metadados do desenvolvedor com a chave e o valor especificados à planilha.
// 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
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave dos novos metadados do desenvolvedor. |
value | String | O valor dos novos metadados do desenvolvedor. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, value, visibility)
Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha.
// 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
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave dos novos metadados do desenvolvedor. |
value | String | O valor dos novos metadados do desenvolvedor. |
visibility | DeveloperMetadataVisibility | A visibilidade dos novos metadados do desenvolvedor. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
appendRow(rowContents)
Anexa uma linha à parte inferior da região de dados atual na página. Se o conteúdo de uma célula começar
com =
, ele será interpretado como uma fórmula.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Appends a new row with 3 columns to the bottom of the current // data region in the sheet containing the values in the array. sheet.appendRow(["a man", "a plan", "panama"]);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowContents | Object[] | Uma matriz de valores para inserir após a última linha na página. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asDataSourceSheet()
Retorna a página como um DataSourceSheet
, se ela for do tipo SheetType.DATASOURCE
. Caso contrário, retorna null
.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the data source sheet value if the sheet is of type // SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value. const dataSourceSheet = sheet.asDataSourceSheet(); // Gets the data source sheet value and logs it to the console. console.log(dataSourceSheet); console.log(sheet.getType().toString());
Retornar
DataSourceSheet
: uma planilha de fonte de dados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumn(columnPosition)
Define a largura da coluna especificada para ajustar o conteúdo.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...'); // Sets the first column to a width which fits the text sheet.autoResizeColumn(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A posição da coluna especificada a ser redimensionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumns(startColumn, numColumns)
Define a largura de todas as colunas começando na posição especificada para ajustar o conteúdo delas.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first 15 columns to a width that fits their text. sheet.autoResizeColumns(1, 15);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startColumn | Integer | A coluna inicial a ser redimensionada automaticamente. |
numColumns | Integer | O número de colunas a serem redimensionadas automaticamente. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeRows(startRow, numRows)
Define a altura de todas as linhas começando na posição da linha especificada para ajustar o conteúdo.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first 15 rows to a height that fits their text. sheet.autoResizeRows(1, 15);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startRow | Integer | A linha inicial a ser redimensionada automaticamente. |
numRows | Integer | O número de linhas a serem redimensionadas automaticamente. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clear()
Limpa a página com o conteúdo e as informações de formatação.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clear();
Retornar
Sheet
: a página apagada.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clear(options)
Limpa a página de conteúdo e/ou formato, conforme especificado com as opções avançadas fornecidas.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.clear({ formatOnly: true, contentsOnly: true });
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
options | Object | Um mapa JavaScript com opções avançadas, listadas abaixo. |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
contentsOnly | Boolean | Indica se o conteúdo deve ser limpo. |
formatOnly | Boolean | Indica se o formato deve ser apagado. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearConditionalFormatRules()
Remove todas as regras de formatação condicional da página. Equivalente a chamar setConditionalFormatRules(rules)
com uma matriz vazia como entrada.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.clearConditionalFormatRules();
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearContents()
Limpa a página de conteúdo, preservando as informações de formatação.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearContents();
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearFormats()
Limpa a página de formatação, preservando o conteúdo.
A formatação refere-se a como os dados são formatados de acordo com o permitido pelas opções no menu "Formato" (por exemplo: negrito, itálico, formatação condicional), e não a largura ou altura das células.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearFormats();
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearNotes()
Limpa a página de todas as notas.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearNotes();
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
collapseAllColumnGroups()
Recolhe todos os grupos de colunas na página.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are collapsed. sheet.collapseAllColumnGroups();
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
collapseAllRowGroups()
Recolhe todos os grupos de linhas na página.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are collapsed. sheet.collapseAllRowGroups();
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyTo(spreadsheet)
Copia a página para uma determinada planilha, que pode ser a mesma planilha da fonte. A página copiada é chamada de "Cópia de [nome original]".
var source = SpreadsheetApp.getActiveSpreadsheet(); var sheet = source.getSheets()[0]; var destination = SpreadsheetApp.openById('ID_GOES HERE'); sheet.copyTo(destination);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
spreadsheet | Spreadsheet | A planilha para a qual esta página será copiada, que pode ser a mesma planilha da fonte. |
Retornar
Sheet
: a nova página para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDeveloperMetadataFinder()
Retorna um DeveloperMetadataFinder
para encontrar metadados de desenvolvedor no escopo desta planilha. Os metadados estão no escopo de uma planilha específica quando estão associados à própria planilha ou a uma linha, coluna ou intervalo nessa planilha.
// 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());
Retornar
DeveloperMetadataFinder
: um localizador de metadados do desenvolvedor para pesquisar metadados no escopo desta planilha.
createTextFinder(findText)
Cria um localizador de texto para a folha, que pode localizar e substituir texto dentro da planilha.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Creates a text finder. var textFinder = sheet.createTextFinder('dog'); // Returns the first occurrence of 'dog' in the sheet. var firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. var numOccurrencesReplaced = findOccurrence.replaceWith('cat');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
findText | String | O texto a ser pesquisado. |
Retornar
TextFinder
: o TextFinder
da planilha.
deleteColumn(columnPosition)
Exclui a coluna na posição de coluna especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first column sheet.deleteColumn(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A posição da coluna, começando em 1 para a primeira coluna. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
deleteColumns(columnPosition, howMany)
Exclui várias colunas começando na posição de coluna especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first two columns sheet.deleteColumns(1, 2);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A posição da primeira coluna a ser excluída. |
howMany | Integer | O número de colunas a serem excluídas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
deleteRow(rowPosition)
Exclui a linha na posição da linha especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first row sheet.deleteRow(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A posição da primeira linha, começando em 1. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
deleteRows(rowPosition, howMany)
Exclui várias linhas começando na posição de linha especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first two rows sheet.deleteRows(1, 2);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A posição da primeira linha a ser excluída. |
howMany | Integer | O número de linhas a serem excluídas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
expandAllColumnGroups()
Expande todos os grupos de colunas na página. Este método requer pelo menos um grupo de colunas.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are expanded. sheet.expandAllColumnGroups();
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
expandAllRowGroups()
Expande todos os grupos de linhas na página. Este método requer pelo menos um grupo de linhas.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are expanded. sheet.expandAllRowGroups();
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
expandColumnGroupsUpToDepth(groupDepth)
Expande todos os grupos de colunas até a profundidade especificada e recolhe todas as outras.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandColumnGroupsUpToDepth(2);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
groupDepth | Integer | A profundidade do grupo até a qual expandir os grupos de colunas. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
expandRowGroupsUpToDepth(groupDepth)
Expande todos os grupos de linhas até a profundidade especificada e recolhe todos os outros.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandRowGroupsUpToDepth(2);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
groupDepth | Integer | A profundidade do grupo até a qual expandir os grupos de linhas. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getActiveCell()
Retorna a célula ativa nesta planilha.
Observação:é preferível usar getCurrentCell()
, que retorna a célula destacada atual.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Returns the active cell var cell = sheet.getActiveCell();
Retornar
Range
: a célula ativa atual.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getActiveRange()
Retorna o intervalo selecionado na página ativa ou null
se não houver um intervalo ativo. Se vários intervalos estiverem selecionados, esse método retornará apenas o último intervalo selecionado.
O termo "intervalo ativo" se refere ao intervalo que um usuário selecionou na página ativa, mas, em uma função personalizada, se refere à célula que está sendo recalculada ativamente.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var activeRange = sheet.getActiveRange();
Retornar
Range
: o intervalo ativo
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Veja também
getActiveRangeList()
Retorna a lista de intervalos ativos na página ativa ou null
se não houver intervalos
ativos.
Se houver apenas um intervalo selecionado, o comportamento será como uma chamada getActiveRange()
.
var sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. var activeRangeList = sheet.getActiveRangeList();
Retornar
RangeList
: a lista de intervalos ativos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Veja também
getBandings()
Retorna todas as faixas nessa planilha.
// 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()); }
Retornar
Banding[]
: todas as faixas da planilha.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCharts()
Retorna uma matriz de gráficos nesta página.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var charts = sheet.getCharts(); for (var i in charts) { var chart = charts[i]; // Do something with the chart }
Retornar
EmbeddedChart[]
: uma matriz de gráficos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnGroup(columnIndex, groupDepth)
Retorna o grupo de colunas no índice e na profundidade de grupo especificados.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at column 2 and has a depth of 1, or // null if the group doesn’t exist. var columnGroup = sheet.getColumnGroup(2, 1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | O índice de coluna do botão de alternância do grupo ou um índice dentro do grupo. |
groupDepth | Integer | A profundidade do grupo. |
Retornar
Group
: o grupo de colunas no índice e na profundidade de controle ou gera uma exceção se o grupo não existir.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnGroupControlPosition()
Retorna o GroupControlTogglePosition
de todos os grupos de colunas na página.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the // group. var columnGroupControlPosition = sheet.getColumnGroupControlPosition();
Retornar
GroupControlTogglePosition
: true
se o botão de alternância do controle de agrupamento de colunas for mostrado após o grupo nesta página. Caso contrário, retorna false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnGroupDepth(columnIndex)
Retorna a profundidade do grupo da coluna no índice especificado.
A profundidade do grupo indica quantos grupos se sobrepõem à coluna. Esse valor pode variar entre zero e oito.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over columns 1 through 3 var groupDepth = sheet.getColumnGroupDepth(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | O índice da coluna. |
Retornar
Integer
: a profundidade do grupo da coluna no índice especificado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnWidth(columnPosition)
Recebe a largura em pixels da coluna especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.getColumnWidth(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A posição da coluna a ser examinada. |
Retornar
Integer
: largura da coluna em pixels.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getConditionalFormatRules()
Receba todas as regras de formatação condicional nesta página.
// Logs the conditional format rules in a sheet. var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules(); for (var i = 0; i < rules.length; i++) { var rule = rules[i]; Logger.log(rule); }
Retornar
ConditionalFormatRule[]
: uma matriz de todas as regras na página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCurrentCell()
Retorna a célula atual na página ativa ou null
se não houver célula atual. A célula atual é aquela que tem foco na IU do Planilhas Google e está destacada por uma borda escura. Nunca há mais de uma célula atual. Quando um usuário seleciona um ou mais intervalos de células,
uma das células na seleção é a célula atual.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); // Returns the current highlighted cell in the one of the active ranges. var currentCell = sheet.getCurrentCell();
Retornar
Range
: a célula atual.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataRange()
Retorna um Range
correspondente às dimensões em que os dados estão presentes.
Isso é funcionalmente equivalente à criação de um intervalo delimitado por A1 e (Sheet.getLastColumn(), Sheet.getLastRow()).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This represents ALL the data var range = sheet.getDataRange(); var values = range.getValues(); // This logs the spreadsheet in CSV format with a trailing comma for (var i = 0; i < values.length; i++) { var row = ""; for (var j = 0; j < values[i].length; j++) { if (values[i][j]) { row = row + values[i][j]; } row = row + ","; } Logger.log(row); }
Retornar
Range
: um intervalo que consiste em todos os dados da planilha.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormulas()
Extrai todas as fórmulas da fonte de dados.
// 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());
Retornar
DataSourceFormula[]
: uma lista de fórmulas da fonte de dados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourcePivotTables()
Recebe todas as tabelas dinâmicas da fonte de dados.
// 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());
Retornar
DataSourcePivotTable[]
: uma lista de tabelas dinâmicas da fonte de dados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceTables()
Extrai todas as tabelas da fonte de dados.
// 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());
Retornar
DataSourceTable[]
: uma lista de tabelas de fonte de dados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDeveloperMetadata()
Receba todos os metadados do desenvolvedor associados a esta planilha.
// 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()); }
Retornar
DeveloperMetadata[]
: os metadados do desenvolvedor associados à planilha.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDrawings()
Retorna uma matriz de desenhos na página.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets 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);
Retornar
Drawing[]
: a lista de desenhos da página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilter()
Retorna o filtro nesta página ou null
se não houver filtro.
// Gets the filter on the active sheet. let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter();
Retornar
Filter
: o filtro.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormUrl()
Retorna o URL do formulário que envia as respostas a essa página ou null
se a página não tiver um formulário associado.
var sheet = SpreadsheetApp.getActiveSheet(); var url = sheet.getFormUrl();
Retornar
String
: o URL do formulário que coloca as respostas nessa página ou null
se a página não tiver um formulário associado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFrozenColumns()
Retorna o número de colunas congeladas.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());
Retornar
Integer
: o número de colunas congeladas
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFrozenRows()
Retorna o número de linhas congeladas.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());
Retornar
Integer
: o número de linhas congeladas
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getImages()
Retorna todas as imagens sobre a grade da página.
// 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()); }
Retornar
OverGridImage[]
: uma matriz de imagens sobre a grade.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getIndex()
Recebe a posição da página na planilha pai. Começa em 1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); // Note that the JavaScript index is 0, but this logs 1 var sheet = ss.getSheets()[0]; // ... because spreadsheets are 1-indexed Logger.log(sheet.getIndex());
Retornar
Integer
: a posição da página na planilha mãe.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getLastColumn()
Retorna a posição da última coluna que possui conteúdo.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
Retornar
Integer
: a última coluna da página que contém o conteúdo
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getLastRow()
Retorna a posição da última linha que tem conteúdo.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
Retornar
Integer
: a última linha da página que contém o conteúdo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getMaxColumns()
Retorna o número atual de colunas na página, independentemente do conteúdo.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); Logger.log(first.getMaxColumns());
Retornar
Integer
: a largura máxima da página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getMaxRows()
Retorna o número atual de linhas na página, independentemente do conteúdo.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); Logger.log(first.getMaxRows());
Retornar
Integer
: a altura máxima da página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getName()
Retorna o nome da planilha.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getName());
Retornar
String
: o nome da página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNamedRanges()
Extrai todos os intervalos nomeados nesta página.
// The code below logs the name of the first named range. var namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges(); if (namedRanges.length > 1) { Logger.log(namedRanges[0].getName()); }
Retornar
NamedRange[]
: uma matriz de todos os intervalos nomeados na página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getParent()
Retorna o Spreadsheet
que contém a página.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // parent is identical to ss var parent = sheet.getParent();
Retornar
Spreadsheet
: a planilha mãe.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getPivotTables()
Retorna todas as tabelas dinâmicas nesta página.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets 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()); }
Retornar
PivotTable[]
: as tabelas dinâmicas da página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getProtections(type)
Recebe uma matriz de objetos que representam todos os intervalos protegidos na página ou uma matriz de elemento único que representa a proteção na própria página.
// Remove all range protections in the spreadsheet that the user has permission to edit. var sheet = SpreadsheetApp.getActiveSheet(); var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE); for (var i = 0; i < protections.length; i++) { var protection = protections[i]; if (protection.canEdit()) { protection.remove(); } }
// Remove sheet protection from the active sheet, if the user has permission to edit it. var sheet = SpreadsheetApp.getActiveSheet(); var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0]; if (protection && protection.canEdit()) { protection.remove(); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
type | ProtectionType | O tipo de área protegida, SpreadsheetApp.ProtectionType.RANGE ou SpreadsheetApp.ProtectionType.SHEET . |
Retornar
Protection[]
: uma matriz de objetos que representa todos os intervalos protegidos na página ou uma matriz de um único elemento que representa a proteção na própria página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(row, column)
Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Passing only two arguments returns a "range" with a single cell. var range = sheet.getRange(1, 1); var values = range.getValues(); Logger.log(values[0][0]);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice de linhas da célula a ser retornada; a indexação de linhas começa com 1. |
column | Integer | O índice de colunas da célula a ser retornada; a indexação de colunas começa com 1. |
Retornar
Range
: um intervalo que contém apenas esta célula.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(row, column, numRows)
Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas e com o número de linhas especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // When the "numRows" argument is used, only a single column of data is returned. var range = sheet.getRange(1, 1, 3); var values = range.getValues(); // Prints 3 values from the first column, starting from row 1. for (var row in values) { for (var col in values[row]) { Logger.log(values[row][col]); } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice da linha inicial do intervalo. A indexação de linhas começa com 1. |
column | Integer | O índice de colunas do intervalo. A indexação de colunas começa com 1. |
numRows | Integer | O número de linhas a serem retornadas. |
Retornar
Range
: um intervalo que contém uma única coluna de dados com o número de linhas especificado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(row, column, numRows, numColumns)
Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas com o número especificado de linhas e colunas.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange(1, 1, 3, 3); var values = range.getValues(); // Print values from a 3x3 box. for (var row in values) { for (var col in values[row]) { Logger.log(values[row][col]); } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice da linha inicial do intervalo. A indexação de linhas começa com 1. |
column | Integer | O índice da coluna inicial do intervalo. A indexação de colunas começa com 1. |
numRows | Integer | O número de linhas a serem retornadas. |
numColumns | Integer | O número de colunas a serem retornadas. |
Retornar
Range
: um intervalo correspondente à área especificada.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(a1Notation)
Retorna o intervalo conforme especificado na notação A1 ou R1C1.
// Get a range A1:D4 on sheet titled "Invoices" var ss = SpreadsheetApp.getActiveSpreadsheet(); var range = ss.getRange("Invoices!A1:D4"); // Get cell A1 on the first sheet var sheet = ss.getSheets()[0]; var cell = sheet.getRange("A1");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
a1Notation | String | O intervalo a ser retornado, conforme especificado na notação A1 ou R1C1. |
Retornar
Range
: o intervalo no local designado
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRangeList(a1Notations)
Retorna a coleção RangeList
que representa os intervalos na mesma página especificada por uma lista não vazia de notações A1 ou R1C1.
// Get a list of ranges A1:D4, F1:H4. var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
a1Notations | String[] | A lista de intervalos a serem retornados, conforme especificado na notação A1 ou R1C1. |
Retornar
RangeList
: a lista de intervalos no local designado
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowGroup(rowIndex, groupDepth)
Retorna o grupo de linhas com o índice e a profundidade do grupo especificados.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at row 2 and has a depth of 1, or // null if the group doesn’t exist. var rowGroup = sheet.getRowGroup(2, 1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice de linha do controle de grupo ou um índice dentro do grupo. |
groupDepth | Integer | A profundidade do grupo. |
Retornar
Group
: o grupo de linhas no índice e na profundidade de controle ou gera uma exceção se o grupo não existir.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowGroupControlPosition()
Retorna GroupControlTogglePosition
para todos os grupos de linhas na página.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the // group. var rowGroupControlPosition = sheet.getRowGroupControlPosition();
Retornar
GroupControlTogglePosition
: true
se o controle de agrupamento de linhas for mostrado após o grupo na página. Caso contrário, retorna false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowGroupDepth(rowIndex)
Retorna a profundidade do grupo da linha no índice especificado.
A profundidade do grupo indica quantos grupos se sobrepõem à linha. Isso pode variar entre zero e oito.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over rows 1 through 3 var groupDepth = sheet.getRowGroupDepth(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice da linha. |
Retornar
Integer
: a profundidade do grupo da linha no índice especificado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowHeight(rowPosition)
Recebe a altura em pixels da linha especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.getRowHeight(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A posição da linha a ser examinada. |
Retornar
Integer
: altura da linha em pixels
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSelection()
Retorna o Selection
atual na planilha.
var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection(); var currentCell = selection.getCurrentCell();
Retornar
Selection
: a seleção atual.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetId()
Retorna o ID da página representada por esse objeto.
Esse é um ID da página que é exclusivo da planilha. O ID é um número inteiro monotonicamente crescente, atribuído no momento da criação da página, independentemente da posição dela. Isso
é útil junto com métodos como Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd)
, que usam um parâmetro gridId
em vez de uma instância Sheet
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetId());
Retornar
Integer
: um ID da página exclusivo da planilha.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetName()
Retorna o nome da página.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetName());
Retornar
String
: o nome da página
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(startRow, startColumn, numRows, numColumns)
Retorna a grade retangular de valores para este intervalo a partir das coordenadas fornecidas. Um valor -1 fornecido como posição da linha ou coluna é equivalente a obter a última linha ou coluna que contém dados na planilha.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The two samples below produce the same output var values = sheet.getSheetValues(1, 1, 3, 3); Logger.log(values); var range = sheet.getRange(1, 1, 3, 3); values = range.getValues(); Logger.log(values);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startRow | Integer | A posição da linha inicial. |
startColumn | Integer | A posição da coluna inicial. |
numRows | Integer | O número de linhas para retornar valores. |
numColumns | Integer | O número de colunas para as quais os valores serão retornados. |
Retornar
Object[][]
: uma matriz bidimensional de valores
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSlicers()
Retorna uma matriz de controles de filtros na página.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets 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()); }
Retornar
Slicer[]
: a lista de controles de filtros na página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTabColorObject()
Recebe a cor da guia da página ou null
se ela não tiver cor.
// This example assumes there is a sheet named "Sheet1" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var color = first.getTabColorObject();
Retornar
Color
: a cor da guia da página ou null
se ela não tiver cor.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getType()
Retorna o tipo da planilha.
O tipo de página padrão é SheetType.GRID
. Uma página que contém um único objeto incorporado, como EmbeddedChart
, é uma página SheetType.OBJECT
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getType());
Retornar
SheetType
: o tipo da página.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hasHiddenGridlines()
Retornará true
se as linhas de grade da página estiverem ocultas. Caso contrário, retornará false
.
As linhas de grade ficam visíveis por padrão.
// 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());
Retornar
Boolean
: true
se as linhas de grade estiverem ocultas. Caso contrário, false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideColumn(column)
Oculta a coluna ou as colunas no intervalo especificado.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // This hides the first column let range = sheet.getRange("A1"); sheet.hideColumn(range); // This hides the first 3 columns let range = sheet.getRange("A:C"); sheet.hideColumn(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Range | O intervalo da coluna a ser ocultado. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideColumns(columnIndex)
Oculta uma única coluna no índice especificado. Use o índice 1 para esse método.
Para ocultar mais de uma coluna usando um índice, use hideColumns(columnIndex, numColumns)
.
Para ocultar mais de uma coluna usando um intervalo, use hideColumn()
.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // Hides the first column sheet.hideColumns(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | O índice da coluna a ser ocultada. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideColumns(columnIndex, numColumns)
Oculta uma ou mais colunas consecutivas a partir do índice especificado. Use o índice 1 para esse método.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first three columns sheet.hideColumns(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | O índice inicial das colunas a serem ocultadas. |
numColumns | Integer | O número de colunas a serem ocultadas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideRow(row)
Oculta as linhas no intervalo especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This hides the first row var range = sheet.getRange("A1"); sheet.hideRow(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Range | O intervalo de linha a ser ocultado. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideRows(rowIndex)
A linha no índice especificado é oculta.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first row sheet.hideRows(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice da linha a ser ocultada. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideRows(rowIndex, numRows)
Oculta uma ou mais linhas consecutivas começando no índice especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first three rows sheet.hideRows(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice inicial das linhas a serem ocultadas. |
numRows | Integer | O número de linhas a serem ocultadas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideSheet()
Oculta esta página. Não tem efeito se a página já estiver oculta. Se esse método for chamado na única página visível, ele vai gerar uma exceção.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.hideSheet();
Retornar
Sheet
: a página atual.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertChart(chart)
Adiciona um novo gráfico à página.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This creates a simple bar chart from the first three rows // of the first two columns of the spreadsheet var chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange("A1:B4")) .setPosition(5, 5, 0, 0) .setOption("title", "Dynamic Chart") .build(); sheet.insertChart(chart);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
chart | EmbeddedChart | O gráfico a ser inserido. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumnAfter(afterPosition)
Insere uma coluna após a posição de coluna especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column after the first column position sheet.insertColumnAfter(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
afterPosition | Integer | A coluna após a qual a nova coluna deve ser adicionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumnBefore(beforePosition)
Insere uma coluna antes da posição da coluna especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column in the first column position sheet.insertColumnBefore(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
beforePosition | Integer | A coluna antes da qual a nova coluna deve ser adicionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumns(columnIndex)
Insere uma coluna em branco em uma página no local especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all columns by one sheet.insertColumns(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | O índice que indica onde inserir uma coluna. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumns(columnIndex, numColumns)
Insere uma ou mais colunas em branco consecutivas em uma página, começando no local especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all columns by three sheet.insertColumns(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | O índice que indica onde inserir uma coluna. |
numColumns | Integer | O número de colunas a serem inseridas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumnsAfter(afterPosition, howMany)
Insere várias colunas após a posição de coluna especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column in the second column position sheet.insertColumnsAfter(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
afterPosition | Integer | A coluna após a qual a nova coluna deve ser adicionada. |
howMany | Integer | O número de colunas a serem inseridas. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumnsBefore(beforePosition, howMany)
Insere várias colunas antes da posição especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five columns before the first column sheet.insertColumnsBefore(1, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
beforePosition | Integer | A coluna antes da qual a nova coluna deve ser adicionada. |
howMany | Integer | O número de colunas a serem inseridas. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertImage(blobSource, column, row)
Insere um BlobSource
como uma imagem no documento em uma determinada linha e coluna. O tamanho da imagem é recuperado do conteúdo do blob. O tamanho máximo de blob com suporte é 2 MB.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
blobSource | BlobSource | O blob contendo o conteúdo da imagem, o tipo MIME e, opcionalmente, o nome. |
column | Integer | A posição da coluna. |
row | Integer | A posição da linha. |
Retornar
OverGridImage
: a imagem inserida.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertImage(blobSource, column, row, offsetX, offsetY)
Insere um BlobSource
como uma imagem no documento em uma determinada linha e coluna, com um
deslocamento de pixels. O tamanho da imagem é recuperado do conteúdo do blob. O tamanho máximo de blob com suporte é 2 MB.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1, 10, 10);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
blobSource | BlobSource | O blob contendo o conteúdo da imagem, o tipo MIME e, opcionalmente, o nome. |
column | Integer | A posição da coluna. |
row | Integer | A posição da linha. |
offsetX | Integer | O deslocamento horizontal do canto da célula em pixels. |
offsetY | Integer | O deslocamento vertical do canto da célula em pixels. |
Retornar
OverGridImage
: a imagem inserida.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertImage(url, column, row)
Insere uma imagem no documento em uma determinada linha e coluna.
O URL fornecido precisa ser acessível publicamente.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
url | String | É o URL da imagem. |
column | Integer | Posição da coluna da grade. |
row | Integer | Posição da linha da grade. |
Retornar
OverGridImage
: a imagem inserida.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertImage(url, column, row, offsetX, offsetY)
Insere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixels.
O URL fornecido precisa ser acessível publicamente.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
url | String | URL da imagem. |
column | Integer | A posição da coluna. |
row | Integer | A posição da linha. |
offsetX | Integer | O deslocamento horizontal do canto da célula em pixels. |
offsetY | Integer | O deslocamento vertical do canto da célula em pixels. |
Retornar
OverGridImage
: a imagem inserida.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRowAfter(afterPosition)
Insere uma linha após a posição da linha especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a row after the first row position sheet.insertRowAfter(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
afterPosition | Integer | A linha após a qual a nova linha deve ser adicionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRowBefore(beforePosition)
Insere uma linha antes da posição da linha especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a row before the first row position sheet.insertRowBefore(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
beforePosition | Integer | A linha antes da qual a nova linha deve ser adicionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRows(rowIndex)
Insere uma linha em branco em uma página no local especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all rows down by one sheet.insertRows(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice que indica onde inserir uma linha. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRows(rowIndex, numRows)
Insere uma ou mais linhas em branco consecutivas em uma página, começando no local especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all rows down by three sheet.insertRows(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice que indica onde inserir uma linha. |
numRows | Integer | O número de linhas a serem inseridas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRowsAfter(afterPosition, howMany)
Insere várias linhas após a posição da linha especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five rows after the first row sheet.insertRowsAfter(1, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
afterPosition | Integer | A linha após a qual as novas linhas devem ser adicionadas. |
howMany | Integer | O número de linhas a serem inseridas. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRowsBefore(beforePosition, howMany)
Insere várias linhas antes da posição da linha especificada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five rows before the first row sheet.insertRowsBefore(1, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
beforePosition | Integer | A linha antes da qual as novas linhas devem ser adicionadas. |
howMany | Integer | O número de linhas a serem inseridas. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSlicer(range, anchorRowPos, anchorColPos)
Adiciona um novo controle de filtros à página.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets 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
Nome | Tipo | Descrição |
---|---|---|
range | Range | O intervalo em que o controle de filtros é criado. |
anchorRowPos | Integer | A parte de cima do controle é ancorada nessa linha. |
anchorColPos | Integer | A parte de cima do controle de filtros está ancorada nesta coluna. |
Retornar
Slicer
: o controle de filtros inserido recentemente.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)
Adiciona um novo controle de filtros à página.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets 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
Nome | Tipo | Descrição |
---|---|---|
range | Range | O intervalo em que o controle de filtros é criado. |
anchorRowPos | Integer | A parte de cima do controle é ancorada nessa linha. |
anchorColPos | Integer | A parte de cima do controle de filtros está ancorada nesta coluna. |
offsetX | Integer | O deslocamento horizontal do canto da célula em pixels. |
offsetY | Integer | O deslocamento vertical do canto da célula em pixels. |
Retornar
Slicer
: o controle de filtros inserido recentemente.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isColumnHiddenByUser(columnPosition)
Retorna se a coluna especificada está oculta pelo usuário.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.isColumnHiddenByUser(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A posição da coluna a ser examinada. |
Retornar
Boolean
: true
se a coluna estiver oculta. Caso contrário, false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isRightToLeft()
Retorna true
se esse layout de página for da direita para a esquerda. Retorna false
se a página
usar o layout padrão da esquerda para a direita.
// 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());
Retornar
Boolean
: true
se for da direita para a esquerda. Caso contrário, false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isRowHiddenByFilter(rowPosition)
Retorna se a linha especificada está oculta por um filtro (não por uma visualização com filtro).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByFilter(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A posição da linha a ser examinada. |
Retornar
Boolean
: true
se a linha estiver oculta. Caso contrário, false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isRowHiddenByUser(rowPosition)
Retorna se a linha fornecida está oculta pelo usuário.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByUser(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A posição da linha a ser examinada. |
Retornar
Boolean
: true
se a linha estiver oculta. Caso contrário, false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isSheetHidden()
Retorna true
se a página estiver oculta no momento.
var sheet = SpreadsheetApp.getActiveSheet(); if (sheet.isSheetHidden()) { // do something... }
Retornar
Boolean
: true
se a página estiver oculta. Caso contrário, retorna false
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
moveColumns(columnSpec, destinationIndex)
Move as colunas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex
. O próprio columnSpec
não precisa representar exatamente uma coluna
inteira ou um grupo de colunas para mover. Ele seleciona todas as colunas que o intervalo abrange.
// The code below moves rows A-B to destination index 5. // This results in those columns becoming columns C-D. var sheet = SpreadsheetApp.getActiveSheet(); // Selects column A and column B to be moved. var columnSpec = sheet.getRange("A1:B1"); sheet.moveColumns(columnSpec, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnSpec | Range | Um intervalo que abrange as colunas que serão movidas. |
destinationIndex | Integer | O índice para o qual as colunas precisam ser movidas. Esse índice é baseado nas coordenadas anteriores à movimentação das colunas. Os dados atuais são deslocados para a direita, a fim de criar espaço para as colunas movidas, enquanto as colunas de origem são removidas da grade. Portanto, os dados podem acabar em um índice diferente do especificado originalmente. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
moveRows(rowSpec, destinationIndex)
Move as linhas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex
. O próprio rowSpec
não precisa representar exatamente uma linha inteira
ou um grupo de linhas para mover. Ele seleciona todas as linhas que o intervalo abrange.
// The code below moves rows 1-2 to destination index 5. // This results in those rows becoming rows 3-4. var sheet = SpreadsheetApp.getActiveSheet(); // Selects row 1 and row 2 to be moved. var rowSpec = sheet.getRange("A1:A2"); sheet.moveRows(rowSpec, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowSpec | Range | Um intervalo que abrange as linhas que precisam ser movidas. |
destinationIndex | Integer | O índice para o qual as linhas precisam ser movidas. Esse índice é baseado nas coordenadas anteriores à movimentação das linhas. Os dados atuais são deslocados para baixo, a fim de criar espaço para as linhas movidas, enquanto as linhas de origem são removidas da grade. Portanto, os dados podem chegar a um índice diferente do especificado originalmente. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
newChart()
Retorna um construtor para criar um novo gráfico para esta planilha.
Este exemplo mostra como criar um novo gráfico:
var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("A1:B8"); var chartBuilder = sheet.newChart(); chartBuilder.addRange(range) .setChartType(Charts.ChartType.LINE) .setPosition(2, 2, 0, 0) .setOption('title', 'My Line Chart!'); sheet.insertChart(chartBuilder.build());
Retornar
EmbeddedChartBuilder
: um builder para gerar um novo gráfico.
protect()
Cria um objeto que pode impedir que a página seja editada, exceto por usuários com permissão. Até que o script mude a lista de editores da planilha (chamando Protection.removeEditor(emailAddress)
, Protection.removeEditor(user)
, Protection.removeEditors(emailAddresses)
, Protection.addEditor(emailAddress)
, Protection.addEditor(user)
, Protection.addEditors(emailAddresses)
ou definindo um novo valor para Protection.setDomainEdit(editable)
), as permissões espelham as da própria planilha, o que significa que a página permanece desprotegida. Se a página já estiver protegida, esse método retornará um objeto que representa as configurações de proteção atuais.
Uma página protegida pode incluir regiões desprotegidas.
// Protect the active sheet, then remove all other users from the list of editors. var sheet = SpreadsheetApp.getActiveSheet(); var protection = sheet.protect().setDescription('Sample protected sheet'); // Ensure the current user is an editor before removing others. Otherwise, if the user's edit // permission comes from a group, the script throws an exception upon removing the group. var me = Session.getEffectiveUser(); protection.addEditor(me); protection.removeEditors(protection.getEditors()); if (protection.canDomainEdit()) { protection.setDomainEdit(false); }
Retornar
Protection
: um objeto que representa as configurações de proteção.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeChart(chart)
Remove um gráfico da página pai.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This removes all the embedded charts from the spreadsheet var charts = sheet.getCharts(); for (var i in charts) { sheet.removeChart(charts[i]); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
chart | EmbeddedChart | O gráfico a ser removido. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveRange(range)
Define o intervalo especificado como o active range
na página ativa, com
a célula superior esquerda no intervalo como current cell
.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var range = sheet.getRange('A1:D4'); sheet.setActiveRange(range); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D4 var activeRange = selection.getActiveRange();
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
range | Range | O intervalo a ser definido como o intervalo ativo. |
Retornar
Range
: o intervalo ativo recentemente.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveRangeList(rangeList)
Define a lista especificada de intervalos como o active ranges
na
página ativa. O último intervalo da lista é definido como o active range
.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['D4', 'B2:C4']); sheet.setActiveRangeList(rangeList); var selection = sheet.getSelection(); // Current cell: B2 var currentCell = selection.getCurrentCell(); // Active range: B2:C4 var activeRange = selection.getActiveRange(); // Active range list: [D4, B2:C4] var activeRangeList = selection.getActiveRangeList();
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rangeList | RangeList | Lista de intervalos a selecionar. |
Retornar
RangeList
: a lista de intervalos selecionada recentemente.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveSelection(range)
Define a região de seleção ativa para a planilha.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D4"); sheet.setActiveSelection(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
range | Range | O intervalo a ser definido como a seleção ativa. |
Retornar
Range
: o intervalo ativo recentemente.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveSelection(a1Notation)
Define a seleção ativa, conforme especificado na notação A1 ou R1C1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.setActiveSelection("A1:D4");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
a1Notation | String | O intervalo a ser definido como ativo, conforme especificado na notação A1 ou R1C1. |
Retornar
Range
: o intervalo ativo recentemente.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnGroupControlPosition(position)
Define a posição do botão de alternância do controle do grupo de colunas na página.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setColumnGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
position | GroupControlTogglePosition | A posição do botão de alternância do controle do grupo de colunas. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidth(columnPosition, width)
Define a largura da coluna especificada em pixels.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first column to a width of 200 pixels sheet.setColumnWidth(1, 200);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A posição da coluna a ser definida. |
width | Integer | A largura em pixels a ser definida. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidths(startColumn, numColumns, width)
Define a largura das colunas especificadas em pixels.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three columns to a width of 200 pixels sheet.setColumnWidths(1, 3, 200);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startColumn | Integer | A posição da coluna inicial a ser alterada. |
numColumns | Integer | O número de colunas a serem alteradas. |
width | Integer | A largura em pixels a ser definida. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setConditionalFormatRules(rules)
Substitui todas as regras de formatação condicional existentes na página pelas regras de entrada. As regras são avaliadas na ordem de entrada.
// Remove one of the existing conditional format rules. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); rules.splice(1, 1); // Deletes the 2nd format rule. sheet.setConditionalFormatRules(rules);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rules | ConditionalFormatRule[] | As novas regras de formatação condicional. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setCurrentCell(cell)
Define a célula especificada como current cell
.
Se a célula especificada estiver presente em um intervalo já selecionado, esse intervalo se tornará o intervalo ativo com a célula como a célula atual.
Se a célula especificada não estiver presente em nenhum intervalo selecionado, qualquer seleção existente será removida e a célula se tornará a célula atual e o intervalo ativo.
Observação:o Range
especificado precisa consistir em uma célula. Caso contrário, ele gera uma
exceção.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var cell = sheet.getRange('B5'); sheet.setCurrentCell(cell); var selection = sheet.getSelection(); // Current cell: B5 var currentCell = selection.getCurrentCell();
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
cell | Range | A célula a ser definida como a célula atual. |
Retornar
Range
: a célula atual recém-definida.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFrozenColumns(columns)
Congela o número determinado de colunas. Se for zero, nenhuma coluna será congelada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Freezes the first column sheet.setFrozenColumns(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columns | Integer | O número de colunas a serem congeladas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFrozenRows(rows)
Congela o número fornecido de linhas. Se for zero, nenhuma linha será congelada.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Freezes the first row sheet.setFrozenRows(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rows | Integer | O número de linhas a serem congeladas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setHiddenGridlines(hideGridlines)
Oculta ou revela as linhas de grade da página.
// 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
Nome | Tipo | Descrição |
---|---|---|
hideGridlines | Boolean | Se for true , oculte as linhas de grade nesta página. Caso contrário, mostre as
de grade. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setName(name)
Define o nome da página.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.setName("not first anymore");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | O novo nome da planilha. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRightToLeft(rightToLeft)
Define ou cancela a configuração do layout da página da direita para a esquerda.
// 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
Nome | Tipo | Descrição |
---|---|---|
rightToLeft | Boolean | Se for true , o layout da página será definido da direita para a esquerda, com a célula A1 no
canto superior direito. Se definido como false , o layout da página será definido como o padrão da esquerda para a direita, com a célula A1 no canto superior esquerdo. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowGroupControlPosition(position)
Define a posição do botão de alternância do controle do grupo de linhas na página.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setRowGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
position | GroupControlTogglePosition | A posição do botão de alternância do controle do grupo de linhas. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowHeight(rowPosition, height)
Define a altura da linha especificada em pixels. Por padrão, as linhas crescem para ajustar o conteúdo da célula. Se
você quiser forçar as linhas a uma altura especificada, use setRowHeightsForced(startRow, numRows, height)
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first row to a height of 200 pixels sheet.setRowHeight(1, 200);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A posição da linha a ser alterada. |
height | Integer | A altura em pixels para a definição. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowHeights(startRow, numRows, height)
Define a altura das linhas fornecidas em pixels. Por padrão, as linhas crescem para ajustar o conteúdo da célula. Se você
quiser forçar as linhas a uma altura especificada, use setRowHeightsForced(startRow, numRows, height)
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 20 pixels sheet.setRowHeights(1, 3, 20);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startRow | Integer | A posição da linha inicial a ser alterada. |
numRows | Integer | O número de linhas que serão alteradas. |
height | Integer | A altura em pixels para a definição. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowHeightsForced(startRow, numRows, height)
Define a altura das linhas fornecidas em pixels. Por padrão, as linhas crescem para ajustar o conteúdo da célula. Quando você usa setRowHeightsForced
, as linhas são forçadas para a altura especificada, mesmo que o conteúdo da célula seja mais alto que a altura da linha.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 5 pixels. sheet.setRowHeightsForced(1, 3, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startRow | Integer | A posição da linha inicial a ser alterada. |
numRows | Integer | O número de linhas que serão alteradas. |
height | Integer | A altura em pixels para a definição. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTabColor(color)
Define a cor da guia da página.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.setTabColor("ff0000"); // Set the color to red. first.setTabColor(null); // Unset the color.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | String | Um código de cor na notação CSS (como '#ffffff' ou 'white' ) ou null para redefinir a cor da guia. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTabColorObject(color)
Define a cor da guia da página.
// This example assumes there is a sheet named "Sheet1" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var color = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); first.setTabColorObject(color); // Set the color to theme accent 1. first.setTabColorObject(null); // Unset the color.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | Color | A cor da guia da página a ser definida. |
Retornar
Sheet
: esta planilha, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showColumns(columnIndex)
Reexibe a coluna no índice especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first column sheet.showColumns(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | O índice da coluna a ser exibida. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showColumns(columnIndex, numColumns)
Reexibe uma ou mais colunas consecutivas a partir do índice especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first three columns sheet.showColumns(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | O índice inicial das colunas a serem exibidas. |
numColumns | Integer | O número de colunas que serão exibidas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showRows(rowIndex)
Reexibe a linha no índice especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first row sheet.showRows(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice da linha a ser exibida. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showRows(rowIndex, numRows)
Mostra uma ou mais linhas consecutivas a partir do índice especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first three rows sheet.showRows(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice inicial das linhas a serem exibidas. |
numRows | Integer | O número de linhas a serem exibidas. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showSheet()
Torna a página visível. Não tem efeito se a página já estiver visível.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.showSheet();
Retornar
Sheet
: a página atual.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
sort(columnPosition)
Classifica uma página por coluna, em ordem crescente.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, ascending sheet.sort(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | Coluna para classificação. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
sort(columnPosition, ascending)
Classifica uma página por coluna. Usa um parâmetro para especificar de forma crescente ou decrescente.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, descending sheet.sort(1, false);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | Coluna para classificação. |
ascending | Boolean | true para classificações crescentes e false para decrescentes. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
unhideColumn(column)
Reexibe a coluna no intervalo especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This unhides the first column if it was previously hidden var range = sheet.getRange("A1"); sheet.unhideColumn(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Range | O intervalo a ser exibido, se estiver oculto. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
unhideRow(row)
Mostra a linha no intervalo especificado.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This unhides the first row if it was previously hidden var range = sheet.getRange("A1"); sheet.unhideRow(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Range | O intervalo a ser exibido, se estiver oculto. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
updateChart(chart)
Atualiza o gráfico nesta página.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This code is going to loop through all the charts and change them to // column charts var charts = sheet.getCharts(); for (var i in charts) { var chart = charts[i]; var newChart = chart .modify() .setChartType(Charts.ChartType.COLUMN) .build(); sheet.updateChart(newChart); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
chart | EmbeddedChart | O gráfico a ser atualizado. |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets