npm 包 vue-easy-gantt 使用教程

阅读时长 6 分钟读完

什么是 vue-easy-gantt?

vue-easy-gantt 是一个基于 Vue.js 的简单易用的甘特图组件。它可以帮助我们快速构建出一个漂亮、可定制、可交互的甘特图,用于展示任务的时间进度。

安装和使用

安装

我们可以使用 npm 进行安装,打开终端,执行以下命令:

导入和注册

安装成功后,在你的 Vue 项目中,我们在需要使用甘特图的组件中,先导入 vue-easy-gantt:

接着在 Vue 实例中注册 Gantt 组件:

传递数据

Gantt 组件需要一个数组类型的数据源,用于描述任务的信息。我们可以按照以下格式创建这个数据源:

其中,每个任务对象的属性含义如下:

  • id:任务的唯一标识,必须是一个数字。
  • name:任务的名称,字符串类型。
  • start:任务的开始时间,必须是一个标准的日期字符串,如 2022-08-01
  • end:任务的结束时间,必须是一个标准的日期字符串,如 2022-08-10
  • progress:任务的进度,必须是一个数字类型,表示任务的完成百分比。

在组件模板中,我们可以将这个数据源传递给 Gantt 组件:

-- -------------------- ---- -------
----------
  -----
    ------ -----------------------
  ------
-----------

--------
  ------ ----- ---- -----------------
  
  ------ ------- -
    ----------- -
      ------
    --
    ------ -
      ------ -
        ------ -
          - --- -- ----- ----- --- ------ ------------- ---- ------------- --------- -- --
          - --- -- ----- ----- --- ------ ------------- ---- ------------- --------- -- --
          -- -------
        --
      --
    --
  --
---------

属性和事件

Gantt 组件支持多个自定义属性和事件,以满足不同的需求。

tasks

类型:Array

必须传递的属性,用于传递任务信息的数据源(详见上文)。

width

类型:String

默认值:100%

用于指定甘特图的宽度,可以是一个像素值或者百分比。

height

类型:String

默认值:400px

用于指定甘特图的高度,可以是一个像素值或者百分比。

barHeight

类型:Number

默认值:20

用于指定任务进度条的高度,单位为像素。

showTaskInfo

类型:Boolean

默认值:true

用于指定甘特图上是否显示任务列表。

showTaskLabels

类型:Boolean

默认值:true

用于指定任务进度条上是否显示任务名称。

showTaskProgress

类型:Boolean

默认值:true

用于指定任务进度条上是否显示任务进度。

onClick

类型:Function

默认值:null

用于设置点击甘特图上某个任务时的回调函数。回调函数有一个参数 task,表示所点击的任务对象。

onDoubleClick

类型:Function

默认值:null

用于设置双击甘特图上某个任务时的回调函数。回调函数有一个参数 task,表示所双击的任务对象。

onRightClick

类型:Function

默认值:null

用于设置右键甘特图上某个任务时的回调函数。回调函数有一个参数 task,表示所右键的任务对象。

示例代码

下面是一个完整的示例代码,以供参考:

-- -------------------- ---- -------
----------
  -----
    ------ 
      -------------- 
      ----------------
      -----------------
      ---------------
      ---------------------
      ----------------------
      ------------------------
      --------------------------
      --------------------------------------
      ------------------------------------
    ---------
  ------
-----------

--------
  ------ ----- ---- -----------------
  
  ------ ------- -
    ----------- -
      ------
    --
    ------ -
      ------ -
        ------ -
          - --- -- ----- --------- ------ ------------- ---- ------------- --------- -- --
          - --- -- ----- --------- ------ ------------- ---- ------------- --------- -- --
          - --- -- ----- ------- ------ ------------- ---- ------------- --------- -- --
          - --- -- ----- ------- ------ ------------- ---- ------------- --------- - --
        --
      --
    --
    -------- -
      --------------------- -
        ------------------ ------- ------
      --
      --------------------------- -
        ------------------- ----- ------- ------
      --
      -------------------------- -
        ------------------ ----- ------- ------
      --
    --
  --
---------

总结

vue-easy-gantt 是一个非常实用的 Vue.js 组件,可以帮助我们快速构建出一个漂亮、可定制、可交互的甘特图,用于展示任务的时间进度。通过本篇教程,我们了解了如何安装和使用 vue-easy-gantt 组件,以及如何传递数据,设置属性和事件等。希望大家可以在项目中真正运用甘特图,提高项目管理效率。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60057b1f81e8991b448eb7d4

纠错
反馈