README.md

vue-heatmap-component

Quick start

1. Install using npm: npm install CorpGlory/vue-heatmap-component
2. Import the component: import VueHeatmapComponent from 'vue-heatmap-component';
3. Register the component globally or in a separate component

Usage example

<template>
  <vue-heatmap-component
    :data="[
      { x: 'x1', y: 'y1',  value: 10 }, 
      { x: 'x1', y: 'y2',  value: 60 },
      { x: 'x2', y: 'y1',  value: 30 },
      { x: 'x2', y: 'y2',  value: 100 },
    ]"
    :axisX=['x1', 'x2']
    :axisY=['y1', 'y2']
  />
</template>
...

Result:

Props

• data — (required) NxN-sized array of values, e.g:

:data=[
  { x: 'x1', y: 'y1',  value: 10 }, 
  { x: 'x1', y: 'y2',  value: 60 },
  { x: 'x2', y: 'y1',  value: 30 },
  { x: 'x2', y: 'y2',  value: 100 },
]

• axisX — (required) array of x-axis variables, e.g:

:axisX=['x1', 'x2']

• axisY - (required) array of y-axis variables, e.g:

:axisY=['y1', 'y2']

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Customize configuration

See Configuration Reference.