Class: Heat

jheatmap.decorators.Heat

new Heat

Heat decorator

Parameters:
Name Type Argument Default Description
p.minColor Array <optional>
 [0,0,255] Minimum color [r,g,b]
p.minValue number <optional>
 -1 Minimum value
p.midColor Array <optional>
 [255,255,0] Maximum color [r,g,b]
p.midValue number <optional>
 0 Maximum value
p.maxColor Array <optional>
 [255,0,0] Maximum color [r,g,b]
p.maxValue number <optional>
 1 Maximum value
p.nullColor Array <optional>
 [187,187,187] NaN values color [r,g,b]
Source:
  • ../js/jheatmap-1.0.0.js, line 899
Example
new jheatmap.decorators.Heat({ minValue: -5, midValue: 0, maxValue: 5 });

Methods

toColor

Convert a value to a color

Parameters:
Name Type Description
value The cell value
Source:
  • ../js/jheatmap-1.0.0.js, line 915
Returns:
The corresponding color string definition.