Interface RepaintHeatMapColorOptions

Options accepted by repaintHeatMapColor.

interface RepaintHeatMapColorOptions {
    backgroundColor?: [number, number, number];
    coveredScratch?: Uint8Array;
    grid?: boolean | HeatMapGridOptions;
    ramp?: readonly HeatMapStop[];
    range?: [number, number];
}

Properties

backgroundColor? coveredScratch? grid? ramp? range?

Properties

OptionalbackgroundColor

backgroundColor?: [number, number, number]

RGB fill for pixels not covered by any triangle. Default [0, 0, 0].

OptionalcoveredScratch

coveredScratch?: Uint8Array

Reusable coverage scratch (Uint8Array of length ≥ width × height). Allocated internally if absent — pre-allocate and reuse across calls when repainting many heat maps per frame (live solar / sensor sweeps) to keep GC quiet.

Optionalgrid

grid?: boolean | HeatMapGridOptions

Optional grid overlay; same shape as on paintHeatMap.

Optionalramp

ramp?: readonly HeatMapStop[]

Colour ramp. Default DEFAULT_HEATMAP_RAMP.

Optionalrange

range?: [number, number]

Scalar value range mapped onto the ramp's [0, 1] domain. Auto- computed from the input scalars when omitted.

Settings

Member Visibility

On This Page

Properties