Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HeatmapConfiguration

Hierarchy

Index

Properties

backgroundColor?: string

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

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

gradient?: {}

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

Type declaration

  • [key: string]: string
maxOpacity?: number

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

minOpacity?: number

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

onExtremaChange?: (() => void)

Type declaration

    • (): void
    • Pass a callback to receive extrema change updates. Useful for DOM legends.

      Returns void

opacity?: number

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

radius?: number

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

useLocalExtrema?: boolean

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

valueField?: undefined

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

Generated using TypeDoc