Class SpreadsheetTheme
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Documentação detalhada
getConcreteColor(themeColorType)
Retorna o Color específico para um tipo de cor de tema válido. Gera uma exceção se o tipo de
cor do tema não estiver definido no tema atual.
Parâmetros
Retornar
Color: cor do concreto.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontFamily()
Retorna a família de fontes do tema ou null se for um tema null.
Retornar
String: a família de fontes do tema.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getThemeColors()
Retorna uma lista de todos os tipos de cores de tema possíveis para o tema atual.
Retornar
ThemeColorType[]: uma lista de cores do tema.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setConcreteColor(themeColorType, color)
Define a cor concreta associada ao ThemeColorType neste esquema de cores para a
cor especificada.
Parâmetros
Retornar
SpreadsheetTheme: o tema, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setConcreteColor(themeColorType, red, green, blue)
Define a cor concreta associada ao ThemeColorType neste esquema de cores para a
cor especificada no formato RGB.
Parâmetros
| Nome | Tipo | Descrição |
themeColorType | ThemeColorType | O tipo de cor do tema. |
red | Integer | O valor do canal vermelho. |
green | Integer | O valor do canal verde. |
blue | Integer | O valor do canal azul. |
Retornar
SpreadsheetTheme: o tema, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontFamily(fontFamily)
Define a família de fontes do tema.
Parâmetros
| Nome | Tipo | Descrição |
fontFamily | String | A família de fontes do novo tema. |
Retornar
SpreadsheetTheme: este tema, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 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`"]]
