README.zh_CN.md

heatmapjs-vue

heatmapjs 的 Vue.js 组件.

English Document

基于 heatmap.js v2.0.5+ 开发，依赖 Vue.js v2.2.6+.

特性

• IE9+
• Support Typescript
• Auto resize

文档

• Demo
• 中文例子
• Example on JSBin

安装

NPM

安装npm包.

$ npm install heatmapjs-vue

组件注册

import Vue from 'vue'
import heatmapjsVue from 'heatmapjs-vue'
Vue.use(heatmapjsVue)

现在可以使用该组件

<style>
  .heatmapjs-container {
    width: 1000px;
    height: 500px;
  }
</style>
<heatmapjs-vue class="heatmapjs-container" :max="100" :min="0" :data="[{ x: 10, y: 15, value: 5}]"></heatmapjs-vue>

CDN

包含 vue 、heatmap.js、 heatmapjs-vue.js、heatmapjs-vue.css - 我推荐使用 unpkg.

<link rel="stylesheet" href="https://unpkg.com/[email protected]/dist/heatmapjs-vue.css"/>
<style>
  .heatmapjs-container {
    width: 1000px;
    height: 500px;
  }
</style>

<script src="https://unpkg.com/vue@latest"></script>
<script src="https://unpkg.com/[email protected]/build/heatmap.min.js"></script>
<!-- 使用最新版本 -->
<script src="https://unpkg.com/heatmapjs-vue@latest"></script>
<!-- 或指定某一个版本 -->
<script src="https://unpkg.com/[email protected]"></script>

现在可以使用该组件

<heatmapjs-vue class="heatmapjs-container" :max="100" :min="0" :data="[{ x: 10, y: 15, value: 5}]"></heatmapjs-vue>

typescript

heatmapjs-vue-ts-example

组件

属性 (全部可响应)

• options (default: {})

  更多信息，请查看 heatmap.js' API documentation

• min (default: 0)

  数据集最小边界值

• max (default: 100)

  数据集最大边界值

• data (default: [])

  数据集

  var dataPoint = { 
    x: 5, // 数据点的x坐标, 数字
    y: 5, // 数据点的y坐标, 数字
    value: 100 // 在点(x, y)的值
  };
  var data = [
    dataPoint, dataPoint, dataPoint, dataPoint
  ]
  

• clickDrawable (default: false)

  单击时添加数据点

• moveDrawable (default: false)

  当鼠标移动或触摸移动时添加一个数据点

• drawValue (default: 1)

  单击或移动时数据点的值

Methods

• getValueAt
• getData
• getDataURL
• repaint

更多信息，请查看 heatmap.js' API documentation

Events

• change

  当数据因单击或移动而发生更改时触发，且发送的第一个参数是最新的数据集

本地开发

开发

$ npm i
$ npm run docs-dev

发布

$ npm install -g [email protected]
$ npm install -g [email protected]
$ chmod a+x scripts/build
$ npm run release
$ git push --follow-tags origin dev && npm publish

如果您使用的是windows系统，您不能直接执行npm run release，您需要安装git bash软件，然后使用git bash执行命令./scripts/build和npm run release:only。

文档发布

$ npm install -g gh-pages
$ chmod a+x scripts/docs-publish
$ npm run docs-publish

如果您使用windows系统，您不能直接执行npm run docs-publish，您需要安装git bash软件，然后使用git bash执行./scripts/docs-publish命令。

捐赠

如果你觉得有用，您可以请我们喝杯咖啡。

许可证

MIT

Copyright (c) 2019-present, Qin Nian