Access and modify bandings, the color patterns applied to rows or columns of a range. Each banding consists of a range and a set of colors for rows, columns, headers, and footers.
Methods
Method | Return type | Brief description |
---|---|---|
copyTo(range) | Banding | Copies this banding to another range. |
getFirstColumnColorObject() | Color | Returns the first alternating column color in the banding, or null if no color is set. |
getFirstRowColorObject() | Color | Returns the first alternating row color, or null if no color is set. |
getFooterColumnColorObject() | Color | Returns the color of the last column in the banding, or null if no color is set. |
getFooterRowColorObject() | Color | Returns the last row color in the banding, or null if no color is set. |
getHeaderColumnColorObject() | Color | Returns the color of the first column in the banding, or null if no color is set. |
getHeaderRowColorObject() | Color | Returns the color of the header row or null if no color is set. |
getRange() | Range | Returns the range for this banding. |
getSecondColumnColorObject() | Color | Returns the second alternating column color in the banding, or null if no color is set. |
getSecondRowColorObject() | Color | Returns the second alternating row color, or null if no color is set. |
remove() | void | Removes this banding. |
setFirstColumnColor(color) | Banding | Sets the first column color that is alternating. |
setFirstColumnColorObject(color) | Banding | Sets the first alternating column color in the banding. |
setFirstRowColor(color) | Banding | Sets the first row color that is alternating. |
setFirstRowColorObject(color) | Banding | Sets the first alternating row color in the banding. |
setFooterColumnColor(color) | Banding | Sets the color of the last column. |
setFooterColumnColorObject(color) | Banding | Sets the color of the last column in the banding. |
setFooterRowColor(color) | Banding | Sets the color of the last row. |
setFooterRowColorObject(color) | Banding | Sets the color of the footer row in the banding. |
setHeaderColumnColor(color) | Banding | Sets the color of the header column. |
setHeaderColumnColorObject(color) | Banding | Sets the color of the header column. |
setHeaderRowColor(color) | Banding | Sets the color of the header row. |
setHeaderRowColorObject(color) | Banding | Sets the color of the header row. |
setRange(range) | Banding | Sets the range for this banding. |
setSecondColumnColor(color) | Banding | Sets the second column color that is alternating. |
setSecondColumnColorObject(color) | Banding | Sets the second alternating column color in the banding. |
setSecondRowColor(color) | Banding | Sets the second row color that is alternating. |
setSecondRowColorObject(color) | Banding | Sets the second alternating color in the banding. |
Detailed documentation
copyTo(range)
Copies this banding to another range.
Parameters
Name | Type | Description |
---|---|---|
range | Range | The range to copy this banding to. |
Return
Banding
— The new banding.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFirstColumnColorObject()
Returns the first alternating column color in the banding, or null
if no color is set.
Return
Color
— The first alternating column color in the banding, or null
if no color is set.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFirstRowColorObject()
Returns the first alternating row color, or null
if no color is set.
Return
Color
— The first alternating row color in the banding, or null
if no color is set.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getHeaderColumnColorObject()
Returns the color of the first column in the banding, or null
if no color is set.
Return
Color
— The first column color in the banding, or null
if no color is set.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getHeaderRowColorObject()
Returns the color of the header row or null
if no color is set.
Return
Color
— The color of the header row; returns null
if no color is set.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange()
Returns the range for this banding.
Return
Range
— The range for this banding.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSecondColumnColorObject()
Returns the second alternating column color in the banding, or null
if no color is set.
Return
Color
— The second alternating column color in the banding, or null
if no color is set.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSecondRowColorObject()
Returns the second alternating row color, or null
if no color is set.
Return
Color
— The second alternating row color in the banding, or null
if no color is set.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
remove()
Removes this banding.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFirstColumnColor(color)
Sets the first column color that is alternating.
Parameters
Name | Type | Description |
---|---|---|
color | String | The color code in CSS notation (such as '#ffffff' or 'white' ), or
null to clear the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFirstColumnColorObject(color)
Sets the first alternating column color in the banding.
Parameters
Name | Type | Description |
---|---|---|
color | Color | The new first alternating column color in the banding; setting to null
clears the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFirstRowColor(color)
Sets the first row color that is alternating.
Parameters
Name | Type | Description |
---|---|---|
color | String | The color code in CSS notation (such as '#ffffff' or 'white' ), or
null to clear the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFirstRowColorObject(color)
Sets the first alternating row color in the banding.
Parameters
Name | Type | Description |
---|---|---|
color | Color | The new first alternating color in the banding; setting to null clears the
color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setHeaderColumnColor(color)
Sets the color of the header column.
Parameters
Name | Type | Description |
---|---|---|
color | String | The color code in CSS notation (such as '#ffffff' or 'white' ), or
null to clear the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setHeaderColumnColorObject(color)
Sets the color of the header column.
Parameters
Name | Type | Description |
---|---|---|
color | Color | The new header column color; setting to null clears the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setHeaderRowColor(color)
Sets the color of the header row.
Parameters
Name | Type | Description |
---|---|---|
color | String | The color code in CSS notation (such as '#ffffff' or 'white' ), or
null to clear the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setHeaderRowColorObject(color)
Sets the color of the header row.
Parameters
Name | Type | Description |
---|---|---|
color | Color | The new header row color; setting to null clears the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRange(range)
Sets the range for this banding.
Parameters
Name | Type | Description |
---|---|---|
range | Range | The new range for this banding. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSecondColumnColor(color)
Sets the second column color that is alternating.
Parameters
Name | Type | Description |
---|---|---|
color | String | The color code in CSS notation (such as '#ffffff' or 'white' ), or
null to clear the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSecondColumnColorObject(color)
Sets the second alternating column color in the banding.
Parameters
Name | Type | Description |
---|---|---|
color | Color | The new second alternating column color in the banding; setting to null
clears the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSecondRowColor(color)
Sets the second row color that is alternating.
Parameters
Name | Type | Description |
---|---|---|
color | String | The color code in CSS notation (such as '#ffffff' or 'white' ), or
null to clear the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSecondRowColorObject(color)
Sets the second alternating color in the banding.
Parameters
Name | Type | Description |
---|---|---|
color | Color | The new second alternating color in the banding; setting to null clears
the color. |
Return
Banding
— This banding, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets