HeatmapConfig

Interface HeatmapConfigExperimental

Experimental. May be changed in the future without notice.

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

See

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

Properties

colorBands? colorResolution? colorScheme? kernel? maxValue? sizeFactor? strengthFactor?

Properties

Optional ExperimentalcolorBands

colorBands?: 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

Optional ExperimentalcolorResolution

colorResolution?: number

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

Default

32

Optional ExperimentalcolorScheme

colorScheme?: CustomHeatmapColorScheme | HeatmapColorScheme

Color scheme to map calculated densities to.

Default

HeatmapColorScheme.TURBO

Optional Experimentalkernel

kernel?: HeatmapKernel

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

Default

HeatmapKernel.GAUSSIAN

Optional ExperimentalmaxValue

maxValue?: number

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

Default

1000

Optional ExperimentalsizeFactor

sizeFactor?: number

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

Default

1

Optional ExperimentalstrengthFactor

strengthFactor?: number

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

Default

1
Did you find this page useful? Please give it a rating:
★ ★ ★ ★ ★
Thank you for rating this page!
Any issues or feedback?
What kind of problem would you like to report?
Please tell us more about what's wrong: