Class RangeList

RangeList

Uma coleção de uma ou mais instâncias de Range na mesma página. Você pode usar esta classe para aplicar operações em coleções de células ou intervalos não adjacentes.

Métodos

MétodoTipo de retornoBreve descrição
activate()RangeListSeleciona a lista de instâncias de Range.
breakApart()RangeListDividir todas as células mescladas horizontalmente ou verticalmente contidas na lista de intervalos em células individuais novamente.
check()RangeListAltera o estado das caixas de seleção no intervalo para "marcada".
clear()RangeListLimpa o intervalo de conteúdos, formatos e regras de validação de dados para cada Range em a lista de intervalos.
clear(options)RangeListLimpa o intervalo de conteúdo, formato, regras de validação de dados e comentários, conforme especificado com as opções fornecidas.
clearContent()RangeListLimpa o conteúdo de cada Range na lista de intervalos, deixando a formatação intacta.
clearDataValidations()RangeListLimpa as regras de validação de dados para cada Range na lista de intervalos.
clearFormat()RangeListLimpa a formatação do texto para cada Range na lista de intervalos.
clearNote()RangeListLimpa a nota de cada Range na lista de intervalos.
getRanges()Range[]Retorna uma lista de uma ou mais instâncias de Range na mesma página.
insertCheckboxes()RangeListInsere caixas de seleção em cada célula do intervalo, configuradas com true para selecionadas e false para desmarcado.
insertCheckboxes(checkedValue)RangeListInsere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para as a string vazia para desmarcar.
insertCheckboxes(checkedValue, uncheckedValue)RangeListInsere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para o campo e não marcados.
removeCheckboxes()RangeListRemove todas as caixas de seleção do intervalo.
setBackground(color)RangeListDefine a cor do plano de fundo de cada Range na lista de intervalos.
setBackgroundRGB(red, green, blue)RangeListDefine o plano de fundo com a cor RGB especificada.
setBorder(top, left, bottom, right, vertical, horizontal)RangeListDefine a propriedade de borda para cada Range na lista de intervalos.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeListDefine a propriedade de borda com cor e/ou estilo para cada Range na lista de intervalos.
setFontColor(color)RangeListDefine a cor da fonte de cada Range na lista de intervalos.
setFontFamily(fontFamily)RangeListDefine a família de fontes de cada Range na lista de intervalos.
setFontLine(fontLine)RangeListDefine o estilo da linha de fonte para cada Range na lista de intervalos.
setFontSize(size)RangeListDefine o tamanho da fonte (em pontos) para cada Range na lista de intervalos.
setFontStyle(fontStyle)RangeListDefina o estilo da fonte para cada Range na lista de intervalos.
setFontWeight(fontWeight)RangeListDefina a espessura da fonte de cada Range na lista de intervalos.
setFormula(formula)RangeListAtualiza a fórmula para cada Range na lista de intervalos.
setFormulaR1C1(formula)RangeListAtualiza a fórmula para cada Range na lista de intervalos.
setHorizontalAlignment(alignment)RangeListDefina o alinhamento horizontal para cada Range na lista de intervalos.
setNote(note)RangeListDefine o texto da nota para cada Range na lista de intervalos.
setNumberFormat(numberFormat)RangeListDefine o número ou o formato de data de cada Range na lista de intervalos.
setShowHyperlink(showHyperlink)RangeListDefine se cada Range na lista de intervalos precisa ou não mostrar hiperlinks.
setTextDirection(direction)RangeListDefine a direção do texto para as células em cada Range na lista de intervalos.
setTextRotation(degrees)RangeListDefine as configurações de rotação do texto para as células em cada Range na lista de intervalos.
setValue(value)RangeListDefine o valor de cada Range na lista de intervalos.
setVerticalAlignment(alignment)RangeListDefina o alinhamento vertical de cada Range na lista de intervalos.
setVerticalText(isVertical)RangeListDefine se o texto das células deve ou não empilhar para cada Range no intervalo lista.
setWrap(isWrapEnabled)RangeListDefina o ajuste de texto para cada Range na lista de intervalos.
setWrapStrategy(strategy)RangeListDefine a estratégia de ajuste de texto para cada Range na lista de intervalos.
trimWhitespace()RangeListCorta o espaço em branco (como espaços, tabulações ou novas linhas) em todas as células da lista de intervalos.
uncheck()RangeListAltera o estado das caixas de seleção no intervalo para "desmarcada".

