1.0.14 • Published 1 year ago
tp-gantt v1.0.14
tp-gantt
(Vue仿Teambition甘特图 基于ts-gantt改造)
简介
甘特图(Gantt chart)称为横道图、条状图(Bar chart)、生产计划进度图。其通过条状图来显示项目,进度,和其他时间相关的系统进展的内在关系随着时间进展的情况。
快速上手
npm install --save tp-gantt
import tpGantt from 'tp-gantt'
import 'tp-gantt/lib/tp-gantt.css'
components: {
tpGantt
}
npm run serve
文档
Attributes 参数
序号 | 参数 | 说明 | 类型 | 可选值 | 默认值 | 注意 | ||
---|---|---|---|---|---|---|---|---|
1 | data | 数据 | Task[] | [] | ||||
2 | columns | 表格列字段数据 | Column[] | 任务标题、执行者、截止时间、前置依赖 | 不传 | |||
3 | viewType | 视图类型 | string | 支持日视图(day)、周视图(week)、月视图(month)、季视图(quarter)、年视图(halfYear) | day | TODO 待实现(增加该参数) | ||
4 | translateDate | 甘特图时间偏移值 | 支持dayjs对象 或标准时间字符串、日期对象、或ms时间戳 | 当前时间 | TODO 待增加该参数 | |||
... | 其他控制字段(待开发) | 控制排序,是否可编辑等 |
数据类型定义要包含字段
Task 配置项
序号 | 参数 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
1 | children | 数据的子集children字段,表示为树表 必须字段 | Task[] | [] |
2 | content | 任务描述的内容,任务标题列必须字段 | string | |
3 | executor | 执行人必须字段 | String | |
4 | startDate | 开始时间必须字段 | 标准日期即可 string或Date | |
5 | endDate | 截止日期必须字段 | 标准日期即可 string或Date | |
6 | collapsed | 是否折叠子任务 | boolean | false |
7 | color | 外部可根据状态定义条状图颜色 | string | |
7 | x : tring : any | 其他扩展字段用户自定义 | any |
Column 配置项
序号 | 参数 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
1 | width | 列的宽度配置 | number | |
2 | minWidth | 列最小宽度 | number | |
3 | name | 列的字段名称 | string | |
4 | visible | 是否隐藏列(暂未支持) | boolean | |
5 | sortable | 是否可排序(暂未支持) | boolean |
Events 事件
序号 | 事件名 | 说明 | 回调参数 |
---|---|---|---|
1 | onTaskCreate | 创建任务 | function(parent, task) 依次为任务数据与父级任务数据 |
3 | onTaskDelete | 删除任务 | function(task) 依次为当前任务行数据 |
4 | onTaskIndent | 任务左右移动切换父子任务 | function(parent, task) 依次为左右移动的父任务、与移动当前任务 |
5 | onTaskChangeContent | 任务内容发生变更 | function(task, content, oldContent) 依次为当前行数据 |
6 | onTaskTimeChange | 任务时间变更(时间dayjs类型) | function(task, startDate, endDate) 依次为当前行数据 |
7 | onToDetail | 进入详情 | function(task) 当前行数据 |
8 | onDragSort | 拖拽排序 | function(preParent, parentTask, preIndex, index, handleTask) 移动前后父级任务及位置 |
9 | changeTaskType | 切换任务类型 | function(task) 当前行数据 |
Methods 方法
版本记录
1.0.9 增加连线功能(注:点击端点连线实现连线)
1.0.0 基于ts-gantt完善修改基础功能