Class ColorScheme  |  Apps Script  |  Google for Developers (original) (raw)

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](/apps-script/reference/slides/theme-color-type) to the actual colors used to render them.

Detailed documentation

getConcreteColor(theme)

Returns the concrete [Color](/apps-script/reference/slides/color) associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) in this color scheme.

The returned color is guaranteed to not be an instance of [ThemeColor](/apps-script/reference/slides/theme-color).

Parameters

Name Type Description
theme ThemeColorType The theme color to derive the concrete color from.

Return

[Color](/apps-script/reference/slides/color) — The concrete color corresponding the theme color type in this scheme.

Scripts that use this method require authorization with one or more of the following scopes:


getThemeColors()

Returns a list of all possible theme color types in a color scheme.

Return

[ThemeColorType[]](/apps-script/reference/slides/theme-color-type) — The possible theme color types in this scheme.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:


setConcreteColor(type, color)

Sets the concrete color associated with the [ThemeColorType](/apps-script/reference/slides/theme-color-type) 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:


setConcreteColor(type, red, green, blue)

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.

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:


setConcreteColor(type, hexColor)

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.

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:

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.