npm 包 js-gantt 使用教程

阅读时长 6 分钟读完

在现代 Web 应用中,复杂的前端项目中经常需要使用 Gantt 图来对时间进度进行可视化展示。而 npm 包 js-gantt 可以帮助开发者快速地集成 Gantt 图,为用户提供可视化的进度条和时间轴。

本文将详细介绍 npm 包 js-gantt 的使用方法,包括如何进行安装和初始化、Gantt 图的配置和数据展示,并提供详细的示例代码和说明,帮助读者更好地理解和应用此技术。

安装和初始化

npm 包 js-gantt 可以通过 npm 包管理器进行安装。在终端中输入以下命令进行安装:

安装完成后,在项目中引入 jsGantt 类:

然后,创建一个容器元素,并实例化 jsGantt 类:

其中,js-gantt-container 是用于承载 Gantt 图的容器元素的 ID,config 是 Gantt 图的配置项(见下文)。

配置

Gantt 图的配置项包括以下几个:

  • scale:时间刻度的单位,默认为 day,可选 hoursdayweekmonth
  • start:Gantt 图开始时间,默认为当天。
  • end:Gantt 图结束时间,默认为开始时间加上 30 天。
  • data:Gantt 图的数据源,格式为数组,每个元素代表一个任务。
  • cellHeight:每行任务高度,默认为 33
  • cellWidth:每小时所占宽度,默认为 35

示例代码如下:

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

数据展示

js-gantt 提供了一些方法,可以用于数据的展示和交互操作,以下为常用方法的详细介绍:

refresh

刷新 Gantt 图:

scrollTo

滚动到指定位置:

date 为指定日期,时间单位为毫秒。

addTask

添加任务:

task 为一个对象,包含以下属性:

  • id:任务 ID。
  • name:任务名称。
  • start:任务开始时间。
  • end:任务结束时间。
  • progress:任务完成进度。
  • dependencies:前置任务。
  • customClass:自定义样式类。

deleteTask

删除任务:

taskId 为任务 ID。

getTask

获取指定任务:

taskId 为任务 ID。

getTasks

获取所有任务:

changeTask

更改任务:

taskId 为任务 ID,changedProps 为更改后的属性。

示例代码:

示例代码

完整的示例代码:

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

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

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

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

总结

本文介绍了 npm 包 js-gantt 的用法,包括安装和初始化、Gantt 图的配置和数据展示,并提供了详细的示例代码。希望读者能通过本文学会如何使用 js-gantt,并在实践中灵活运用、构建高质量的 Gantt 图。

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

纠错
反馈