Documentação detalhada

activate()

Seleciona a lista de instâncias de Range. O último intervalo da lista é definido como active range.

Observação:essa é uma forma de selecionar vários intervalos.

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

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();

Retornar

RangeList: a lista de intervalos ativos para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

breakApart()

Dividir todas as células mescladas horizontalmente ou verticalmente contidas na lista de intervalos em células individuais novamente.

Chamar essa função em uma lista de intervalos equivale a selecionar um conjunto de intervalos e selecionando a opção Formato > Mesclar > Cancelar mesclagem de Planilhas Google.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.breakApart();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

check()

Altera o estado das caixas de seleção no intervalo para "marcada". Ignora as células no intervalo. que não contêm o valor marcado ou desmarcado configurado.

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the ranges D4 and E6 to 'checked'.
var rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.check();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

clear()

Limpa o intervalo de conteúdos, formatos e regras de validação de dados para cada Range em a lista de intervalos.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 o intervalo de conteúdo, formato, regras de validação de dados e comentários, conforme especificado com as opções fornecidas. Por padrão, todos os dados são apagados.

// The code below clears the contents of the following ranges A:A and C:C in the active sheet,
// but preserves the format, data validation rules, and comments.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear({contentsOnly: true});

Parâmetros

NomeTipoDescrição
optionsObjectUm objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

NomeTipoDescrição
commentsOnlyBooleanDefine se apenas os comentários serão apagados.
contentsOnlyBooleanDefine se apenas o conteúdo será apagado.
formatOnlyBooleanDefine se apenas o formato será apagado. observe que limpar também limpa as regras de validação de dados.
validationsOnlyBooleanDefine se apenas as regras de validação de dados serão apagadas.
skipFilteredRowsBooleanDefine se as linhas filtradas devem ser limpas.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

clearContent()

Limpa o conteúdo de cada Range na lista de intervalos, deixando a formatação intacta.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearContent();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

clearDataValidations()

Limpa as regras de validação de dados para cada Range na lista de intervalos.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearDataValidations();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

clearFormat()

Limpa a formatação do texto para cada Range na lista de intervalos.

Isso limpa a formatação do texto para cada intervalo, mas não redefine nenhuma regra de formatação de números.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearFormat();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

clearNote()

Limpa a nota de cada Range na lista de intervalos.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearNote();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getRanges()

Retorna uma lista de uma ou mais instâncias de Range na mesma página.

Retornar

Range[]: a lista de intervalos.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

insertCheckboxes()

Insere caixas de seleção em cada célula do intervalo, configuradas com true para selecionadas e false para desmarcado. Define o valor de todas as células no intervalo como false.

var rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with 'true' for checked
// and 'false' for unchecked. Also, sets the value of each cell in the ranges D4 and E6 to
// 'false'.
rangeList.insertCheckboxes();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

insertCheckboxes(checkedValue)

Insere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para as a string vazia para desmarcar. Define o valor de cada célula no intervalo como a string vazia.

var rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with 'yes' for checked
// and the empty string for unchecked. Also, sets the value of each cell in the ranges D4 and
// E6 to the empty string.
rangeList.insertCheckboxes('yes');

Parâmetros

NomeTipoDescrição
checkedValueObjectO valor marcado para a validação de dados da caixa de seleção.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

insertCheckboxes(checkedValue, uncheckedValue)

Insere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para o campo e não marcados. Define o valor de cada célula do intervalo como o valor personalizado não selecionado.

var rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with 'yes' for checked
// and 'no' for unchecked. Also, sets the value of each cell in the ranges D4 and E6 to 'no'.
rangeList.insertCheckboxes('yes', 'no');

Parâmetros

NomeTipoDescrição
checkedValueObjectO valor marcado para a validação de dados da caixa de seleção.
uncheckedValueObjectO valor não selecionado para a validação de dados da caixa de seleção.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

removeCheckboxes()

Remove todas as caixas de seleção do intervalo. Limpa a validação de dados de cada célula. limpa também seu valor se a célula contiver o valor marcado ou desmarcado.

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

var rangeList1 = SpreadsheetApp.getActive().getRangeList(['A1', 'A3']);
rangeList1.setValue('yes');
// Removes the checkbox data validation in cells A1 and A3 and clears their value.
rangeList1.removeCheckboxes();

var rangeList2 = SpreadsheetApp.getActive().getRangeList(['A5', 'A7']);
rangeList2.setValue('random');
// Removes the checkbox data validation in cells A5 and A7 but does not clear their value.
rangeList2.removeCheckboxes();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setBackground(color)

Define a cor do plano de fundo de cada Range na lista de intervalos. A cor é representada em notação CSS. por exemplo, '#ffffff' ou 'white'.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setBackground('red');

Parâmetros

NomeTipoDescrição
colorStringo código da cor do plano de fundo na notação CSS, como '#ffffff' ou 'white'; um valor null redefine a cor.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setBackgroundRGB(red, green, blue)

Define o plano de fundo com a cor RGB especificada. Esse é um wrapper de conveniência em uma chamada setBackground(color).

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
// Sets the background to red for each range in the range list.
rangeList.setBackgroundRGB(255, 0, 0);

Parâmetros

NomeTipoDescrição
redIntegerO valor vermelho na notação RGB.
greenIntegerO valor verde na notação RGB.
blueIntegerO valor azul na notação RGB.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setBorder(top, left, bottom, right, vertical, horizontal)

Define a propriedade de borda para cada Range na lista de intervalos. Os valores válidos são true (ativada), false (desativada) e null (sem alterações).

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom of the ranges A2:B4 and C1:D4, but leaves the left and
// right unchanged.
rangeList.setBorder(true, null, true, null, false, false);

Parâmetros

NomeTipoDescrição
topBooleantrue para borda, false para nenhuma, null para nenhuma alteração.
leftBooleantrue para borda, false para nenhuma, null para nenhuma alteração.
bottomBooleantrue para borda, false para nenhuma, null para nenhuma alteração.
rightBooleantrue para borda, false para nenhuma, null para nenhuma alteração.
verticalBooleantrue para bordas verticais internas, false para nenhuma, null para nenhuma alteração.
horizontalBooleantrue para bordas horizontais internas, false para nenhuma, null para nenhuma alteração.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setBorder(top, left, bottom, right, vertical, horizontal, color, style)

Define a propriedade de borda com cor e/ou estilo para cada Range na lista de intervalos. Os valores válidos são true (ativado), false (desativado) e null (sem alterações). A cor é representada em notação CSS. por exemplo, '#ffffff' ou 'white'.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom, but leaves the left and right unchanged of the ranges
// A2:B4 and C1:D4. Also sets the color to 'red', and the border to 'DASHED'.
rangeList.setBorder(
    true, null, true, null, false, false, 'red', SpreadsheetApp.BorderStyle.DASHED);

Parâmetros

NomeTipoDescrição
topBooleantrue para borda, false para nenhuma, null para nenhuma alteração.
leftBooleantrue para borda, false para nenhuma, null para nenhuma alteração.
bottomBooleantrue para borda, false para nenhuma, null para nenhuma alteração.
rightBooleantrue para borda, false para nenhuma, null para nenhuma alteração.
verticalBooleantrue para bordas verticais internas, false para nenhuma, null para nenhuma alteração.
horizontalBooleantrue para bordas horizontais internas, false para nenhuma, null para nenhuma alteração.
colorStringA cor da borda em notação CSS, como '#ffffff' ou 'white', null para a cor padrão (preto).
styleBorderStyleO estilo das bordas, null para o estilo padrão (sólido).

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setFontColor(color)

