Interface: ColorbarOptions

Defined in: render/colorbar.ts:13

Properties

borderColor?

optional borderColor?: string;

Defined in: render/colorbar.ts:27

---

font?

optional font?: string;

Defined in: render/colorbar.ts:28

---

format?

optional format?: (value) => string;

Defined in: render/colorbar.ts:25

Formats a tick value. Defaults to a compact 3-significant-digit formatter.

Parameters

Parameter	Type
value	number

Returns

string

---

heightFraction?

optional heightFraction?: number;

Defined in: render/colorbar.ts:21

Fraction of the plot height the bar spans, 0..1. Default 0.72.

---

label?

optional label?: string;

Defined in: render/colorbar.ts:17

Caption above the bar. Defaults to the layer's name.

---

position?

optional position?: "left" | "right";

Defined in: render/colorbar.ts:15

Which side of the plot region the bar sits on. Default "right".

---

textColor?

optional textColor?: string;

Defined in: render/colorbar.ts:26

---

ticks?

optional ticks?: number;

Defined in: render/colorbar.ts:23

Target number of tick labels. Default 5.

---

width?

optional width?: number;

Defined in: render/colorbar.ts:19

Bar thickness in px. Default 12.