Skip to content
This is the alpha v4 version website. Looking for the v3 documentation?

HeatmapOptions

HeatmapOptions = object

Defined in: packages/layer-webgl/src/heatmap/types.ts:1

Properties

colorStops

colorStops: object[]

Defined in: packages/layer-webgl/src/heatmap/types.ts:5

color

color: string

value

value: number


getWeight?

optional getWeight?: (node) => number

Defined in: packages/layer-webgl/src/heatmap/types.ts:4

Parameters

node

string

Returns

number


radius

radius: number

Defined in: packages/layer-webgl/src/heatmap/types.ts:2


shading?

optional shading?: object

Defined in: packages/layer-webgl/src/heatmap/types.ts:9

intensity?

optional intensity?: number

Diffuse lighting strength, 0–1 (default: 0.5)

lightAngle?

optional lightAngle?: number

Light direction in degrees, 0=top, clockwise (default: 315 = top-left)

rotateWithCamera?

optional rotateWithCamera?: boolean

When true (default), the light rotates with the camera. When false, the light stays fixed in world space.

shininess?

optional shininess?: number

Specular exponent (default: 16)

smoothing?

optional smoothing?: number

Pixel radius for gradient sampling — higher = smoother shading (default: 3)

specular?

optional specular?: number

Specular highlight strength, 0–1 (default: 0.2)


zoomToRadiusRatioFunction

zoomToRadiusRatioFunction: (ratio) => number

Defined in: packages/layer-webgl/src/heatmap/types.ts:3

Parameters

ratio

number

Returns

number