Define a cor da fonte de cada Range na lista de intervalos. A cor é representada em CSS notação gráfica, por exemplo, '#ffffff' ou 'white'.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontColor('red');

Parâmetros

NomeTipoDescrição
colorStringA cor da fonte na notação CSS, como '#ffffff' ou 'white'. por O valor null redefine a cor.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setFontFamily(fontFamily)

Define a família de fontes de cada Range na lista de intervalos. A família de fontes é descrita por um identificador de string, como Arial ou Roboto.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontFamily('Roboto');

Parâmetros

NomeTipoDescrição
fontFamilyStringA família de fontes a ser definida. um valor null redefine a família de fontes.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setFontLine(fontLine)

Define o estilo da linha de fonte para cada Range na lista de intervalos. As opções de estilos de linha são 'underline', 'line-through' ou 'none'.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontLine('line-through');

Parâmetros

NomeTipoDescrição
fontLineStringO estilo da linha da fonte, que pode ser 'underline', 'line-through' ou 'none' um valor null redefine o estilo da linha da fonte.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setFontSize(size)

Define o tamanho da fonte (em pontos) para cada Range na lista de intervalos.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontSize(20);

Parâmetros

NomeTipoDescrição
sizeIntegerUm tamanho de ponto de fonte.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setFontStyle(fontStyle)

Defina o estilo da fonte para cada Range na lista de intervalos. As opções de estilo de fonte são 'italic' ou 'normal'.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontStyle("italic");

Parâmetros

NomeTipoDescrição
fontStyleStringO estilo da fonte, 'italic' ou 'normal'. um(a) null redefine o estilo da fonte.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setFontWeight(fontWeight)

Defina a espessura da fonte de cada Range na lista de intervalos. As opções de espessura da fonte são 'normal' ou 'bold'.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontWeight('bold');

Parâmetros

NomeTipoDescrição
fontWeightStringA espessura da fonte, 'bold' ou 'normal'. um(a) null redefine a espessura da fonte.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setFormula(formula)

Atualiza a fórmula para cada Range na lista de intervalos. A fórmula fornecida deve estar no Notação A1.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A11', 'C11']);
rangeList.setFormula('=SUM(B1:B10)');

Parâmetros

NomeTipoDescrição
formulaStringUma string que representa a fórmula a ser definida.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setFormulaR1C1(formula)

Atualiza a fórmula para cada Range na lista de intervalos. A fórmula fornecida deve estar no Notação R1C1.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A11', 'C11']);
// This sets the formula to be the sum of the 3 rows above B5
rangeList.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

Parâmetros

NomeTipoDescrição
formulaStringUma fórmula de string.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setHorizontalAlignment(alignment)

Defina o alinhamento horizontal para cada Range na lista de intervalos. As opções de alinhamento são 'left', 'center' ou 'right'.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setHorizontalAlignment("center");

Parâmetros

NomeTipoDescrição
alignmentStringO alinhamento ('left', 'center' ou 'normal') por null redefine o alinhamento.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setNote(note)

Define o texto da nota para cada Range na lista de intervalos.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setNote('This is a note');

Parâmetros

NomeTipoDescrição
noteStringO texto da nota a ser definido. um valor null remove a nota.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setNumberFormat(numberFormat)

Define o número ou o formato de data de cada Range na lista de intervalos.

Os padrões de formatação aceitos são descritos no guia de formatação de datas e números da API Sheets.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Always show 3 decimal points for the specified ranges.
rangeList.setNumberFormat('0.000');

Parâmetros

NomeTipoDescrição
numberFormatStringUma string de formato numérico.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

