1.0.6 • Published 1 year ago

xyy-gantt v1.0.6

Weekly downloads
-
License
GNU
Repository
-
Last release
1 year ago

wl-gantt

简介

甘特图(Gantt chart)又称为横道图、条状图(Bar chart)、生产计划进度图。其通过条状图来显示项目,进度,和其他时间相关的系统进展的内在关系随着时间进展的情况。以提出者亨利·劳伦斯·甘特(Henry Laurence Gantt)先生的名字命名。
目前市面上最有名的几个gantt插件占据江湖了非常久远的时间,它们古老又强大。 但无一例外的是:它们收费或极其难用并且依赖非常古老的技术,其中有些技术现在入行的新手甚至从未听闻。
【jQueryGantt】【plusgantt】【dhtmlx】 不可否认它们都非常的强大,不管是从性能还是功能性。但是大多的业务需求并不需要如此庞然大物才能满足需求。 另一方面古老的技术稀缺的文档又让开发者无从下手(收费版甚至不提供文档,而你的老板又肯定不会提供钱买下授权)。
wl-gantt出现的背景就是笔者在公司的Vue项目中使用B***Gantt插件所受到的巨大伤害:基于extjs(对于17年入行的我来说没听过)、不提供开发文档、没有中文资料、源码加密,开发全靠打印实例找属性。 wl-gantt是一个基于Vue及elementUi的gantt甘特图插件,是一个896的码奴在仅有的剩余的1中挤时间开发而成。
它目提供的功能有:自动检查源数据是否符合project任务安排规则、结束后开始的前置任务规则、yearAndmonth|yearAndWeek|ManthAndDay日期跨度地洞切换、内置前置任务管理器。
它的优点:非常简单易用,并且高度可配置,自动抹平不合格数据并给与提示,不会无缘无故产生异常。
它正在逐渐长大,下个阶段,它将学会:
1. yearAndMonth、monthAndDay、yearAndWeek时间跨度配置 【已完成,month及week格子起止位置待精确化】
2. 内置前置任务选择器 【已完成】
3. 整合树表全选联动功能 【已完成】
4. 添加、移除任务回调 【已完成】
4. 任务连接线
5. 任务自定义悬浮提示
6. 和所有你觉得需要用到的需求

在线演示 - GitHub

wl-gantt 与市面应用较广的大佬型插件对比

wl-gantt 外观简洁清爽,非常简单易用,高度可配置 wl-gantt

jquery Gantt 笨重、老旧、较丑但文档还算清晰 jquery Gantt

js gantt 不想多说了 js gantt

dhtmlxGantt 功能强大、全面;但是使用难度高,不切合现代框架及ui库,很难在项目中完美应用 dhtmlxGantt

frappe-gantt 功能好少 frappe

bryntum 唯一较美观的,但是可配置性差,无法和组件结合;不校验源数据正确性就报错、崩溃;规则死板不符合项目使用;收费年950$; 功能强大但文档只有简单介绍,详细用法只能控制台打印 bryntum

更新说明

2020-04-03 懒加载 2020-02-20 更新gantt,详见版本说明1.0.1 2019-12-14 更新gantt,增加内置前置任务列,支持多选前置和单选前置,并自动校验源数据前置任务合法性。 2019-12-3 更新gantt。1表格支持el-table大部分AttributesEvents,详细列表见下方;2名称列增加nameFormatter格式化内容函数支持;3日期列改为点击显示编辑输入框的形式。
2019-12-2 更新gantt.1日期支持yearAndMonth、monthAndDay、yearAndWeek类型,详见版本记录1;2修复部分时间更改情况不回调的问题。

已支持el-table参数及事件列表

    :fit="fit"
    :size="size"
    :border="border"
    :data="selfData"
    :stripe="stripe"
    :height="height"
    :row-key="rowKey"
    :row-style="rowStyle"
    :class="dateTypeClass"
    :cell-style="cellStyle"
    :max-height="maxHeight"
    :tree-props="selfProps"
    :current-row-key="rowKey"
    :row-class-name="rowClassName"
    :cell-class-name="cellClassName"
    :expand-row-keys="expandRowKeys"
    :header-row-style="headerRowStyle"
    :header-cell-style="headerCellStyle"
    :default-expand-all="defaultExpandAll"
    :header-row-class-name="headerRowClassName"
    :highlight-current-row="highlightCurrentRow"
    :header-cell-class-name="headerCellClassName"
    @header-contextmenu="handleHeaderContextMenu"
    @selection-change="handleSelectionChange"
    @row-contextmenu="handleRowContextMenu"
    @current-change="handleCurrentChange"
    @cell-mouse-enter="handleMouseEnter"
    @cell-mouse-leave="handleMouseLeave"
    @expand-change="handleExpandChange"
    @filter-change="handleFilterChange"
    @cell-dblclick="handleCellDbClick"
    @header-click="handleHeaderClick"
    @row-dblclick="handleRowDbClick"
    @sort-change="handleSortChange"
    @cell-click="handleCellClick"
    @select-all="handleSelectAll"
    @row-click="handleRowClick"
    @select="handleSelect"

快速上手

npm i wl-gantt --save

npm i wl-gantt -S

import wlGantt from 'wl-gantt'

import "wl-gantt/lib/wl-gantt.css"

Vue.use(wlGantt)

