interface BuildAnalysisHeatmapOptions {
    gradient?: [number, number, number][];
    id?: string;
    opacity?: number;
    range?: [number, number];
    zOffset?: number;
}

Properties

gradient?: [number, number, number][]

RGB triples evenly spaced across range. The builder interpolates between adjacent entries for each cell's value. Default is a 5-stop deep-blue → cyan → yellow → orange → white gradient — readable on both dark and light models.

id?: string

SceneModel id. Default "daylightAnalysisHeatmap".

opacity?: number

Opacity for the heatmap quad. Default 0.85 so the underlying floor / facade still reads through faintly.

range?: [number, number]

Min / max value range mapped to the colour gradient ends. Default [0, result.max]. Pass a fixed [0, maxHoursPerYear] to make multiple analyses directly comparable.

zOffset?: number

Vertical offset above the grid's centre Z. Lifts the heatmap slightly off whatever surface it's sitting on to avoid Z-fight. Default 0.02 m.