Interface: ColorMapOptions

Defined in: src/display/ColorMap.ts:7

Configuration options for creating or modifying a ColorMap.

Properties

range?

optional range?: [number, number];

Defined in: src/display/ColorMap.ts:15

The numerical range of the data that will be mapped to the color scale. Values below the minimum map to the first color, and values above the maximum map to the last color.

Default is [0, 1].

---

threshold?

optional threshold?: [number, number];

Defined in: src/display/ColorMap.ts:24

A [low, high] pair specifying a "thresholding" region. Data values strictly inside this region become fully transparent, while values outside are displayed as normal. If low >= high, thresholding is disabled.

Default is [0, 0] (meaning no thresholding).

---

alpha?

optional alpha?: number | number[];

Defined in: src/display/ColorMap.ts:34

Overall alpha/opacity setting for the color map. This can be:

• A single number (0..1) applied to all colors equally.
• An array of length equal to the number of color stops, specifying alpha per color stop (0..1).

Default is undefined (no change to alpha in the provided colors).

---

name?

optional name?: string;

Defined in: src/display/ColorMap.ts:40

A human-readable name for the color map (e.g., "Viridis" or "Custom"). Used for referencing or debugging. Defaults to "Custom".