Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

HeatmapConfig

Type Alias HeatmapConfigExperimental

HeatmapConfig: {
    colorBands?: boolean;
    colorResolution?: number;
    colorScheme?: HeatmapColorScheme | CustomHeatmapColorScheme;
    kernel?: HeatmapKernel;
    maxValue?: number;
    sizeFactor?: number;
    strengthFactor?: number;
}

Experimental. May be changed in the future without notice.

Global Heatmap configuration. When partially filled, only set values are override.

Type declaration

  • OptionalcolorBands?: boolean

    Whether the color mapping produces a continuous gradient of colors or separated bands of colors. Can be used in combination with colorResolution to generate isobands.

    Default

    false
  • OptionalcolorResolution?: number

    Resolution of color scheme lookup texture. Can be used in combination with colorBands to generate isobands.

    Default

    32
  • OptionalcolorScheme?: HeatmapColorScheme | CustomHeatmapColorScheme

    Color scheme to map calculated densities to.

    Default

    HeatmapColorScheme.TURBO
  • Optionalkernel?: HeatmapKernel

    Density falloff function from the center of a data point towards it's maximum impact range.

    Default

    HeatmapKernel.GAUSSIAN
  • OptionalmaxValue?: number

    Upper end of the color scheme. The calculated density is divided by this value before sampling the color scheme lookup texture.

    Default

    1000
  • OptionalsizeFactor?: number

    Global factor to adjust range of all points. Each heatmap point's size is scaled based on this value.

    Default

    1
  • OptionalstrengthFactor?: number

    Global factor to adjust maximum density of all points. This factor is applied to all heatmap points, adjusting the overall density.

    Default

    1

See