Class ColorScheme

ColorScheme

A color scheme defines a mapping from members of ThemeColorType to the actual colors used to render them.

Methods

MethodReturn typeBrief description
getConcreteColor(theme)ColorReturns the concrete Color associated with the ThemeColorType in this color scheme.
getThemeColors()ThemeColorType[]Returns a list of all possible theme color types in a color scheme.
setConcreteColor(type, color)ColorSchemeSets the concrete color associated with the ThemeColorType in this color scheme to the given color.
setConcreteColor(type, red, green, blue)ColorSchemeSets the concrete color associated with the ThemeColorType in this color scheme to the given color in RGB format.
setConcreteColor(type, hexColor)ColorSchemeSets the concrete color associated with the ThemeColorType in this color scheme to the given color in HEX format.

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

NameTypeDescription
themeThemeColorTypeThe 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

NameTypeDescription
typeThemeColorTypeThe theme color type.
colorColorThe 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

NameTypeDescription
typeThemeColorTypeThe theme color type.
redIntegerThe red value of the color to set the theme color type to (between 0 and 255).
greenIntegerThe green value of the color to set the theme color type to (between 0 and 255).
blueIntegerThe 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

NameTypeDescription
typeThemeColorTypeThe theme color type.
hexColorStringThe 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