Intermact API Reference / @intermact/core / HeatmapOptions

Interface: HeatmapOptions

Defined in: packages/core/src/pcg/field-objects.ts:52

Options for heatmap.

Properties

nx?

readonly optional nx?: number

Defined in: packages/core/src/pcg/field-objects.ts:54

Grid cells along x (default 32).

---

ny?

readonly optional ny?: number

Defined in: packages/core/src/pcg/field-objects.ts:56

Grid cells along y (default 32).

---

ramp?

readonly optional ramp?: readonly RgbStop[]

Defined in: packages/core/src/pcg/field-objects.ts:60

Custom color ramp stops (default turbo-like).

---

range?

readonly optional range?: readonly [number, number]

Defined in: packages/core/src/pcg/field-objects.ts:58

Value range mapped to the ramp ends; defaults to the sampled min/max.

---

style?

readonly optional style?: ObjectStyle

Defined in: packages/core/src/pcg/field-objects.ts:61