Class ColorBuilder

  • ColorBuilder is a builder for creating color objects in Apps Script spreadsheets.

  • A new ColorBuilder is created using SpreadsheetApp.newColor().

  • The builder allows setting a color as either an RGB color using a CSS string or as a theme color using a ThemeColorType.

  • Once configured, the build() method creates the final Color object.

  • You can also convert a built color object to its RgbColor or ThemeColor representation and get its ColorType.
ColorBuilder

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

Methods

MethodReturn typeBrief description
asRgbColor()RgbColorConverts this color to an RgbColor.
asThemeColor()ThemeColorConverts this color to a ThemeColor.
build()ColorCreates a color object from the settings supplied to the builder.
getColorType()ColorTypeGet the type of this color.
setRgbColor(cssString)ColorBuilderSets as RGB color.
setThemeColor(themeColorType)ColorBuilderSets 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

NameTypeDescription
cssStringStringThe RGB color in CSS notation (such as '#ffffff').

Return

ColorBuilder — This builder, for chaining.

setThemeColor(themeColorType)

Sets as theme color.

Parameters

NameTypeDescription
themeColorTypeThemeColorTypeThe theme color type.

Return

ColorBuilder — This builder, for chaining.