Interface: HeatMapOptions

Defined in: src/mobjects/graphing/HeatMap.ts:13

Options for creating a HeatMap.

Properties

center?

optional center: Vector3Tuple

Defined in: src/mobjects/graphing/HeatMap.ts:31

Center position [x, y, z]. Default: [0, 0, 0]

---

domain?

optional domain: [number, number]

Defined in: src/mobjects/graphing/HeatMap.ts:23

Value domain [min, max] mapped across the palette. Auto-computed if omitted.

---

func

func: ScalarField2D

Defined in: src/mobjects/graphing/HeatMap.ts:15

The scalar field g(x, y) to visualize.

---

opacity?

optional opacity: number

Defined in: src/mobjects/graphing/HeatMap.ts:29

Opacity from 0 to 1. Default: 1

---

palette?

optional palette: readonly string[]

Defined in: src/mobjects/graphing/HeatMap.ts:25

Ordered hex color stops. Default: a viridis-like palette.

---

resolution?

optional resolution: number | [number, number]

Defined in: src/mobjects/graphing/HeatMap.ts:21

Grid cells per axis, or [nx, ny]. Default: 64

---

useOklab?

optional useOklab: boolean

Defined in: src/mobjects/graphing/HeatMap.ts:27

Blend the palette in perceptually-uniform Oklab space. Default: false

---

xRange?

optional xRange: [number, number]

Defined in: src/mobjects/graphing/HeatMap.ts:17

X range [min, max]. Default: [-5, 5]

---

yRange?

optional yRange: [number, number]

Defined in: src/mobjects/graphing/HeatMap.ts:19

Y range [min, max]. Default: [-5, 5]