Class Banding

Bandas

Acessar e modificar as faixas, que são os padrões de cores aplicados a linhas ou colunas de um intervalo. Cada faixa consiste em um intervalo e um conjunto de cores para linhas, colunas, cabeçalhos e rodapés.

Métodos

Método	Tipo de retorno	Breve descrição
copyTo(range)	Banding	Copia essa faixa para outro intervalo.
getFirstColumnColorObject()	Color|null	Retorna a primeira cor de coluna alternada no efeito de faixa ou null se nenhuma cor estiver definida.
getFirstRowColorObject()	Color|null	Retorna a primeira cor de linha alternada ou null se nenhuma cor estiver definida.
getFooterColumnColorObject()	Color|null	Retorna a cor da última coluna no efeito zebrado ou null se nenhuma cor estiver definida.
getFooterRowColorObject()	Color|null	Retorna a cor da última linha no efeito de faixa ou null se nenhuma cor estiver definida.
getHeaderColumnColorObject()	Color|null	Retorna a cor da primeira coluna no efeito de faixa ou null se nenhuma cor estiver definida.
getHeaderRowColorObject()	Color|null	Retorna a cor da linha de cabeçalho ou null se nenhuma cor estiver definida.
getRange()	Range	Retorna o intervalo para essa agrupamento.
getSecondColumnColorObject()	Color|null	Retorna a segunda cor da coluna alternada no efeito de faixa ou null se nenhuma cor estiver definida.
getSecondRowColorObject()	Color|null	Retorna a segunda cor de linha alternada ou null se nenhuma cor estiver definida.
remove()	void	Remove esse efeito.
setFirstColumnColor(color)	Banding	Define a cor da primeira coluna que está alternando.
setFirstColumnColorObject(color)	Banding	Define a primeira cor de coluna alternada no encadeamento.
setFirstRowColor(color)	Banding	Define a primeira cor de linha que está alternando.
setFirstRowColorObject(color)	Banding	Define a primeira cor de linha alternada na faixa.
setFooterColumnColor(color)	Banding	Define a cor da última coluna.
setFooterColumnColorObject(color)	Banding	Define a cor da última coluna do agrupamento.
setFooterRowColor(color)	Banding	Define a cor da última linha.
setFooterRowColorObject(color)	Banding	Define a cor da linha de rodapé na faixa.
setHeaderColumnColor(color)	Banding	Define a cor da coluna de cabeçalho.
setHeaderColumnColorObject(color)	Banding	Define a cor da coluna de cabeçalho.
setHeaderRowColor(color)	Banding	Define a cor da linha de cabeçalho.
setHeaderRowColorObject(color)	Banding	Define a cor da linha de cabeçalho.
setRange(range)	Banding	Define o intervalo para essa agrupamento.
setSecondColumnColor(color)	Banding	Define a cor da segunda coluna que está alternando.
setSecondColumnColorObject(color)	Banding	Define a segunda cor de coluna alternada na faixa.
setSecondRowColor(color)	Banding	Define a cor da segunda linha que está alternando.
setSecondRowColorObject(color)	Banding	Define a segunda cor alternada na faixa.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
getFirstColumnColor()	String|null	Retorna a primeira cor de coluna alternada ou null se nenhuma cor estiver definida.
getFirstRowColor()	String|null	Retorna a primeira cor de linha alternada ou null se nenhuma cor estiver definida.
getFooterColumnColor()	String|null	Retorna a cor da última coluna ou null se nenhuma cor estiver definida.
getFooterRowColor()	String|null	Retorna a cor da última linha ou null se nenhuma cor estiver definida.
getHeaderColumnColor()	String|null	Retorna a cor da coluna de cabeçalho ou null se nenhuma cor estiver definida.
getHeaderRowColor()	String|null	Retorna a cor da linha de cabeçalho ou null se nenhuma cor estiver definida.
getSecondColumnColor()	String|null	Retorna a segunda cor alternada da coluna ou null se nenhuma cor estiver definida.
getSecondRowColor()	String|null	Retorna a cor da segunda linha que está alternando ou null se nenhuma cor estiver definida.

Documentação detalhada

copyTo(range)

Copia essa faixa para outro intervalo.

Parâmetros

Nome	Tipo	Descrição
range	Range	O intervalo para onde copiar a faixa.

Retornar

Banding: o novo agrupamento.

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

---

getFirstColumnColorObject()

Retorna a primeira cor de coluna alternada no efeito de faixa ou null se nenhuma cor estiver definida.

Retornar

