Class SpreadsheetTheme

Spreadsheet Theme

Access and modify existing themes. To set a theme on a spreadsheet, use Spreadsheet.setSpreadsheetTheme(theme) .

Methods

Method Return type Brief description
Color Returns the concrete Color for a valid theme color type.
String Returns the font family of the theme, or null if it's a null theme.
Theme Color Type[] Returns a list of all possible theme color types for the current theme.
Spreadsheet Theme Sets the concrete color associated with the Theme Color Type in this color scheme to the given color.
Spreadsheet Theme Sets the concrete color associated with the Theme Color Type in this color scheme to the given color in RGB format.
Spreadsheet Theme Sets the font family for the theme.

Detailed documentation

get Concrete Color(themeColorType)

Returns the concrete Color for a valid theme color type. Throws exception if the theme color type is not set in the current theme.

Parameters

Name Type Description
theme Color Type
Theme Color Type Theme color type.

Return

Color — Concrete color.

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

get Font Family()

Returns the font family of the theme, or null if it's a null theme.

Return

String — The theme font family.

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

get Theme Colors()

Returns a list of all possible theme color types for the current theme.

Return

Theme Color Type[] — A list of theme colors.

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

set Concrete Color(themeColorType, color)

Sets the concrete color associated with the Theme Color Type in this color scheme to the given color.

Parameters

Name Type Description
theme Color Type
Theme Color Type The theme color type.
color
Color The color.

Return

Spreadsheet Theme — The theme, 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

set Concrete Color(themeColorType, red, green, blue)

Sets the concrete color associated with the Theme Color Type in this color scheme to the given color in RGB format.

Parameters

Name Type Description
theme Color Type
Theme Color Type The theme color type.
red
Integer The value of red channel.
green
Integer The value of green channel.
blue
Integer The value of blue channel.

Return

Spreadsheet Theme — The theme, 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

set Font Family(fontFamily)

Sets the font family for the theme.

Parameters

Name Type Description
font Family
String The new theme font family.

Return

Spreadsheet Theme — This theme, 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
Create a Mobile Website
View Site in Mobile | Classic
Share by: