Class SpreadsheetTheme
Stay organized with collections
Save and categorize content based on your preferences.
Detailed documentation
getConcreteColor(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
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
getFontFamily()
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
getThemeColors()
Returns a list of all possible theme color types for the current theme.
Return
ThemeColorType[] — 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
setConcreteColor(themeColorType, color)
Sets the concrete color associated with the ThemeColorType in this color scheme to the
given color.
Parameters
Return
SpreadsheetTheme — 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
setConcreteColor(themeColorType, red, green, blue)
Sets the concrete color associated with the ThemeColorType in this color scheme to the
given color in RGB format.
Parameters
| Name | Type | Description |
themeColorType | ThemeColorType | 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
SpreadsheetTheme — 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
setFontFamily(fontFamily)
Sets the font family for the theme.
Parameters
| Name | Type | Description |
fontFamily | String | The new theme font family. |
Return
SpreadsheetTheme — 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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eSpreadsheetTheme\u003c/code\u003e object allows you to access and modify existing themes within a spreadsheet.\u003c/p\u003e\n"],["\u003cp\u003eYou can get and set theme colors using methods like \u003ccode\u003egetConcreteColor\u003c/code\u003e, \u003ccode\u003esetConcreteColor\u003c/code\u003e, and \u003ccode\u003egetThemeColors\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe font family of a theme can be retrieved and modified with \u003ccode\u003egetFontFamily\u003c/code\u003e and \u003ccode\u003esetFontFamily\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAll these methods require authorization with specific scopes, such as \u003ccode\u003ehttps://www.googleapis.com/auth/spreadsheets\u003c/code\u003e.\u003c/p\u003e\n"]]],["Spreadsheet themes can be accessed and modified using `Spreadsheet.setSpreadsheetTheme(theme)`. Key actions include retrieving the concrete color for a theme color type with `getConcreteColor(themeColorType)`, and obtaining the theme's font family using `getFontFamily()`. Users can obtain a list of theme color types with `getThemeColors()`. Themes can be altered by setting the color with `setConcreteColor()`, or setting the font family using `setFontFamily()`. Color settings can be in [Color] or RGB.\n"],null,["# Class SpreadsheetTheme\n\nSpreadsheetTheme\n\nAccess and modify existing themes. To set a theme on a spreadsheet, use [Spreadsheet.setSpreadsheetTheme(theme)](/apps-script/reference/spreadsheet/spreadsheet#setSpreadsheetTheme(SpreadsheetTheme)). \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getConcreteColor(themeColorType)](#getConcreteColor(ThemeColorType)) | [Color](/apps-script/reference/spreadsheet/color) | Returns the concrete [Color](/apps-script/reference/spreadsheet/color) for a valid theme color type. |\n| [getFontFamily()](#getFontFamily()) | `String` | Returns the font family of the theme, or `null` if it's a `null` theme. |\n| [getThemeColors()](#getThemeColors()) | [ThemeColorType[]](/apps-script/reference/spreadsheet/theme-color-type) | Returns a list of all possible theme color types for the current theme. |\n| [setConcreteColor(themeColorType, color)](#setConcreteColor(ThemeColorType,Color)) | [SpreadsheetTheme](#) | Sets the concrete color associated with the [ThemeColorType](/apps-script/reference/spreadsheet/theme-color-type) in this color scheme to the given color. |\n| [setConcreteColor(themeColorType, red, green, blue)](#setConcreteColor(ThemeColorType,Integer,Integer,Integer)) | [SpreadsheetTheme](#) | Sets the concrete color associated with the [ThemeColorType](/apps-script/reference/spreadsheet/theme-color-type) in this color scheme to the given color in RGB format. |\n| [setFontFamily(fontFamily)](#setFontFamily(String)) | [SpreadsheetTheme](#) | Sets the font family for the theme. |\n\nDetailed documentation\n----------------------\n\n### `get``Concrete``Color(themeColorType)`\n\nReturns the concrete [Color](/apps-script/reference/spreadsheet/color) for a valid theme color type. Throws exception if the theme\ncolor type is not set in the current theme.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------------|-----------------------------------------------------------------------|-------------------|\n| `theme``Color``Type` | [ThemeColorType](/apps-script/reference/spreadsheet/theme-color-type) | Theme color type. |\n\n#### Return\n\n\n[Color](/apps-script/reference/spreadsheet/color) --- Concrete color.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Font``Family()`\n\nReturns the font family of the theme, or `null` if it's a `null` theme.\n\n#### Return\n\n\n`String` --- The theme font family.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Theme``Colors()`\n\nReturns a list of all possible theme color types for the current theme.\n\n#### Return\n\n\n[ThemeColorType[]](/apps-script/reference/spreadsheet/theme-color-type) --- A list of theme colors.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `set``Concrete``Color(themeColorType, color)`\n\nSets the concrete color associated with the [ThemeColorType](/apps-script/reference/spreadsheet/theme-color-type) in this color scheme to the\ngiven color.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------------|-----------------------------------------------------------------------|-----------------------|\n| `theme``Color``Type` | [ThemeColorType](/apps-script/reference/spreadsheet/theme-color-type) | The theme color type. |\n| `color` | [Color](/apps-script/reference/spreadsheet/color) | The color. |\n\n#### Return\n\n\n[SpreadsheetTheme](#) --- The theme, for chaining.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `set``Concrete``Color(themeColorType, red, green, blue)`\n\nSets the concrete color associated with the [ThemeColorType](/apps-script/reference/spreadsheet/theme-color-type) in this color scheme to the\ngiven color in RGB format.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------------|-----------------------------------------------------------------------|-----------------------------|\n| `theme``Color``Type` | [ThemeColorType](/apps-script/reference/spreadsheet/theme-color-type) | The theme color type. |\n| `red` | `Integer` | The value of red channel. |\n| `green` | `Integer` | The value of green channel. |\n| `blue` | `Integer` | The value of blue channel. |\n\n#### Return\n\n\n[SpreadsheetTheme](#) --- The theme, for chaining.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `set``Font``Family(fontFamily)`\n\nSets the font family for the theme.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------|----------|----------------------------|\n| `font``Family` | `String` | The new theme font family. |\n\n#### Return\n\n\n[SpreadsheetTheme](#) --- This theme, for chaining.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`"]]