Color|null: a primeira cor de coluna alternada no agrupamento ou null se nenhuma cor estiver 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

---

getFirstRowColorObject()

Retorna a primeira cor de linha alternada ou null se nenhuma cor estiver definida.

Retornar

Color|null: a primeira cor de linha alternada no agrupamento ou null se nenhuma cor estiver 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

---

getFooterColumnColorObject()

Retorna a cor da última coluna no efeito zebrado ou null se nenhuma cor estiver definida.

Retornar

Color|null: a cor da última coluna no efeito de faixa ou null se nenhuma cor estiver 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

---

getFooterRowColorObject()

Retorna a cor da última linha no efeito de faixa ou null se nenhuma cor estiver definida.

Retornar

Color|null: a cor da linha de rodapé no efeito zebrado ou null se nenhuma cor estiver 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

---

getHeaderColumnColorObject()

Retorna a cor da primeira coluna no efeito de faixa ou null se nenhuma cor estiver definida.

Retornar

Color|null: a cor da primeira coluna no efeito zebrado ou null se nenhuma cor estiver 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

---

getHeaderRowColorObject()

Retorna a cor da linha de cabeçalho ou null se nenhuma cor estiver definida.

Retornar

Color|null: a cor da linha de cabeçalho. Retorna null se nenhuma cor estiver 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

---

getRange()

Retorna o intervalo para essa agrupamento.

Retornar

Range: o intervalo dessa faixa.

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

---

getSecondColumnColorObject()

Retorna a segunda cor da coluna alternada no efeito de faixa ou null se nenhuma cor estiver definida.

Retornar

Color|null: a segunda cor de coluna alternada no agrupamento ou null se nenhuma cor estiver 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

---

getSecondRowColorObject()

Retorna a segunda cor de linha alternada ou null se nenhuma cor estiver definida.

Retornar

Color|null: a segunda cor de linha alternada no agrupamento ou null se nenhuma cor estiver 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

---

remove()

Remove esse efeito.

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

---

setFirstColumnColor(color)

Define a cor da primeira coluna que está alternando.

Parâmetros

Nome	Tipo	Descrição
color	String	O código de cor na notação CSS (como '#ffffff' ou 'white') ou null para limpar a cor.

Retornar

Banding: essa banda, 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

---

setFirstColumnColorObject(color)

Define a primeira cor de coluna alternada no encadeamento.

Parâmetros

Nome	Tipo	Descrição
color	Color	A nova primeira cor alternada da coluna no agrupamento. Definir como null limpa a cor.

Retornar

Banding: essa banda, 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

---

setFirstRowColor(color)

Define a primeira cor de linha que está alternando.

Parâmetros

Nome	Tipo	Descrição
color	String	O código de cor na notação CSS (como '#ffffff' ou 'white') ou null para limpar a cor.

Retornar

Banding: essa banda, 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

---

setFirstRowColorObject(color)

Define a primeira cor de linha alternada na faixa.

Parâmetros

Nome	Tipo	Descrição
color	Color	A nova primeira cor alternada no agrupamento. Definir como null limpa a cor.

Retornar

Banding: essa banda, 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

---

setFooterColumnColor(color)

Define a cor da última coluna.

Parâmetros

Nome	Tipo	Descrição
color	String	O código de cor na notação CSS (como '#ffffff' ou 'white') ou null para limpar a cor.

Retornar

Banding: essa banda, 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

---

setFooterColumnColorObject(color)

Define a cor da última coluna do agrupamento.

Parâmetros

Nome	Tipo	Descrição
color	Color	A nova cor da última coluna no agrupamento. Definir como null limpa a cor.

Retornar

Banding: essa banda, 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

---

setFooterRowColor(color)

Define a cor da última linha.

Parâmetros

Nome	Tipo	Descrição
color	String	O código de cor na notação CSS (como '#ffffff' ou 'white') ou null para limpar a cor.

Retornar

Banding: essa banda, 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

---

setFooterRowColorObject(color)

Define a cor da linha de rodapé na faixa.

Parâmetros

Nome	Tipo	Descrição
color	Color	A nova cor da linha de rodapé. Definir como null limpa a cor.

Retornar

Banding: essa banda, 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

---

setHeaderColumnColor(color)

Define a cor da coluna de cabeçalho.

Parâmetros

Nome	Tipo	Descrição
color	String	O código de cor na notação CSS (como '#ffffff' ou 'white') ou null para limpar a cor.

Retornar

Banding: essa banda, 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

---

setHeaderColumnColorObject(color)

