Class: ColorMap

Defined in: ColorMap.ts:37

Extends

• EventEmitter<ColorMapEventMap>

Constructors

Constructor

new ColorMap(colors, options?): ColorMap;

Defined in: ColorMap.ts:45

Parameters

colors

Color[]

options?

ColorMapOptions = {}

Returns

ColorMap

Overrides

EventEmitter.constructor

Properties

presetMaps

static presetMaps: 
  | Record<string, ColorArray[]>
  | null = null;

Defined in: ColorMap.ts:43

Methods

setRange()

setRange(range?): void;

Defined in: ColorMap.ts:61

Parameters

range?

[number, number]

Returns

void

---

setThreshold()

setThreshold(threshold?): void;

Defined in: ColorMap.ts:68

Parameters

threshold?

[number, number]

Returns

void

---

parseColor()

parseColor(color): ColorArray;

Defined in: ColorMap.ts:85

Normalize and validate a color specification. Colors may be provided as a hex string (with or without leading '#') or as an array of numeric components in the range [0, 1].

Parameters

color

Color

The color to parse.

Returns

ColorArray

Array of normalized RGB or RGBA components.

---

hexToRgb()

hexToRgb(hex): RGB;

Defined in: ColorMap.ts:103

Parameters

hex

string

Returns

RGB

---

getColor()

getColor(value): ColorArray;

Defined in: ColorMap.ts:115

Parameters

value

number

Returns

ColorArray

---

getUnmaskedColor()

getUnmaskedColor(value): ColorArray;

Defined in: ColorMap.ts:139

The colour value maps to, ignoring the threshold mask: what a colour key shows for the value, whether or not the surface draws it.

Parameters

value

number

Returns

ColorArray

---

hasAlpha()

hasAlpha(): boolean;

Defined in: ColorMap.ts:169

Returns

boolean

---

setAlpha()

setAlpha(alpha?): void;

Defined in: ColorMap.ts:173

Parameters

alpha?

number

Returns

void

---

getRange()

getRange(): [number, number];

Defined in: ColorMap.ts:179

Returns

[number, number]

---

getThreshold()

getThreshold(): [number, number];

Defined in: ColorMap.ts:183

Returns

[number, number]

---

getAlpha()

getAlpha(): number;

Defined in: ColorMap.ts:187

Returns

number

---

clone()

clone(): ColorMap;

Defined in: ColorMap.ts:192

Independent copy, including range, threshold and global alpha.

Returns

ColorMap

---

getColors()

getColors(): ColorArray[];

Defined in: ColorMap.ts:197

Copy the palette in display sRGB, including global alpha but no threshold mask.

Returns

ColorArray[]

---

generatePreset()

static generatePreset(name, nshades?): ColorArray[];

Defined in: ColorMap.ts:204

Parameters

name

string

nshades?

number = 256

Returns

ColorArray[]

---

fromArray()

static fromArray(colors, options?): ColorMap;

Defined in: ColorMap.ts:266

Build a ColorMap from an array of hex strings or rgb/rgba tuples.

Parameters

colors

Color[]

options?

ColorMapOptions = {}

Returns

ColorMap

---

toHex()

static toHex(color): number;

Defined in: ColorMap.ts:273

Normalize various color inputs to a consistent 0xRRGGBB hex number.

Parameters

color

string | number

Returns

number

---

getPresetMaps()

static getPresetMaps(): Record<string, ColorArray[]>;

Defined in: ColorMap.ts:315

Returns

Record<string, ColorArray[]>

---

getAvailableMaps()

static getAvailableMaps(): string[];

Defined in: ColorMap.ts:451

Returns

string[]

---

fromPreset()

static fromPreset(name, options?): ColorMap;

Defined in: ColorMap.ts:456

Parameters

name

string

options?

ColorMapOptions = {}

Returns

ColorMap

---

on()

on<K>(event, listener): UnsubscribeFn;

Defined in: EventEmitter.ts:18

Type Parameters

K

K extends keyof ColorMapEventMap

Parameters

event

K

listener

TypedEventListener<ColorMapEventMap[K]>

Returns

UnsubscribeFn

Inherited from

EventEmitter.on

---

once()

once<K>(event, listener): UnsubscribeFn;

Defined in: EventEmitter.ts:30

Type Parameters

K

K extends keyof ColorMapEventMap

Parameters

event

K

listener

TypedEventListener<ColorMapEventMap[K]>

Returns

UnsubscribeFn

Inherited from

EventEmitter.once

---

emit()

emit<K>(event, ...args): void;

Defined in: EventEmitter.ts:41

Type Parameters

K

K extends keyof ColorMapEventMap

Parameters

event

K

args

...EventPayloadArgs<ColorMapEventMap[K]>

Returns

void

Inherited from

EventEmitter.emit

---

removeListener()

removeListener<K>(event, listenerToRemove): void;

Defined in: EventEmitter.ts:60

Type Parameters

K

K extends keyof ColorMapEventMap

Parameters

event

K

listenerToRemove

TypedEventListener<ColorMapEventMap[K]>

Returns

void

Inherited from

EventEmitter.removeListener

---

removeAllListeners()

removeAllListeners(event?): void;

Defined in: EventEmitter.ts:75

Parameters

event?

keyof ColorMapEventMap

Returns

void

Inherited from

EventEmitter.removeAllListeners

---

off()

off<K>(event, listener): void;

Defined in: EventEmitter.ts:84

Type Parameters

K

K extends keyof ColorMapEventMap

Parameters

event

K

listener

TypedEventListener<ColorMapEventMap[K]>

Returns

void

Inherited from

EventEmitter.off