Skip to main content

Interface: HeatmapWeightBy

Defined in: spec/types.ts:237

A point's heatmap weight read from one of its properties: 0 weighs nothing, max and above weigh a full point, and values between scale linearly. A missing or non-numeric value weighs nothing.

Example​

// Fatal crashes carry `peso: 10`, minor ones `peso: 1`.
const weight: HeatmapWeightBy = { property: 'peso', max: 10 };

Properties​

max​

max: number

Defined in: spec/types.ts:241

Property value that weighs a full point. Must be greater than 0.

property​

property: string

Defined in: spec/types.ts:239

Feature property holding the weight.