Class ColorBuilder

AI-generated Key Takeaways

• ColorBuilder facilitates the creation and customization of color objects within Google Sheets using Apps Script.

• Methods such as setRgbColor() and setThemeColor() are used to define the color, while build() generates the final Color object.

• asRgbColor() and asThemeColor() methods enable the conversion of the color to specific color types.

• getColorType() reveals the color's current type (RGB or Theme).

• Several of these methods necessitate authorization with relevant scopes for access to spreadsheet data.

ColorBuilder

The builder for ColorBuilder. To create a new builder, use SpreadsheetApp.newColor().

Methods

Method	Return type	Brief description
asRgbColor()	RgbColor	Converts this color to an RgbColor.
asThemeColor()	ThemeColor	Converts this color to a ThemeColor.
build()	Color	Creates a color object from the settings supplied to the builder.
getColorType()	ColorType	Get the type of this color.
setRgbColor(cssString)	ColorBuilder	Sets as RGB color.
setThemeColor(themeColorType)	ColorBuilder	Sets as theme color.

Detailed documentation

asRgbColor()

Converts this color to an RgbColor.

Return

RgbColor — The RGB color.

Throws

Error — if the color is not an RgbColor

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

---

asThemeColor()

Converts this color to a ThemeColor.

Return

ThemeColor — The theme color.

Throws

Error — if the color is not a ThemeColor.

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

---

build()

Creates a color object from the settings supplied to the builder.

Return

Color — A color object created from this builder.

---

getColorType()

Get the type of this color.

Return

ColorType — The color type.

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

---

setRgbColor(cssString)

Sets as RGB color.

Parameters

Name	Type	Description
cssString	String	The RGB color in CSS notation (such as '#ffffff').

Return

ColorBuilder — This builder, for chaining.

---

setThemeColor(themeColorType)

Sets as theme color.

Parameters

Name	Type	Description
themeColorType	ThemeColorType	The theme color type.

Return

ColorBuilder — This builder, for chaining.