jm-gantt-vue2

v1.1.4

Published

8 months ago

<p align="center"><img src="https://raw.githubusercontent.com/w1301625107/vue-gantt-chart/master/screenshot/icon.png" alt="logo" width="180"></p> <h1 align="center">vue-gantt-chart</h1> <p align="center">基于 Vue 实现的 gantt-like 图表 ,用于排班展示</p> <p align="cen

Downloads

0High
0Medium
0Low

jiangzhikele

React版本

Demo预览地址

Catalog

Feature

虚拟列表，快速渲染可视区域，支持大量数据渲染
可变时间轴，1 分钟，2 分钟，3 分钟，4 分钟~~~到一天
可变单元格
标记线
支持自定义描述和容器块

Screenshot

Install

npm 安装

npm i v-gantt-chart --save

Include plugin in your main.js file.

import Vue from 'vue'

import vGanttChart from 'v-gantt-chart';

Vue.use(vGanttChart);

使用链接引入

<script src="https://unpkg.com/v-gantt-chart/dist/v-gantt-chart.umd.min.js"></script>

<body>
  <div id="app">
    <v-gantt-chart></v-gantt-chart>
  </div>
</body>
  <!-- 先引入vue -->
  <script src="https://unpkg.com/vue/dist/vue.js"></script>
  <!-- 再引入v-gantt-chart.js -->
  <script src="./v-gantt-chart.js"></script>
  <script>
    new Vue({
      el: '#app',
    })
  </script>
</html>

Use

template code

<template>
  <v-gantt-chart :startTime="startTime"
           :endTime="endTime"
           :datas="datas">
      <template v-slot:block="{data,item}">
        <!-- 你的容器块组件 -->
        <Test :data="data" :item="item"></Test>
      </template>
      <template v-slot:left="{data}">
        <!-- 你的行名组件 -->
        <TestLeft :data="data"></TestLeft>
      </template>
      <template v-slot:title>
        <!-- 你的表头组件 -->
        hola
      </template>
    </v-gantt-chart>
</template>

script code

import Test from "./test.vue"; //你自己的gantt条容器
import TestLeft from "./test-left.vue"; //你自己的行名称组件
import { mockDatas } from "@src/mock/index.js"; //伪造的数据
import dayjs from "dayjs" //时间库

export default {
  name: "App",
  components: { Test, TestLeft },
  data() {
    return {
      startTime: dayjs().toString(),//时间轴开始时间
      endTime: dayjs() 
        .add(2, "d")
        .add(2, "h")
        .add(5, "s").toString(), //时间结束时间
      datas: mockDatas(100), // gantt数据
    };
  },
};

data

在默认情况下（即customGenerateBlocks为false）的渲染的数据需要特殊格式 ，目前要求数组中每一个值均为对象，且有gtAarry对象数组这个属性(默认取gtArray，也可以通过arrayKeys属性自定义需要渲染的数组)

数组中每一个对象需有两个属性，start和end(不提供的情况，偏移与宽度将为0)，数值需为合法的时间字符串.例如

[
  {
    id:'test', //非必须
    gtArray:[ //默认的需要渲染的数组
      {
        name:'test', //非必须
        start:'2019-01-11 18:18:18',
        end:'2019-01-11 18:18:18'
      }
    ]，
    customKey:[ //自定义的需要渲染的数组
      {
        id:'test', //非必须
        start:'2019-01-11 18:18:18',
        end:'2019-01-11 18:18:18'
      }
    ]
  }
]

Slot

// 假设你传入的数据为
[
  {
    id:'arrayOne', 
    name:'sala',
    gtArray:[ 
      {
        name:'itemOne', 
        start:'2019-01-11 18:18:18',
        end:'2019-01-11 18:18:18'
        // ...其他属性
      }
    ]，
    //...其他属性
  }
  //... 其他数组数据
]

block 容器块slot 有 `两种` 需要注意

⭐️ `customGenerateBlocks` 为 `false`（默认值）的情况

<template v-slot:block="{data,item}">
    <!-- 你的容器块组件 -->
    <Test :data="data" :item="item"></Test>
</template>

data 为 gantt图表中每一行的所有数据如下

{
  id:'arrayOne', 
  name:'sala',
  gtArray:[{...}]，
  //...
}

item 为 gantt图表中一个小方块对数据如下

{
  name:'itemOne', 
  start:'2019-01-11 18:18:18',
  end:'2019-01-11 18:18:18'
  //...
}

⭐️ `customGenerateBlocks` 为 `true` 的情况

此时arrayKeys，itemkey将不再次生效，如何渲染，渲染什么，将由你自己决定，下方是一个例子

<template v-slot:block="{data,
                        getPositonOffset,
                        getWidthAbout2Times,
                        isInRenderingTimeRange,
                        startTimeOfRenderArea,
                        isAcrossRenderingTimeRange,
                        endTimeOfRenderArea}">
  <div class="myBlockContainer"
        v-for="item in data.gtArray"
        v-if="isInRenderingTimeRange(item.start)||isAcrossRenderingTimeRange(item.start,item.end)
              ||isInRenderingTimeRange(item.end)"
        :key="item.id"
        :style="{position:'absolute',
                left:getPositonOffset(item.start)+'px',
                width:getWidthAbout2Times(item.start,item.end)+'px'}">
    <Test :data="data" 
          :item="item"></Test>
  </div>
</template>

data 为gantt图表中每一行的所有数据

{
  id:'test', 
  name:'sala',
  gtArray:[{...}]，
  //...
}

除了data，还会提供以下属性和函数供调用

startTimeOfRenderArea 为当前渲染范围的时间轴开始时间的毫秒数

endTimeOfRenderArea 为当前渲染范围的时间轴结束时间的毫秒数

getPositonOffset(time:string):number 定位函数，根据给定字符串形式的时间生成相对时间轴起点的的偏移值

getWidthAbout2Times(start:string,end:string):number 为宽度计算函数，根据给定字符串形式的时间计算两个时间差的宽度值

isInRenderingTimeRange(time:string):boolean 判定给定的时间是否在屏幕显示的时间轴范围之内

isAcrossRenderingTimeRange(timeStart,timeEnd):boolean 判定给定的时间是否跨越了屏幕显示的时间轴范围之内

left 行名slot

<template v-slot:left="{data}">
    <!-- 你的行名组件 -->
    <TestLeft :data="data"></TestLeft>
</template>

data 为 gantt图表中每一行的所有数据

{
  id:'test', 
  name:'sala',
  gtArray:[{...}]，
  //...
}

timeline 时间轴slot

<template v-slot:timeline="{day , getTimeScales}">
    <!-- 你的时间刻度组件 -->
    <TestTimeline :day="day"></TestTimeline>
</template>

day 为每一个刻度对应的dayjs 对象

getTimeScales(day:dayjs):dayjs[] 计算当前day可以分划多少刻度，参数为day,返回dayjs对象数组

<template v-slot:timeline="{day , getTimeScales}">
    <!-- 你的时间刻度组件 -->
    <span v-for="i in getTimeScales(day)"> {{i.format('HH:mm')}}</span>
</template>

markline 时间标记线slot

<template v-slot:markLine="{timeConfig, getPosition}">
    <!-- 你的时间标记线组件 -->
    <TestMarkline :timeConfig="timeConfig" :getPosition="getPosition"></TestMarkline>
</template>

timeConfig 为传入的timelines的每一个值

getPosition(day:string):number 计算当前时间的偏移值，参数为day,返回偏移值

title 标题slot

<template v-slot:title>
    <!-- 你的表头组件 -->
    hola
</template>

API

Param

| param | required | type | default | describe | | :-------------- | :------: | :-----: | :----: | :---- | | startTime | ❌ | string | 当前时间 | 时间轴开始时间，需为合法的时间字符串，如：2019-01-11 18:18:18| | endTime | ❌ | string | 当前时间 | 时间轴结束时间，需为合法的时间字符串，如：2019-01-11 18:18:18| | cellWidth | ❌ | number | 50 | 时间区间的宽度 | | cellHeight | ❌ | number | 20 | 时间区间的高度 | | titleHeight | ❌ | number | 40 | 表头的高度 | | titleWidth | ❌ | number | 200 | 表头和行的宽度 | | scale | ❌ | number | 60 | 时间轴的刻度值。单位:分钟，允许值[1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60, 120，180,240,360, 720, 1440] | | datas | ❌ | array | [] | 在默认情况下（即customGenerateBlocks为false）的渲染的数据需要特殊格式 ，目前要求数组中每一个值均为对象，且有gtAarry对象数组这个属性，gtArray中每一个对象需有两个属性，start和end(不提供的情况，偏移与宽度将为0)，需为合法的时间字符串.例如[{id:'test',gtArray:[{start:'2019-01-11 18:18:18',end:'2019-01-11 18:18:18'}]}] 其他不做限制。 | | arrayKeys| ❌ | array | ["gtArray"] | 需要渲染的数组的key | | dataKey | ❌ | string | -- | 渲染的每一行的key | | itemKey | ❌ | string | -- | 渲染的每一个gantt容器的key | | showCurrentTime | ❌ | boolean | false | 显示当前时间,每秒钟更新 | | timelines | ❌ | array | -- | 显示标记时间，有特殊格式 [{time:'2019-01-11 18:18:18',color:'#00000'}] | | scrollToTime | ❌ | string | -- | 滚动到指定的时间，需为合法的时间字符串 | | scrollToPostion | ❌ | object | -- | 滚动到指定的位置格式为 {x:number,y:number} | | hideHeader | ❌ | boolean | false | 隐藏时间轴和表头 | | hideXScrollBar | ❌ | boolean | false | 隐藏横向滚动轴 | | hideYScrollBar | ❌ | boolean | false | 隐藏纵向滚动轴 | | enableGrab | ❌ | boolean | true | 启动按住拖拽 | | customGenerateBlocks | ❌ | boolean | false | 开启自定义生成渲染块，具体使用见说明 | | timeRangeCorrection | ❌ | boolean | true | 时间矫正，默认开启。关闭后时间轴不会自动填充剩余空间，错误的先后时间会引起错误 | | preload | ❌ | number | 1 | 可视范围外渲染行数。如值为1时，屏幕只能显示10条，但是会顶部，底部会多渲染一条，避免滚动时出现空白。当值为0，渲染全部数据 |

