Class Selection

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Seleção

Acessar a seleção ativa atual na página ativa. Uma seleção é o conjunto de células destacado pelo usuário na página, que podem ser intervalos não adjacentes. Uma das células da seleção é a célula atual, em que o foco atual do usuário está. A célula atual está destacada com uma borda mais escura na IU do Planilhas Google.

var activeSheet = SpreadsheetApp.getActiveSheet();
var rangeList = activeSheet.getRangeList(['A1:B4', 'D1:E4']);
rangeList.activate();

var selection = activeSheet.getSelection();
// Current Cell: D1
Logger.log('Current Cell: ' + selection.getCurrentCell().getA1Notation());
// Active Range: D1:E4
Logger.log('Active Range: ' + selection.getActiveRange().getA1Notation());
// Active Ranges: A1:B4, D1:E4
var ranges =  selection.getActiveRangeList().getRanges();
for (var i = 0; i < ranges.length; i++) {
  Logger.log('Active Ranges: ' + ranges[i].getA1Notation());
}
Logger.log('Active Sheet: ' + selection.getActiveSheet().getName());

Métodos

MétodoTipo de retornoBreve descrição
getActiveRange()RangeRetorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos.
getActiveSheet()SheetRetorna a planilha ativa na planilha.
getCurrentCell()RangeRetorna a célula atual (em destaque) que está selecionada em um dos intervalos ativos ou null se não houver uma célula atual.
getNextDataRange(direction)RangeComeçando com current cell e active range e movendo na direção especificada, retorna um intervalo ajustado em que a borda adequada do intervalo foi alterada para cobrir o next data cell enquanto ainda cobre a célula atual.

Documentação detalhada

getActiveRange()

Retorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo. Se vários intervalos forem selecionados, esse método retornará apenas o último intervalo selecionado.

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

getActiveRangeList()

Retorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos.

Se houver um único intervalo selecionado, ele se comportará 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

getActiveSheet()

Retorna a planilha ativa na planilha.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var activeSheet = selection.getActiveSheet();

Retornar

Sheet: a página ativa na 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

getCurrentCell()

Retorna a célula atual (em destaque) que está selecionada em um dos intervalos ativos ou null se não houver uma célula atual.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = selection.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

getNextDataRange(direction)

Começando com current cell e active range e movendo na direção especificada, retorna um intervalo ajustado em que a borda adequada do intervalo foi alterada para cobrir o next data cell enquanto ainda cobre a célula atual. Se o intervalo ativo for ilimitado ao longo do dimension da direção, o intervalo ativo original será retornado. Se não houver célula atual ou intervalo ativo, null será retornado. Isso equivale a selecionar um intervalo no editor e pressionar Ctrl+Shift+[arrow key].

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Makes C3 the current cell and C3:E5 the active range.
sheet.getRange("C3:E5").activate();
// Logs "C1:E3"
Logger.log(SpreadsheetApp.getSelection().getNextDataRange(Direction.UP).getA1Notation());

Parâmetros

NomeTipoDescrição
directionDirectionA direção na qual encontrar a próxima célula de borda da região de dados.

Retornar

Range: o intervalo ajustado que inclui a célula de dados, ou null se não houver seleçã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