文档

Attributes 参数

序号参数说明类型可选值默认值注意
1data数据Array-[]-
2dateTypegantt图区日期表头类型StringmonthAndDay、yearAndMonth、yearAndDayyearAndMonth-
3treeProps树表配置项Object--见下方props
4startDate项目开始时间String、Object必填-注意:不要求任务时间线在项目开始时间内,并且当任务时间超出项目时间时,将更新项目时间
5endDate项目结束时间String、Object必填-注意:不要求任务时间线在项目开始时间内,并且当任务时间超出项目时间时,将更新项目时间
6checkSource是否检查源数据符合规则Boolean--检查源数据为自动修改不符合规范的时间为符合规则的期望值
7treatIdAsIdentityId是否使用id来作为自增idBoolean-false如果是请保证id本来就简短的数字型而不是较长的字符串或guid
8autoGanttDateType自动调整gantt时间跨度类型,具体规则见版本记录1Boolean-true-
9nameFormatter名称列格式化内容函数Function--Function(row, column, cellValue, index)
10其他Table Attributes文档地址----
11usePreColumn是否使用内置前置任务列Boolean-false-
12preMultiple前置任务是否可以多选Boolean-true如果开启多选则pre字段必须是Array,否则可以是Number\String
13preFormatter前置内容列格式化函数Function--如不传则根据prop name字段+,拼接
14emptyCellText空值单元格占位符String-'-'-
15useCheckColumn是否使用内置复选框列Boolean-false-
16useIndexColumn是否使用内置序号列Boolean-false-
17edit是否可编辑Boolean-true-
18parentChild使用复选框时,是否父子关联Boolean-true必须配置props的id、children字段
19ganttOnly是否只显示图形Boolean-false-
20lazy同el-tableBoolean-false-
21load同el-tableFunction---
22contextMenuOptions右键浮窗配置项,如果存在则点击gantt右键显示配置的浮窗信息Array--数组内对象属性有: @param {String} label 展示名称 @param {String} prop 绑定的字段 * @param {String} icon 可选 字体图标class
23useRealTime是否使用实际开始时间、实际结束时间,开启则在计划时间蓝色条外展示实际时间棕红色条Boolean-false-
24useCard是否使用表格hover窗口Boolean-false-

props 配置项

序号参数说明默认值
1children数据的子集children字段,表示为树表children
2name用于显示名字的字段name
3id每条数据的id,必须唯一id
4pid每条数据的父节点id字段pid
5startDate每条数据的开始时间字段startDate
6endDate每条数据的结束时间字段endDate
7identityId数据自增ididentityId
8parents自增父级id树,逗号分隔parents
9pre前置任务字段,字段值应是前置任务的idpre
10hasChildren指定哪些行是包含子节点hasChildren
11realStartDate实际开始时间字段realEndDate
12realEndDate实际结束时间字段realEndDate

Events 事件

序号事件名说明回调参数
1timeChange当任务时间发生更改时触发function(row) 依次为当前行数据
2其他Table Events文档地址--
3preChange前置任务修改事件function(row) 依次为当前行数据
4nameChange名称修改事件function(row) 依次为当前行数据
5taskAdd添加任务事件function(row) 依次为当前行数据
6taskRemove删除任务事件function(row) 依次为当前行数据

Methods 方法

序号方法名说明回调参数
1loadTree手动调用树表懒加载function(row) 依次为要展开的行信息
2loadTreeAdd更新树表懒加载后的子节点function(id, list) 依次为要更新的节点id,要添加的子节点list,注意此为合并list和原来的子节点数据
3loadTreeRemove移除懒加载数据的子节点function(id, list) 依次为要更新的节点id,要删掉的子字节的rowKey

slot

序号名字说明
1prv用于插入列表中名称前的列,如不生效需加fixed
2-插入在默认列及甘特图之间的列

版本记录

1.0.6 修复任务结束日期更改超出项目时间范围时,gantt图形未动态规划的错误;另发现useCard体验不好

1.0.5 增加列表行hover窗口

1.0.3版本,修复超过一年的时间跨度展示错误;增加右键浮窗功能

1.0.2版本,增加lazy和load参数,支持懒加载,并提供懒加载时的方法:Methods:1,2,3;增加ganttOnly参数支持只显示图形

1.0.1版本 增加内置复选框列、序号列;增加是否可编辑参数;修改内置前置任务列配置参数值为false;增加复选框的父子联动属性;增加名称列可编辑逻辑;增加添加、移除任务事件;

1.0.0版本 增加内置前置任务列,支持多选前置和单选前置,并自动校验源数据前置任务合法性。

0.1.6版本 更新gantt。1表格支持el-table大部分AttributesEvents;2名称列增加nameFormatter格式化内容函数支持;3日期列改为点击显示编辑输入框的形式。注意树表时rowKey参数必须传,默认为id

0.1.5版本 更新gantt日期支持yearAndMonth、monthAndDay、yearAndWeek类型,并自动调整,规则为:大于12个月的自动调整为yearAndMonth,3个月到12个月之间的,自动调整为yearAndWeek, 2个月及以内的自动调整为monthAndDay。新增参数autoGanttDateType可以管理是否自动调整,如果要关闭自动调整请保证时间跨度尽可能的少,否则会有明显的性能问题。修复部分时间更改情况不回调的问题。