Skip to content
sigma.js sigma.js
v4.0.6 Docs Examples GitHub 12.2K

HeatmapOptions

HeatmapOptions = object

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

colorStops: object[]

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

color: string

value: number


optional getWeight?: (node) => number

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

string

number


radius: number

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


optional shading?: object

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

optional intensity?: number

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

optional lightAngle?: number

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

optional rotateWithCamera?: boolean

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

optional shininess?: number

Specular exponent (default: 16)

optional smoothing?: number

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

optional specular?: number

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


zoomToRadiusRatioFunction: (ratio) => number

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

number

number