Heatmap

A heatmap in REAVIZ visualizes data values within a matrix using color variations. This method, first termed by Cormac Kinney in 1991, is effective for showing patterns in correlations across multiple variables. Heatmaps are particularly useful in displaying large datasets and identifying trends that might not be obvious through other chart types.

Types supported by reaviz:

Where to use:

Visualize Variance: Ideal for displaying variance across multiple variables.
Identify Patterns: Useful for identifying patterns and correlations in data.
Analyze Complex Data: Great for analyzing large datasets with multiple variables.

Quick Start

To create a Heatmap, use import the Heatmap and give it data. The chart will automatically configure itself with the default options exposed via props.

import { Heatmap } from 'reaviz';


export default function App() {
const data = [
  {
    key: 'Lateral Movement',
    data: [
      {
        key: 'XML',
        data: 0
      },
      {
        key: 'JSON',
        data: 120
      },
      {
        key: 'HTTPS',
        data: 150
      }
    ]
  },
  {
    key: 'Discovery',
    data: [
      {
        key: 'XML',
        data: 100
      },
      {
        key: 'JSON',
        data: 34
      },
      {
        key: 'HTTPS',
        data: 0
      }
    ]
  }
];


return (
  <Heatmap
    height={350}
    width={350}
    data={data}
  />
);
}

import { Heatmap } from 'reaviz';

export default function App() {
const data = [
  {
    key: 'Lateral Movement',
    data: [
      {
        key: 'XML',
        data: 0
      },
      {
        key: 'JSON',
        data: 120
      },
      {
        key: 'HTTPS',
        data: 150
      }
    ]
  },
  {
    key: 'Discovery',
    data: [
      {
        key: 'XML',
        data: 100
      },
      {
        key: 'JSON',
        data: 34
      },
      {
        key: 'HTTPS',
        data: 0
      }
    ]
  }
];

return (
  <Heatmap
    height={350}
    width={350}
    data={data}
  />
);
}

Examples

Heatmap

Year Calendar

Month Calendar

API

Heatmap

Name	Type	Default
`data`	`ChartNestedDataShape[]` Data the chart will receive to render.	`[]`
`series`	`ReactElement<HeatmapSeriesProps, FC<Partial<HeatmapSeriesProps>>>` The series component that renders the cell components.	`<HeatmapSeries padding={0.3} />`
`yAxis`	`ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>` The linear axis component for the Y Axis of the chart.	`<LinearYAxis type="category" axisLine={null} tickSeries={<LinearYAxisTickSeries line={null} label={<LinearYAxisTickLabel padding={5} />} />} />`
`xAxis`	`ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>` The linear axis component for the X Axis of the chart.	`<LinearXAxis type="category" axisLine={null} tickSeries={<LinearXAxisTickSeries line={null} label={<LinearXAxisTickLabel padding={5} />} />} />`
`secondaryAxis`	`ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>[]` Any secondary axis components. Useful for multi-axis charts.
`id`	`string` Id of the chart.
`width`	`number` Width of the chart. If not provided will autosize.
`height`	`number` Height of the chart. If not provided will autosize.
`margins`	`Margins` Margins for the chart.
`className`	`string` Classnames for the chart.
`containerClassName`	`string` Classnames for the chart.
`style`	`StyleHTMLAttributes<SVGSVGElement>` Additional css styles.
`center`	`boolean` Center the chart. Used mainly internally.
`centerX`	`boolean` Center chart on X Axis only. Used mainly internally.
`centerY`	`boolean` Center chart on Y Axis only. Used mainly internally.

CalendarHeatmap

Name	Type	Default
`data`	`ChartShallowDataShape[]` Chart data shape.
`height`	`number` Height of the component.
`width`	`number` Width of the component.
`view`	`CalendarView` View of the calendar renderer.	`'year'`
`series`	`ReactElement<HeatmapSeriesProps, FC<Partial<HeatmapSeriesProps>>>` The series component that renders the cell components.	`<HeatmapSeries padding={0.3} />`
`yAxis`	`ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>` The linear axis component for the Y Axis of the chart.	`<LinearYAxis type="category" axisLine={null} tickSeries={<LinearYAxisTickSeries line={null} label={<LinearYAxisTickLabel padding={5} />} />} />`
`xAxis`	`ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>` The linear axis component for the X Axis of the chart.	`<LinearXAxis type="category" axisLine={null} tickSeries={<LinearXAxisTickSeries line={null} label={<LinearXAxisTickLabel padding={5} />} />} />`
`secondaryAxis`	`ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>[]` Any secondary axis components. Useful for multi-axis charts.
`id`	`string` Id of the chart.
`margins`	`Margins` Margins for the chart.
`className`	`string` Classnames for the chart.
`containerClassName`	`string` Classnames for the chart.
`style`	`StyleHTMLAttributes<SVGSVGElement>` Additional css styles.
`center`	`boolean` Center the chart. Used mainly internally.
`centerX`	`boolean` Center chart on X Axis only. Used mainly internally.
`centerY`	`boolean` Center chart on Y Axis only. Used mainly internally.

HeatmapSeries

Name	Type	Default
`padding`	`number` Padding between cells.	`0.1`
`id`	`string` Id set by `Heatmap`.
`data`	`ChartInternalNestedDataShape[]` Parsed data set by `Heatmap`.
`xScale`	`any` D3 scale for X Axis. Set internally by `Heatmap`.
`yScale`	`any` D3 scale for Y Axis. Set internally by `Heatmap`.
`colorScheme`	`ColorSchemeType \| ColorSchemeStyleArray` Color scheme for the chart.	`['rgba(28, 107, 86, 0.5)', '#2da283']`
`emptyColor`	`string` Color for the empty cell of the chart.	`'rgba(200,200,200,0.08)'`
`animated`	`boolean` Whether the chart is animated or not.	`true`
`cell`	`ReactElement<HeatmapCellProps, FC<Partial<HeatmapCellProps>>>` Cell component that will be rendered.	`<HeatmapCell />`
`selections`	`any` Selected cell(s) in active state

HeatmapCell

Name	Type	Default
`x`	`number` X Position set by `HeatmapSeries`.
`y`	`number` Y Position set by `HeatmapSeries`.
`rx`	`number` rx SVG Attribute.	`2`
`ry`	`number` ry SVG Attribute.	`2`
`height`	`number` Height of cell set by `HeatmapSeries`.
`width`	`number` Width of cell set by `HeatmapSeries`.
`cellCount`	`number` Total count of cells set by `HeatmapSeries`.
`tooltip`	`ReactElement<ChartTooltipProps, FC<Partial<ChartTooltipProps>>> \| null` Tooltip component.	`<ChartTooltip modifiers={[flip()]} />`
`fill`	`string` Fill color set by `HeatmapSeries`.
`stroke`	`string` Stroke color set by `HeatmapSeries`.
`symbol`	`(data: ChartInternalShallowDataShape) => ReactNode` Symbol element to render.
`data`	`ChartInternalShallowDataShape` Data object set by `Heatmap`.
`animated`	`boolean` Whether cell is animated or not set by `HeatmapSeries`.
`cellIndex`	`number` Cell index set by `HeatmapSeries`.
`cursor`	`string` Cursor style attribute.	`'auto'`
`onClick`	`(event: any) => void` Event for when the bar is clicked.
`onMouseEnter`	`(event: any) => void` Event for when the bar has mouse enter.
`onMouseLeave`	`(event: any) => void` Event for when the bar has mouse leave.
`className`	`any` Classnames to apply to the element.
`style`	`any` CSS styles to apply to the element.