Class ColorScheme
Stay organized with collections
Save and categorize content based on your preferences.
ColorScheme
A color scheme defines a mapping from members of ThemeColorType to the actual colors used
to render them.
Detailed documentation
getConcreteColor(theme)
Returns the concrete Color associated with the ThemeColorType in this color
scheme.
The returned color is guaranteed to not be an instance of ThemeColor.
Parameters
| Name | Type | Description |
theme | ThemeColorType | The theme color to derive the concrete color from. |
Return
Color — The concrete color corresponding the theme color type in this scheme.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getThemeColors()
Returns a list of all possible theme color types in a color scheme.
Return
ThemeColorType[] — The possible theme color types in this scheme.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setConcreteColor(type, color)
Sets the concrete color associated with the ThemeColorType in this color scheme to the
given color.
Parameters
| Name | Type | Description |
type | ThemeColorType | The theme color type. |
color | Color | The color to set the theme color type to. |
Return
ColorScheme — This color scheme, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setConcreteColor(type, 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 |
type | ThemeColorType | The theme color type. |
red | Integer | The red value of the color to set the theme color type to (between 0 and 255). |
green | Integer | The green value of the color to set the theme color type to (between 0 and 255). |
blue | Integer | The blue value of the color to set the theme color type to (between 0 and 255). |
Return
ColorScheme — This color scheme, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setConcreteColor(type, hexColor)
Sets the concrete color associated with the ThemeColorType in this color scheme to the
given color in HEX format.
The hex string must be in the format '#RRGGBB'.
Parameters
| Name | Type | Description |
type | ThemeColorType | The theme color type. |
hexColor | String | The hex color to set the theme color type to, such as '#F304a7'. |
Return
ColorScheme — This color scheme, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
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\u003eA color scheme maps theme color types to actual colors used in Google Slides.\u003c/p\u003e\n"],["\u003cp\u003eYou can get and set the concrete color associated with a theme color type using \u003ccode\u003egetConcreteColor()\u003c/code\u003e and \u003ccode\u003esetConcreteColor()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetThemeColors()\u003c/code\u003e returns a list of all possible theme color types in a color scheme.\u003c/p\u003e\n"],["\u003cp\u003eColor schemes allow you to control the colors used for different elements within your presentations.\u003c/p\u003e\n"],["\u003cp\u003eThese methods require authorization with specific scopes to access and modify presentations.\u003c/p\u003e\n"]]],[],null,["# Class ColorScheme\n\nColorScheme\n\nA color scheme defines a mapping from members of [ThemeColorType](/apps-script/reference/slides/theme-color-type) to the actual colors used\nto render them. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getConcreteColor(theme)](#getConcreteColor(ThemeColorType)) | [Color](/apps-script/reference/slides/color) | Returns the concrete [Color](/apps-script/reference/slides/color) associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) in this color scheme. |\n| [getThemeColors()](#getThemeColors()) | [ThemeColorType[]](/apps-script/reference/slides/theme-color-type) | Returns a list of all possible theme color types in a color scheme. |\n| [setConcreteColor(type, color)](#setConcreteColor(ThemeColorType,Color)) | [ColorScheme](#) | Sets the concrete color associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) in this color scheme to the given color. |\n| [setConcreteColor(type, red, green, blue)](#setConcreteColor(ThemeColorType,Integer,Integer,Integer)) | [ColorScheme](#) | Sets the concrete color associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) in this color scheme to the given color in RGB format. |\n| [setConcreteColor(type, hexColor)](#setConcreteColor(ThemeColorType,String)) | [ColorScheme](#) | Sets the concrete color associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) in this color scheme to the given color in HEX format. |\n\nDetailed documentation\n----------------------\n\n### `get``Concrete``Color(theme)`\n\nReturns the concrete [Color](/apps-script/reference/slides/color) associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) in this color\nscheme.\n\nThe returned color is guaranteed to not be an instance of [ThemeColor](/apps-script/reference/slides/theme-color).\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|------------------------------------------------------------------|----------------------------------------------------|\n| `theme` | [ThemeColorType](/apps-script/reference/slides/theme-color-type) | The theme color to derive the concrete color from. |\n\n#### Return\n\n\n[Color](/apps-script/reference/slides/color) --- The concrete color corresponding the theme color type in this scheme.\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/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`\n\n*** ** * ** ***\n\n### `get``Theme``Colors()`\n\nReturns a list of all possible theme color types in a color scheme.\n\n#### Return\n\n\n[ThemeColorType[]](/apps-script/reference/slides/theme-color-type) --- The possible theme color types in this scheme.\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/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`\n\n*** ** * ** ***\n\n### `set``Concrete``Color(type, color)`\n\nSets the concrete color associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) in this color scheme to the\ngiven color.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|------------------------------------------------------------------|-------------------------------------------|\n| `type` | [ThemeColorType](/apps-script/reference/slides/theme-color-type) | The theme color type. |\n| `color` | [Color](/apps-script/reference/slides/color) | The color to set the theme color type to. |\n\n#### Return\n\n\n[ColorScheme](#) --- This color scheme, 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/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`\n\n*** ** * ** ***\n\n### `set``Concrete``Color(type, red, green, blue)`\n\nSets the concrete color associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) in this color scheme to the\ngiven color in RGB format.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|------------------------------------------------------------------|----------------------------------------------------------------------------------|\n| `type` | [ThemeColorType](/apps-script/reference/slides/theme-color-type) | The theme color type. |\n| `red` | `Integer` | The red value of the color to set the theme color type to (between 0 and 255). |\n| `green` | `Integer` | The green value of the color to set the theme color type to (between 0 and 255). |\n| `blue` | `Integer` | The blue value of the color to set the theme color type to (between 0 and 255). |\n\n#### Return\n\n\n[ColorScheme](#) --- This color scheme, 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/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`\n\n*** ** * ** ***\n\n### `set``Concrete``Color(type, hexColor)`\n\nSets the concrete color associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) in this color scheme to the\ngiven color in HEX format.\n\nThe hex string must be in the format '#RRGGBB'.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|------------------------------------------------------------------|------------------------------------------------------------------|\n| `type` | [ThemeColorType](/apps-script/reference/slides/theme-color-type) | The theme color type. |\n| `hex``Color` | `String` | The hex color to set the theme color type to, such as '#F304a7'. |\n\n#### Return\n\n\n[ColorScheme](#) --- This color scheme, 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/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`"]]
