Uma coleção de uma ou mais instâncias de Range
na mesma página. Use essa classe
para aplicar operações em coleções de intervalos ou células não adjacentes.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
activate() | RangeList | Seleciona a lista de instâncias de Range . |
breakApart() | RangeList | Divida todas as células mescladas na horizontal ou vertical contidas na lista de intervalos em células individuais novamente. |
check() | RangeList | Altera o estado das caixas de seleção no intervalo para "marcada". |
clear() | RangeList | Limpa o intervalo de conteúdos, formatos e regras de validação de dados para cada Range na
lista de intervalos. |
clear(options) | RangeList | Limpa o intervalo de conteúdo, formato, regras de validação de dados e comentários, conforme especificado com as opções fornecidas. |
clearContent() | RangeList | Limpa o conteúdo de cada Range na lista de intervalos, deixando a formatação intacta. |
clearDataValidations() | RangeList | Limpa as regras de validação de dados para cada Range na lista de intervalos. |
clearFormat() | RangeList | Limpa a formatação do texto para cada Range na lista de intervalos. |
clearNote() | RangeList | Limpa a nota para cada Range na lista de intervalos. |
getRanges() | Range[] | Retorna uma lista de uma ou mais instâncias de Range na mesma página. |
insertCheckboxes() | RangeList | Insere caixas de seleção em cada célula do intervalo, configuradas com true para marcada e
false para desmarcada. |
insertCheckboxes(checkedValue) | RangeList | Insere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcada. |
insertCheckboxes(checkedValue, uncheckedValue) | RangeList | Insere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcado e desmarcado. |
removeCheckboxes() | RangeList | Remove todas as caixas de seleção do intervalo. |
setBackground(color) | RangeList | Define a cor do plano de fundo para cada Range na lista de intervalos. |
setBackgroundRGB(red, green, blue) | RangeList | Define o plano de fundo para a cor RGB especificada. |
setBorder(top, left, bottom, right, vertical, horizontal) | RangeList | Define a propriedade de borda para cada Range na lista de intervalos. |
setBorder(top, left, bottom, right, vertical, horizontal, color, style) | RangeList | Define a propriedade da borda com cor e/ou estilo para cada Range na lista de intervalos. |
setFontColor(color) | RangeList | Define a cor da fonte de cada Range na lista de intervalos. |
setFontFamily(fontFamily) | RangeList | Define a família de fontes de cada Range na lista de intervalos. |
setFontLine(fontLine) | RangeList | Define o estilo da linha da fonte de cada Range na lista de intervalos. |
setFontSize(size) | RangeList | Define o tamanho da fonte (em pontos) para cada Range na lista de intervalos. |
setFontStyle(fontStyle) | RangeList | Defina o estilo da fonte de cada Range na lista de intervalos. |
setFontWeight(fontWeight) | RangeList | Defina a espessura da fonte para cada Range na lista de intervalos. |
setFormula(formula) | RangeList | Atualiza a fórmula para cada Range na lista de intervalos. |
setFormulaR1C1(formula) | RangeList | Atualiza a fórmula para cada Range na lista de intervalos. |
setHorizontalAlignment(alignment) | RangeList | Defina o alinhamento horizontal de cada Range na lista de intervalos. |
setNote(note) | RangeList | Define o texto da nota para cada Range na lista de intervalos. |
setNumberFormat(numberFormat) | RangeList | Define o formato de número ou data de cada Range na lista de intervalos. |
setShowHyperlink(showHyperlink) | RangeList | Define se cada Range na lista de intervalos deve mostrar hiperlinks ou não. |
setTextDirection(direction) | RangeList | Define a direção do texto para as células em cada Range na lista de intervalos. |
setTextRotation(degrees) | RangeList | Define as configurações de rotação do texto para as células em cada Range na lista de intervalos. |
setValue(value) | RangeList | Define o valor de cada Range na lista de intervalos. |
setVerticalAlignment(alignment) | RangeList | Defina o alinhamento vertical de cada Range na lista de intervalos. |
setVerticalText(isVertical) | RangeList | Define se o texto das células será empilhado para cada Range na lista
de intervalos. |
setWrap(isWrapEnabled) | RangeList | Defina o ajuste de texto para cada Range na lista de intervalos. |
setWrapStrategy(strategy) | RangeList | Define a estratégia de ajuste de texto para cada Range na lista de intervalos. |
trimWhitespace() | RangeList | Corta o espaço em branco (como espaços, tabulações ou novas linhas) em todas as células na lista de intervalos. |
uncheck() | RangeList | Altera 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 na lista é definido como o active range
.
Observação:essa é uma maneira 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();
Retorno
RangeList
: a lista de intervalos ativos 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
breakApart()
Divida todas as células mescladas na horizontal ou vertical contidas na lista de intervalos em células individuais novamente.
Chamar essa função em uma lista de intervalos é equivalente a selecionar um conjunto de intervalos e selecionar o item de menu Formatar > Mesclar > Cancelar mesclagem das Planilhas.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['A:A', 'C:C']); rangeList.breakApart();
Retorno
RangeList
: lista de intervalos 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
check()
Muda o estado das caixas de seleção no intervalo para "marcada". Ignora as células no intervalo que atualmente 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();
Retorno
RangeList
: lista de intervalos 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 o intervalo de conteúdos, formatos e 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.clear();
Retorno
RangeList
: lista de intervalos 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(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
Nome | Tipo | Descrição |
---|---|---|
options | Object | Um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo. |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
commentsOnly | Boolean | Define se somente os comentários devem ser apagados. |
contentsOnly | Boolean | Define se apenas o conteúdo deve ser apagado. |
formatOnly | Boolean | Define se apenas o formato será limpo. Observe que limpar o formato também limpa as regras de validação de dados. |
validationsOnly | Boolean | Define se apenas as regras de validação de dados devem ser apagadas. |
skipFilteredRows | Boolean | Define se as linhas filtradas devem ser evitadas. |
Retorno
RangeList
: lista de intervalos 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
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();
Retorno
RangeList
: lista de intervalos 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
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();
Retorno
RangeList
: lista de intervalos 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
clearFormat()
Limpa a formatação do texto para cada Range
na lista de intervalos.
Isso limpa a formatação de texto de cada intervalo, mas não redefine as regras de formatação de números.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['A:A', 'C:C']); rangeList.clearFormat();
Retorno
RangeList
: lista de intervalos 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
clearNote()
Limpa a nota para cada Range
na lista de intervalos.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['A:A', 'C:C']); rangeList.clearNote();
Retorno
RangeList
: lista de intervalos 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
getRanges()
Retorna uma lista de uma ou mais instâncias de Range
na mesma página.
Retorno
Range[]
: a lista de intervalos.
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
insertCheckboxes()
Insere caixas de seleção em cada célula do intervalo, configuradas com true
para marcada e
false
para desmarcada. 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();
Retorno
RangeList
: lista de intervalos 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
insertCheckboxes(checkedValue)
Insere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcada. 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
Nome | Tipo | Descrição |
---|---|---|
checkedValue | Object | O valor marcado para a validação de dados da caixa de seleção. |
Retorno
RangeList
: lista de intervalos 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
insertCheckboxes(checkedValue, uncheckedValue)
Insere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcado e desmarcado. Define o valor de cada célula no 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
Nome | Tipo | Descrição |
---|---|---|
checkedValue | Object | O valor marcado para a validação de dados da caixa de seleção. |
uncheckedValue | Object | O valor não marcado para a validação de dados da caixa de seleção. |
Retorno
RangeList
: lista de intervalos 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
removeCheckboxes()
Remove todas as caixas de seleção do intervalo. Limpa a validação de dados de cada célula e também limpa o valor dela 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();
Retorno
RangeList
: lista de intervalos 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
setBackground(color)
Define a cor do plano de fundo para cada Range
na lista de intervalos. A cor é representada na
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
Nome | Tipo | Descrição |
---|---|---|
color | String | O código de cor de segundo plano em notação CSS, como '#ffffff' ou 'white' . Um valor null redefine a cor. |
Retorno
RangeList
: lista de intervalos 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
setBackgroundRGB(red, green, blue)
Define o plano de fundo para 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
Nome | Tipo | Descrição |
---|---|---|
red | Integer | O valor vermelho na notação RGB. |
green | Integer | O valor verde na notação RGB. |
blue | Integer | O valor azul na notação RGB. |
Retorno
RangeList
: lista de intervalos 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
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
(ativado), false
(desativado) 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
Nome | Tipo | Descrição |
---|---|---|
top | Boolean | true para borda, false para nenhuma e null para nenhuma alteração. |
left | Boolean | true para borda, false para nenhuma e null para nenhuma alteração. |
bottom | Boolean | true para borda, false para nenhuma e null para nenhuma alteração. |
right | Boolean | true para borda, false para nenhuma e null para nenhuma alteração. |
vertical | Boolean | true para bordas verticais internas, false para nenhuma e null para nenhuma mudança. |
horizontal | Boolean | true para bordas horizontais internas, false para nenhuma e null para nenhuma mudança. |
Retorno
RangeList
: lista de intervalos 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
setBorder(top, left, bottom, right, vertical, horizontal, color, style)
Define a propriedade da 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 na 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
Nome | Tipo | Descrição |
---|---|---|
top | Boolean | true para borda, false para nenhuma e null para nenhuma alteração. |
left | Boolean | true para borda, false para nenhuma e null para nenhuma alteração. |
bottom | Boolean | true para borda, false para nenhuma e null para nenhuma alteração. |
right | Boolean | true para borda, false para nenhuma e null para nenhuma alteração. |
vertical | Boolean | true para bordas verticais internas, false para nenhuma e null para nenhuma mudança. |
horizontal | Boolean | true para bordas horizontais internas, false para nenhuma e null para nenhuma mudança. |
color | String | A cor da borda na notação CSS, como '#ffffff' ou 'white' , ou null para cor padrão (preto). |
style | BorderStyle | O estilo das bordas, null para o estilo padrão (sólido). |
Retorno
RangeList
: lista de intervalos 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
setFontColor(color)
Define a cor da fonte de cada Range
na lista de intervalos. A cor é representada na notação CSS, por exemplo, '#ffffff'
ou 'white'
.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['A:A', 'C:C']); rangeList.setFontColor('red');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | String | A cor da fonte na notação CSS, por exemplo, '#ffffff' ou 'white' . Um valor null redefine a cor. |
Retorno
RangeList
: lista de intervalos 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
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
Nome | Tipo | Descrição |
---|---|---|
fontFamily | String | A família de fontes a ser definida. Um valor null redefine a família de fontes. |
Retorno
RangeList
: lista de intervalos 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
setFontLine(fontLine)
Define o estilo da linha da fonte de cada Range
na lista de intervalos. As opções de estilo 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
Nome | Tipo | Descrição |
---|---|---|
fontLine | String | O estilo de linha da fonte, 'underline' , 'line-through' ou
'none' . Um valor null redefine o estilo da linha da fonte. |
Retorno
RangeList
: lista de intervalos 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
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
Nome | Tipo | Descrição |
---|---|---|
size | Integer | Um tamanho de ponto de fonte. |
Retorno
RangeList
: lista de intervalos 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
setFontStyle(fontStyle)
Defina o estilo da fonte de 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
Nome | Tipo | Descrição |
---|---|---|
fontStyle | String | O estilo da fonte, 'italic' ou 'normal' , um valor null
redefine o estilo da fonte. |
Retorno
RangeList
: lista de intervalos 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
setFontWeight(fontWeight)
Defina a espessura da fonte para 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
Nome | Tipo | Descrição |
---|---|---|
fontWeight | String | A espessura da fonte, 'bold' ou 'normal' . Um valor null
redefine o peso da fonte. |
Retorno
RangeList
: lista de intervalos 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
setFormula(formula)
Atualiza a fórmula para cada Range
na lista de intervalos. A fórmula fornecida precisa estar na notação A1.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['A11', 'C11']); rangeList.setFormula('=SUM(B1:B10)');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
formula | String | String que representa a fórmula a ser definida. |
Retorno
RangeList
: lista de intervalos 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
setFormulaR1C1(formula)
Atualiza a fórmula para cada Range
na lista de intervalos. A fórmula fornecida precisa estar na 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
Nome | Tipo | Descrição |
---|---|---|
formula | String | Uma fórmula de string. |
Retorno
RangeList
: lista de intervalos 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
setHorizontalAlignment(alignment)
Defina o alinhamento horizontal de 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
Nome | Tipo | Descrição |
---|---|---|
alignment | String | O alinhamento, que é 'left' , 'center' ou 'normal' . Um valor null redefine o alinhamento. |
Retorno
RangeList
: lista de intervalos 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
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
Nome | Tipo | Descrição |
---|---|---|
note | String | O texto da nota a ser definida. Um valor null a remove. |
Retorno
RangeList
: lista de intervalos 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
setNumberFormat(numberFormat)
Define o formato de número ou data de cada Range
na lista de intervalos.
Os padrões de formatação aceitos são descritos no guia de formatação de data e número 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
Nome | Tipo | Descrição |
---|---|---|
numberFormat | String | Uma string de formato numérico. |
Retorno
RangeList
: lista de intervalos 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
setShowHyperlink(showHyperlink)
Define se cada Range
na lista de intervalos deve mostrar hiperlinks ou não.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']); // Show hyperlinks for all the ranges. rangeList.setShowHyperlink(true);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
showHyperlink | Boolean | Se o hiperlink deve ou não ser exibido. |
Retorno
RangeList
: lista de intervalos 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
setTextDirection(direction)
Define a direção do texto para as células em cada Range
na lista de intervalos. Se uma direção especificada for null
, ela será inferida e 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
Nome | Tipo | Descrição |
---|---|---|
direction | TextDirection | A direção do texto desejada. Se for null , a direção será inferida antes da configuração. |
Retorno
RangeList
: lista de intervalos 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
setTextRotation(degrees)
Define as configurações de rotação do texto para as células em cada Range
na lista de intervalos. A
entrada corresponde ao ângulo entre a orientação padrão do texto e a orientação
pretendida. Uma entrada de zero indica que o texto está definido para a orientação padrão.
Na direção do texto da esquerda para a direita, os ângulos positivos estão no sentido anti-horário, enquanto 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
Nome | Tipo | Descrição |
---|---|---|
degrees | Integer | O ângulo desejado entre a orientação padrão e a orientação desejada. No texto da esquerda para a direita, os ângulos positivos estão no sentido anti-horário. |
Retorno
RangeList
: lista de intervalos 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
setValue(value)
Define o valor de cada Range
na lista de intervalos. O valor pode ser numérico, de string,
booleano ou de data. Se começar com '=', será interpretado 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
Nome | Tipo | Descrição |
---|---|---|
value | Object | Valor do intervalo. |
Retorno
RangeList
: lista de intervalos 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
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
Nome | Tipo | Descrição |
---|---|---|
alignment | String | O alinhamento, que é 'top' , 'middle' ou 'bottom' . Um valor null redefine o alinhamento. |
Retorno
RangeList
: lista de intervalos 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
setVerticalText(isVertical)
Define se o texto das células será empilhado para cada Range
na lista
de intervalos. Se o texto estiver empilhado verticalmente, a configuração de rotação do texto com o 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
Nome | Tipo | Descrição |
---|---|---|
isVertical | Boolean | Se o texto será empilhado ou não. |
Retorno
RangeList
: lista de intervalos 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
setWrap(isWrapEnabled)
Defina o ajuste de texto para cada Range
na lista de intervalos. As células com ajuste ativado são redimensionadas
para exibir o conteúdo completo. As células com wrapper desativado são exibidas o máximo possível na célula
sem serem redimensionadas ou serem executadas em 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
Nome | Tipo | Descrição |
---|---|---|
isWrapEnabled | Boolean | Se o texto deve ser ajustado ou não. |
Retorno
RangeList
: lista de intervalos 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
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
Nome | Tipo | Descrição |
---|---|---|
strategy | WrapStrategy | A estratégia de encapsulamento desejada. |
Retorno
RangeList
: lista de intervalos 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
trimWhitespace()
Corta o espaço em branco (como espaços, tabulações ou novas linhas) em todas as células na 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 a 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)']
Retorno
RangeList
: lista de intervalos 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
Veja também
uncheck()
Muda o estado das caixas de seleção no intervalo para "desmarcada". Ignora as células no intervalo que atualmente 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();
Retorno
RangeList
: lista de intervalos 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