Define se cada Range na lista de intervalos precisa ou não mostrar hiperlinks.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Show hyperlinks for all the ranges.
rangeList.setShowHyperlink(true);

Parâmetros

NomeTipoDescrição
showHyperlinkBooleanSe o hiperlink deve ser exibido ou não.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setTextDirection(direction)

Define a direção do texto para as células em cada Range na lista de intervalos. Se um a direção especificada é null, a direção é inferida e, em seguida, definida.

// Sets right-to-left text direction each range in the range list.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Parâmetros

NomeTipoDescrição
directionTextDirectionA direção do texto desejada. se null, a direção será inferida antes do ambiente.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setTextRotation(degrees)

Define as configurações de rotação do texto para as células em cada Range na lista de intervalos. A de entrada corresponde ao ângulo entre a orientação de texto padrão e o orientação. Uma entrada igual a zero indica que o texto está configurado para a orientação padrão.

Para a direção do texto da esquerda para a direita, os ângulos positivos estão no sentido anti-horário, enquanto que da direita para a esquerda eles estão no sentido horário.

// Sets the cells in the ranges A1:A10 and C1:C10 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextRotation(45);

Parâmetros

NomeTipoDescrição
degreesIntegerO ângulo desejado entre a orientação padrão e a orientação desejada. Para o texto da esquerda para a direita, os ângulos positivos estão no sentido anti-horário.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setValue(value)

Define o valor de cada Range na lista de intervalos. O valor pode ser numérico, de string, booleano ou data. Se começar com "=" ela será interpretada como uma fórmula.

var sheet = SpreadsheetApp.getActiveSheet();
// Set value of 100 to each range in the range list.
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setValue(100);

Parâmetros

NomeTipoDescrição
valueObjectO valor do intervalo.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setVerticalAlignment(alignment)

Defina o alinhamento vertical de cada Range na lista de intervalos. As opções de alinhamento são 'top', 'middle' ou 'bottom'.

// Sets the vertical alignment to middle for the list of ranges.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalAlignment("middle");

Parâmetros

NomeTipoDescrição
alignmentStringO alinhamento ('top', 'middle' ou 'bottom') por null redefine o alinhamento.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setVerticalText(isVertical)

Define se o texto das células deve ou não empilhar para cada Range no intervalo lista. Se o texto estiver empilhado verticalmente, a configuração de rotação do texto de grau será ignorada.

// Sets all cell's in ranges D4 and B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalText(true);

Parâmetros

NomeTipoDescrição
isVerticalBooleanSe o texto deve ou não empilhar.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setWrap(isWrapEnabled)

Defina o ajuste de texto para cada Range na lista de intervalos. Células com ajuste de redimensionamento ativado para exibir todo o conteúdo. As células com ajuste desativado exibem o máximo possível na célula sem redimensionar nem executar várias linhas.

// Enable text wrap for the list of ranges.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrap(true);

Parâmetros

NomeTipoDescrição
isWrapEnabledBooleanDefine se o texto será ajustado ou não.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setWrapStrategy(strategy)

Define a estratégia de ajuste de texto para cada Range na lista de intervalos.

// Sets the list of ranges to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Parâmetros

NomeTipoDescrição
strategyWrapStrategyA estratégia de encapsulamento desejada.

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

trimWhitespace()

Corta o espaço em branco (como espaços, tabulações ou novas linhas) em todas as células da lista de intervalos. Remove todos os espaços em branco do início e do final do texto de cada célula e reduz qualquer subsequência de caracteres de espaço em branco restantes para um único espaço.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)']);

var rangeList = sheet.getRangeList(['A1', 'A2', 'A3', 'A4']);
rangeList.trimWhitespace();

var values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

Consulte também


uncheck()

Altera o estado das caixas de seleção no intervalo para "desmarcada". Ignora as células no intervalo. que não contêm o valor marcado ou desmarcado configurado.

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the ranges D4 and E6 to 'unchecked'.
var rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.uncheck();

Retornar

RangeList: esta lista de intervalos, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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