Interface HeatmapConfiguration

interface HeatmapConfiguration {
    backgroundColor?: string;
    blur?: number;
    gradient?: {
        [key: string | number]: string;
    };
    kernelMode?: "radialGradient" | "gaussian";
    maxOpacity?: number;
    minOpacity?: number;
    onExtremaChange?: (() => void);
    opacity?: number;
    radius?: number;
    useLocalExtrema?: boolean;
    valueField?: undefined;
}

Hierarchy

  • BaseHeatmapConfiguration
    • HeatmapConfiguration

Properties

backgroundColor? blur? gradient? kernelMode? maxOpacity? minOpacity? onExtremaChange? opacity? radius? useLocalExtrema? valueField?

Properties

Optional backgroundColor

backgroundColor?: string

A background color string in form of hexcode, color name, or rgb(a)

Optional blur

blur?: number

The blur factor that will be applied to all datapoints. The higher the blur factor is, the smoother the gradients will be Default value: 0.85

Optional gradient

gradient?: {
    [key: string | number]: string;
}

An object that represents the gradient. Syntax: {[key: number in range [0,1]]: color}

Type declaration

  • [key: string | number]: string

Optional kernelMode

kernelMode?: "radialGradient" | "gaussian"

选择核算法："radialGradient" 使用现有径向渐变，"gaussian" 使用严格高斯线性累加

Optional maxOpacity

maxOpacity?: number

The maximal opacity the highest value in the heatmap will have. (will be overridden if opacity set) Default value: 0.6

Optional minOpacity

minOpacity?: number

The minimum opacity the lowest value in the heatmap will have (will be overridden if opacity set)

Optional onExtremaChange

onExtremaChange?: (() => void)

Pass a callback to receive extrema change updates. Useful for DOM legends.

Type declaration

    • (): void

    • Returns void

Optional opacity

opacity?: number

A global opacity for the whole heatmap. This overrides maxOpacity and minOpacity if set Default value: 0.6

Optional radius

radius?: number

The radius each datapoint will have (if not specified on the datapoint itself)

Optional useLocalExtrema

useLocalExtrema?: boolean

Indicate whether the heatmap should use a global extrema or a local extrema (the maximum and minimum of the currently displayed viewport)

Optional valueField

valueField?: undefined

The property name of the value/weight in a datapoint Default value: 'value'

Settings

Member Visibility

Theme

On This Page

backgroundColorblurgradientkernelModemaxOpacityminOpacityonExtremaChangeopacityradiususeLocalExtremavalueField