Define a cor da coluna de cabeçalho.

Parâmetros

Nome	Tipo	Descrição
color	Color	A nova cor da coluna de cabeçalho. Definir como null limpa a cor.

Retornar

Banding: essa banda, 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

---

setHeaderRowColor(color)

Define a cor da linha de cabeçalho.

Parâmetros

Nome	Tipo	Descrição
color	String	O código de cor na notação CSS (como '#ffffff' ou 'white') ou null para limpar a cor.

Retornar

Banding: essa banda, 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

---

setHeaderRowColorObject(color)

Define a cor da linha de cabeçalho.

Parâmetros

Nome	Tipo	Descrição
color	Color	A nova cor da linha de cabeçalho. Definir como null limpa a cor.

Retornar

Banding: essa banda, 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

---

setRange(range)

Define o intervalo para essa agrupamento.

Parâmetros

Nome	Tipo	Descrição
range	Range	O novo intervalo para essa classe.

Retornar

Banding: essa banda, 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

---

setSecondColumnColor(color)

Define a cor da segunda coluna que está alternando.

Parâmetros

Nome	Tipo	Descrição
color	String	O código de cor na notação CSS (como '#ffffff' ou 'white') ou null para limpar a cor.

Retornar

Banding: essa banda, 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

---

setSecondColumnColorObject(color)

Define a segunda cor de coluna alternada na faixa.

Parâmetros

Nome	Tipo	Descrição
color	Color	A nova segunda cor alternada da coluna na faixa. Definir como null limpa a cor.

Retornar

Banding: essa banda, 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

---

setSecondRowColor(color)

Define a cor da segunda linha que está alternando.

Parâmetros

Nome	Tipo	Descrição
color	String	O código de cor na notação CSS (como '#ffffff' ou 'white') ou null para limpar a cor.

Retornar

Banding: essa banda, 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

---

setSecondRowColorObject(color)

Define a segunda cor alternada na faixa.

Parâmetros

Nome	Tipo	Descrição
color	Color	A nova segunda cor alternada na faixa. Definir como null limpa a cor.

Retornar

Banding: essa banda, 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

Métodos obsoletos

getFirstColumnColor()

Obsoleto. Substituído por getFirstColumnColorObject()

Retorna a primeira cor de coluna alternada ou null se nenhuma cor estiver definida.

Retornar

String|null: o código de cor na notação CSS (como '#ffffff' ou 'white') ou null se nenhuma cor for 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

---

getFirstRowColor()

Obsoleto. Substituído por getFirstRowColorObject()

Retorna a primeira cor de linha alternada ou null se nenhuma cor estiver definida.

Retornar

String|null: o código de cor na notação CSS (como '#ffffff' ou 'white') ou null se nenhuma cor for 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

---

getFooterColumnColor()

Obsoleto. Substituído por getFooterColumnColorObject()

Retorna a cor da última coluna ou null se nenhuma cor estiver definida.

Retornar

String|null: o código de cor na notação CSS (como '#ffffff' ou 'white') ou null se nenhuma cor for 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

---

getFooterRowColor()

Obsoleto. Substituído por getFooterRowColorObject()

Retorna a cor da última linha ou null se nenhuma cor estiver definida.

Retornar

String|null: o código de cor na notação CSS (como '#ffffff' ou 'white') ou null se nenhuma cor for 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

---

getHeaderColumnColor()

Obsoleto. Substituído por getHeaderColumnColorObject()

Retorna a cor da coluna de cabeçalho ou null se nenhuma cor estiver definida.

Retornar

String|null: o código de cor na notação CSS (como '#ffffff' ou 'white') ou null se nenhuma cor for 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

---

getHeaderRowColor()

Obsoleto. Substituído por getHeaderRowColorObject()

Retorna a cor da linha de cabeçalho ou null se nenhuma cor estiver definida.

Retornar

String|null: o código de cor na notação CSS (como '#ffffff' ou 'white') ou null se nenhuma cor for 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

---

getSecondColumnColor()

Obsoleto. Substituído por getSecondColumnColorObject()

Retorna a segunda cor alternada da coluna ou null se nenhuma cor estiver definida.

Retornar

String|null: a cor HEX ou null se nenhuma cor estiver 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

---

getSecondRowColor()

Obsoleto. Substituído por getSecondRowColorObject()

Retorna a cor da segunda linha que está alternando ou null se nenhuma cor estiver definida.

Retornar

String|null: o código de cor na notação CSS (como '#ffffff' ou 'white') ou null se nenhuma cor for 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