Method

通过使用vue的ref来调用组件内部的方法，params中的scrollToTime和scrollToPostion可能会择机废弃，最好使用下方的方法替代。

| method | args | describle| | :--- |:-----:|:---------| | scrollToPositionHandle|positon:{x:number,y:number} | 滚动到指定位置| | scrollToTimehandle | time:string | 滚动到指定时间|

example

<template>
  <v-gantt-chart ref="gantt"></v-gantt-chart>
</template>

export default {
  methods:{
    doScrollToPostion(){
      this.$refs.gantt.scrollToPostionHandle({x:100,y:100})
    },
    doScrollToTime(){
      this.$refs.gantt.scrollToTimehandle("Fri, 31 Jul 2020 12:41:39 GMT")
    }
  }
};

Event

| event | type | describle| | :--- |:-----:|:---------| | scrollLeft| number | X轴的滚动值| | scrollTop | number | Y轴的滚动值|

Run Demo

注意项目需要 node 环境

#clone项目，进入项目根目录
#安装
npm i
# 启动
npm run serve
or
yarn serve
#打开浏览器地址栏输入localhost:8080即可

Caution

IE 需要自己处理一些ployfill,应该是promise
IE 浏览器内无法使用yyyy-MM-dd hh:mm:ss的字符串形式初始化,需要注意时间的格式
MacOS 系统需要在偏好设置中的通用开启始终显示滚动条，否则可能会看不到滚动条

注意查看vue 版本，不是2.6以上vue版本，不能直接使用demo中的v-slot的语法，需要使用旧的slot 语法2.6之前的slot 语法

// 2.6+语法
<template>
  <v-gantt-chart :startTime="startTime"
	   :endTime="endTime"
	   :datas="datas">
      <template v-slot:block="{data,item}">
	<!-- 你的容器块组件 -->
	<Test :data="data" :item="item"></Test>
      </template>
</template>

// 2.6之前的语法
<template>
  <v-gantt-chart :startTime="startTime"
	   :endTime="endTime"
	   :datas="datas">
      <template slot="block" slot-scope="{data,item}">  //<--------区别在这里
	<!-- 你的容器块组件 -->
	<Test :data="data" :item="item"></Test>
      </template>
</template>

Update

1.6.1

markline slot 字段调整

1.6.0

添加markline slot 支持

1.5.2

修复文档中的错误的默认值
修改导出的内容，支持页面单独引入

1.5.1

使用css来绘制网格获取更好的显示效果
优化一点点性能
添加鼠标按住拖动功能
添加新的refs说明

1.5.0

时间轴添加天的倍数的刻度支持
时间轴添加slot 支持
时间轴添加lazy 渲染支持
添加手机触摸支持 (bug:#16)

1.4.0

添加时间矫正开关
添加可配置可视范围外渲染行数
精简代码
添加测试

1.3.7

修复时间轴时间变化后不自动刷新的问题(bug:#22)
精简代码

1.3.6

修复甘特条显示判定条件，slot添加新的api:isAcrossRenderingTimeRange

1.3.5

修复甘特条长度超过可视范围时显示不正常的问题(bug:#7)

1.3.4

修复打包文件错误，导致无法链接引入的问题
代码优化

1.3.3

修复时间轴的日期数字在某些情况下撑开div，导致时间轴不准确的问题

1.3.2

修正滚动的触发和滚动范围限制的问题

1.3.1

替换moment 为dayjs
为startTime，endTime，datas添加默认值

1.3.0

优化渲染速度
相比之前的自定义渲染，添加一个新的slot，支持自定义的定位和渲染，更加的灵活

1.2.6

修复当时间线宽度比渲染宽度小的情况下的部分白屏
修复数据刷新时不重新渲染的问题
修复滚动条长度计算问题导致的时间线部分被隐藏
样式微调

1.2.5

修复cellheight,cellwidth 变动且不滚动时，渲染数据范围不正常的问题
修改样式的变动处理

1.2.4

修复滚动时向上滚动时会空白一行没有渲染的问题
修复左侧行名区数据过少时，无法盖住其底下标记线的问题

1.2.3

添加Resize Observer api 的polyfill

1.2.2

通过Resize Observer api来监听div的变化，用以修复感知不到容器大小变化引起的渲染数量不正常的问题

1.2.1

支持通过监听scrollLeft和scrollTop获取滚动值
修复页面中存在2个甘特图滚动错误的问题
修复没有start，end值可能引起的问题，当不存在start，end时偏移与宽度均为0值

1.2.0

支持隐藏滚动条
修复一次滚动触发2次滚动事件的问题
修复scrollToPosition 无法设置0值是问题

1.1.3

添加默认slot

1.1.2

支持隐藏表头和时间轴功能
支持自定义需要渲染的数组key
修复横线滚动越界问题