Class Color

    • The Color object represents a color and can be converted to an RgbColor or a ThemeColor.

    • You can get the type of the color using the getColorType() method.

    • Converting to RgbColor or ThemeColor may throw an error if the color is not of that type.

    • Using these methods requires specific spreadsheet authorization scopes.
    Color

    A representation for a color.

    Methods

    Method Return type Brief description
    as Rgb Color()
    		Rgb Color Converts this color to an Rgb Color .
    as Theme Color()
    		Theme Color Converts this color to a Theme Color .
    get Color Type()
    		Color Type Get the type of this color.

    Detailed documentation

    asRgbColor()

    Converts this color to an RgbColor .

    Return

    RgbColor — The RGB color.

    Throws

    Error — if the color is not an RgbColor

    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

    asThemeColor()

    Converts this color to a ThemeColor .

    Return

    ThemeColor — The theme color.

    Throws

    Error — if the color is not a ThemeColor .

    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

    getColorType()

    Get the type of this color.

    Return

    ColorType — The color type.

    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
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: