react-heatmap-grid

A React component for heatmap in grid layout using div.

Installation

yarn add react-heatmap-grid

or

npm install react-heatmap-grid --save

Usage

Mandatory fields

Name	Type	Sample
xLabels	Array of string	['1am', '2am', '3am']
yLabels	Array of string	['Sun', 'Mon']
data	2D Array of numbers having yLabels.length rows and xLabels.length rows	[[2,3,5][5,6,9]]

const xLabels = new Array(24).fill(0).map((_, i) => `${i}`);
const yLabels = ['Sun', 'Mon', 'Tue'];
const data = new Array(yLabels.length)
  .fill(0)
  .map(() => new Array(xLabels.length).fill(0).map(() => Math.floor(Math.random() * 100)));

ReactDOM.render(
  <HeatMap
    xLabels={xLabels}
    yLabels={yLabels}
    data={data}
  />,
  document.getElementById('app')
);

Configuration

Name	Type	Description	Default Value
background	string	The base color for the heatmap	#329fff
height	number	Height of each cell of the heatmap in px	30
xLabelWidth	number	Width of the x label area in pixel	60
yLabelTextAlign	string	text alignment of the yLabels	right
xLabelsLocation	string	Location of y labels. It can be top or bottom	top
xLabelsVisibility	[boolean]	Array of bool conveying which x labels to display. For ex: [true, false, true, false] means the 1st and the 3rd labels will be displayed and the 2nd and 4th will be hidden
unit	string	unit to dislay next to the value on hover

For developers

New build

yarn build

Run dev server

yarn dev

Run test

yarn test