color reference

Colours are #RRGGBB or #RRGGBBAA literals or built with color.rgb. color.up and color.down follow the chart’s candle colours; color.gradient and color.scale map values to colours.

Functions

color.a

color.a(c: color) -> int

Returns the alpha channel from a color.

c must be a non-null color. The result is the non-null alpha channel as an integer in the 0..=255 range. Six-digit hex colors have alpha 255; eight-digit hex colors carry their explicit alpha value.

Returns int

color.b

color.b(c: color) -> int

Returns the blue channel from a color.

Returns the blue value of c as an integer from 0 to 255. Check for null or use ?? before passing a nullable color.

Returns int

color.darken

color.darken(c: color, percent: float) -> color

Darkens a color by mixing it toward black.

c is the starting color. percent sets how much to mix it toward black. The result is a non-null color with valid color-channel values.

Check for null or use ?? before passing nullable inputs.

Returns color

color.g

color.g(c: color) -> int

Returns the green channel from a color.

Returns the green value of c as an integer from 0 to 255. Check for null or use ?? before passing a nullable color.

Returns int

color.gradient

color.gradient(value: float, bottom: float, top: float, start: color, end: color) -> color

Blends between two colors based on a number.

value chooses a position between bottom and top. Values are clamped to that range without an error.

Returns start below the range or when bottom == top, and end above the range. Between the bounds, red, green, blue, and opacity change linearly. The result uses valid color-channel values.

Check for null or use ?? before passing nullable numbers or colors.

Returns color

color.lighten

color.lighten(c: color, percent: float) -> color

Lightens a color by mixing it toward white.

c is the starting color. percent sets how much to mix it toward white. The result is a non-null color with valid color-channel values.

Check for null or use ?? before passing nullable inputs.

Returns color

color.r

color.r(c: color) -> int

Returns the red channel from a color.

Returns the red value of c as an integer from 0 to 255. Check for null or use ?? before passing a nullable color.

Returns int

color.rgb

color.rgb(r: int, g: int, b: int, a: int = 255) -> color

Creates a color from red, green, blue, and opacity values.

r, g, and b each use an integer from 0 to 255. Out-of-range values are clamped to the nearest end of that range.

a sets opacity from 0 (transparent) to 255 (opaque) and defaults to 255. For example, color.rgb(17, 34, 51) equals #112233. All inputs must be non-null integers; fractions are not accepted.

Returns color

color.scale

color.scale(at: float[], colors: color[], space: ColorSpace = 2, easing: Easing = 1) -> ColorScale

Creates a color scale from a list of positions and colors.

Define the scale during setup, then read colors with .sample.

• at lists positions in ascending order. colors lists the matching colors. Both setup arrays need the same length and at least two entries.
• space chooses colorspace.rgb or colorspace.hsl, defaulting to HSL.
• easing chooses how colors change between positions: easing.linear, easing.smoothstep, or easing.smootherstep. The default is linear.

Positions must be finite and cannot descend; invalid lists are rejected before the script runs. Equal adjacent positions create a sharp color change: the earlier color applies at that position, and the later color applies beyond it. Opacity always changes linearly.

The scale cannot be saved in state or passed to other calls. Use its .sample method to read it.

Returns ColorScale

Available in Setup only: declarations, setup and state initialisers.

color.withAlpha

color.withAlpha(c: color, a: int) -> color

Changes a color’s opacity.

c supplies the color. a sets opacity from 0 (transparent) to 255 (opaque). It is an integer, not a percentage. Out-of-range values are clamped to 0 or 255.

Check for null or use ?? before passing a nullable color.

Returns color

Methods

colorscale.sample

colorscale.sample(t: float) -> color

Reads a color from a scale at a position.

t chooses the position. Values outside the scale are clamped: below it returns the first color, above it returns the last. Null or NaN also returns the first color without an error.

Between positions, the scale’s easing and color space determine the blend. HSL takes the shortest path around the color wheel. A gray endpoint uses the other endpoint’s hue. Opacity changes linearly in every color space.

Returns color

Available in Handlers and functions called from handlers.

Constants