Home > blockly > utils > parsing > parseBlockColour

utils.parsing.parseBlockColour() function

Parse a block colour from a number or string, as provided in a block definition.

Signature:

export declare function parseBlockColour(colour: number | string): {
    hue: number | null;
    hex: string;
};

Parameters

Parameter	Type	Description
colour	number | string	HSV hue value (0 to 360), #RRGGBB string, or a message reference string pointing to one of those two values.

Returns:

{ hue: number | null; hex: string; }

An object containing the colour as a #RRGGBB string, and the hue if the input was an HSV hue value.

Exceptions

{Error} If the colour cannot be parsed.