跳到主要内容

从旧版本迁移

9.1 -> 10.0​

從 GPL 版本遷移到社群版 Community (MIT)​

从 GPL 版迁移到 Community (MIT) 版​

自 v10 起，DHTMLX Gantt 的免费版为 Community 版，在 MIT 许可证下分发。它取代了同一 dhtmlx-gantt 包之前的免费 GPL 版本。GPL v2 仍适用于之前的免费版本（v9.x 及更早版本），这些版本仍在 main GitHub repository 的专门分支中可用，但不再 actively maintained。 自 v10 起，DHTMLX Gantt 的免费版为 Community 版，在 MIT 许可证下分发。它取代了同一 dhtmlx-gantt 包之前的免费 GPL 版本。GPL v2 仍适用于之前的免费版本（v9.x 及更早版本），这些版本仍在 main GitHub repository 的专门分支中可用，但不再积极维护。

要将现有项目从 GPL 版迁移到 Community 版：

  • 检查软件包版本。 dhtmlx-gantt v10 及更高版本为 Community (MIT) 版；v9.x 及更早为 GPL 版。
  • 更新许可证说明，若在项目中引用了 Gantt 的许可证——免费版现在是 MIT，而不是 GPL。
  • 在运行时验证许可证值 - gantt.license 对 Community 版返回 "mit"（之前的免费版返回的是 "gpl"）
  • 测试导出行为。 在线导出服务对免费导出仍然会添加水印；此行为保持不变，与 GPL 许可证不再绑定（导出服务是独立产品）。
  • 查看功能差异。 Community 版不是旧 GPL 版的严格超集。它 新增 项目（摘要任务）、里程碑、自定义任务类型，以及每页支持多个 Gantt 实例的能力，但 移除了 撤销/重做、标记、多选、未排程任务、新任务占位行、工作日历和 WBS 码。完整功能对比请参见 Community vs PRO Library Versions。

XSS protection in framework wrappers​

自 v10.0 起，React Gantt、Vue Gantt 及 Angular Gantt 封装默认对来自用户提供的模板函数的字符串值进行清理，而不是直接将其作为原始 HTML 插入。这可防止通过模板渲染未经过净化的数据导致的 XSS 漏洞。

它适用于：

  • 通过 templates 属性传递的函数
  • config.columns[].template 函数
  • config.scales[].format 函数

默认情况（htmlTemplatePolicy="basic-sanitize"）返回的 HTML 采用白名单净化：保留常见的格式标签（<b>、<span>、<div> 等）、class、受限的一组内联样式、data-* 属性以及具有安全 src 的 <img/>，同时移除 <script>、内联事件处理程序和危险的 URL。返回简单标记的模板仍然可以工作；只有不安全的结构会被删除。

还原以前的 raw-HTML 行为​

将 htmlTemplatePolicy 属性设为 "unsafe-html" 以按以前的方式原样渲染模板字符串，无需处理：

<ReactGantt htmlTemplatePolicy="unsafe-html" /* ... */ />
<VueGantt htmlTemplatePolicy="unsafe-html" /* ... */ />
<dhx-gantt htmlTemplatePolicy="unsafe-html" /* ... */></dhx-gantt>

针对单个模板的原始 HTML​

用 allowRawHTML 包裹单个模板，以绕过该模板的净化——请自行使用导出的 escapeHTML 助手对任意用户数据进行清理：

import { allowRawHTML, escapeHTML } from "@dhx/react-gantt";
// 或 "@dhx/vue-gantt" / "@dhx/angular-gantt"

<ReactGantt
    templates={{
        task_text: allowRawHTML((start, end, task) => `<b>${escapeHTML(task.text)}</b>`)
    }}
/>

自定义清理器或文本渲染​

使用 htmlTemplatePolicy={{ mode: "sanitize", sanitize }} 来接入诸如 DOMPurify 之类的清理器，或使用 "escape" 将模板字符串渲染为纯文本。更多信息请参阅 App security。

Auto-scheduling engine update​

v10.0 内置了经过重新设计的自动排程引擎。它修复了若干长期存在的错误，主要集中在松弛时间（Slack）计算以及在启用 move_projects 时对项目（汇总任务）的排程。 公共 API 与可见行为保持不变，除了先前工作不正确的情况。可能影响现有代码的变更如下所列。

新引擎默认为默认引擎。如果在过渡期间需要切换回旧的引擎，请使用如下的退出标志：

gantt.config.auto_scheduling = {
    enabled: true,
    _engine: "v1",          // previous scheduling engine
    _analysis_engine: "v1"  // previous slack / critical path calculation
};

这些标志是过渡性的，将在 v10.1 中移除，因此请在此之前完成迁移。

行为变更​

领域在 v9.x 的情况自 v10.0 起应该怎么做
重复调用 gantt.autoSchedule()在混合使用若干日历的项目上，任务可能向前移动在未改动的数据上再次运行自动排程将保留相同日期无需操作
Slack 与关键路径值当 move_projects / gap_behavior 改变时可能变化仅依赖数据，与排程模式选项无关无需操作
针对不参与计算的任务的 getTotalSlack() / getFreeSlack()（依赖环、已完成任务）可能返回 undefined返回 0更新将 undefined 与 0 区分对待的代码
getSlack(task1, task2)仅对直接相连的任务准确跨链接任务的数值更准确；未链接对的数值保持不变更推荐使用 getTotalSlack / getFreeSlack
约束与偏好驱动移动的 onBeforeTaskAutoSchedule / onAfterTaskAutoSchedule 参数link 和源任务参数可能被设置对此类移动，这些参数为 null在假设 link 参数总是被设置的监听器中增加对 null 的检查
含 gap_behavior: "preserve" 的 Start-to-Finish 链接后继任务总是尽快调度（如同 "compress"）将遵循 gap_behavior 选项无需操作——这是修正后的行为
使用 move_projects: true 移动项目子孙的自身约束可能悄悄地把整个项目保持在原地整个项目一起移动；若子孙的约束冲突，会通过 onAutoScheduleConflict 报告可选地监听 onAutoScheduleConflict 以暴露冲突

新的事件与配置​

已知限制​

  • 当一个约束日期（例如 must-finish-on 或 start-no-later-than）落在自定义日历的非工作时间内，任务会获得一个受约束的正确日期，但其存储的 end_date（按 start + duration 计算）可能与约束日期完全一致地匹配不上。将触发 onAutoScheduleConflict 事件，便于你对不匹配做出反应。若要严格遵守约束，请使用工作时间包括该约束日期的日历。
  • 在数据解析后直接在代码中对项目（汇总任务）设置约束类型，可能在解析过程中被覆盖。请在加载的数据中设置此类约束，或通过 lightbox / 内联编辑器进行设置。

Date helper changes​

Interval-start helpers are now pure​

gantt.date 的区间起始辅助函数 - day_start、week_start、month_start、quarter_start、year_start、hour_start、minute_start，以及 date_part - 现在返回一个新的 Date，不再修改传给它们的日期。

返回值保持不变，因此仅对依赖就地变更并忽略返回值的代码需要更新：

// before v10.0 - relied on day_start mutating `date`
gantt.date.day_start(date);

// since v10.0 - use the returned date
date = gantt.date.day_start(date);

Single date parser and the deprecated csp config​

Gantt 不再提供基于 new Function 的“快速”日期解析器。现在唯一的实现是 CSP-安全解析器，[csp](/api/config/csp) 配置不再影响日期格式化。

该选项仍然保留，并仍被 lightbox 视为一个安全环境提示，因此现有配置将继续工作。无需迁移——仅为日期格式设置的 gantt.config.csp 可以移除。

TypeScript: SerializedTask is now strictly serialized​

SerializedTask 和 SerializedLink 类型现在仅描述 JSON 表单：

  • 日期字段（start_date、end_date、constraint_date、deadline、…）被标注为 string。在 9.x 版本中它们是 Date | string。
  • SerializedTask.id 现已可选。

如果你将应用数据（例如 store、种子数组、演示数据）定义为 SerializedTask[] 但实际用 Date 对象填充，它将导致编译器报错，例如 "Type 'Date' is not assignable to type 'string'"。

请选取与数据实际保存的类型匹配的类型：

  • Task / Link - 运行时对象，日期为 Date，并带有 $ 前缀的字段（这是 gantt.getTask() 返回的对象）。
  • SerializedTask / SerializedLink - 含 string 日期的 JSON（服务器交换、持久化 JSON）。
  • TaskInput - 你提供给 Gantt 的数据；日期可以是 Date 或 string，并且每个字段（包括 id）都是可选的。这通常是应用程序拥有的状态的正确类型。
// before v10 - SerializedTask accepted Date, so this compiled
const tasks: SerializedTask[] = [
    { id: 1, text: "Task #1", start_date: new Date(2026, 3, 1), duration: 5 }
];

// since v10 - use Task (Date dates), or TaskInput when the date form may vary
const tasks: TaskInput[] = [
    { id: 1, text: "Task #1", start_date: new Date(2026, 3, 1), duration: 5 }
];

TaskInput 是規範的輸入類型，取代了先前已棄用的 NewTask 別名（為了向後相容，仍然導出）。有關完整信息，請參閱資料模型

9.0 -> 9.1​

v9.1 不会引入重大变更，但若干配置选项已被标记为 弃用，并建议 迁移到新的统一格式。 另请注意，先前被弃用的 subscales 配置选项已被删除。

Unified auto scheduling configuration​

此前用于控制 "Automatische Terminplanung" 行为的多个属性已被弃用，取而代之的是统一的 auto_scheduling 配置对象。

// before v9.1
gantt.config.auto_scheduling = true;
gantt.config.auto_scheduling_compatibility = true;
gantt.config.auto_scheduling_strict = true;
gantt.config.auto_scheduling_initial = false;

// since v9.1
gantt.config.auto_scheduling = {
    enabled: true,
    apply_constraints: false,
    gap_behavior: "compress",
    schedule_on_parse: false
};

为保持向后兼容，这些已弃用的属性仍然可以使用，但建议切换到新的对象格式。

以下选项已弃用：

Mapping of deprecated configs to the unified object

  • gantt.config.auto_scheduling_initial -> schedule_on_parse
  • gantt.config.auto_scheduling_descendant_links -> descendant_links
  • gantt.config.auto_scheduling_move_projects -> move_projects
  • gantt.config.auto_scheduling_project_constraint -> project_constraint
  • gantt.config.auto_scheduling_use_progress -> use_progress
  • gantt.config.auto_scheduling_compatibility = true -> apply_constraints: false
  • gantt.config.auto_scheduling_compatibility = false -> apply_constraints: true
  • gantt.config.auto_scheduling_strict = true -> gap_behavior: "compress"
  • gantt.config.auto_scheduling_strict = false -> gap_behavior: "preserve"

The obsolete subscales configuration option is deleted​

请注意，在 v6.2 中被弃用的 subscales 配置选项已在 v9.1 中删除。

8.0 -> 9.0​

v9.0 更新引入了若干重大变更。

皮肤切换为 CSS 变量​

CSS 皮肤（主题）已完全重构，现在采用 CSS 变量实现。虽然组件的 HTML 结构和 CSS 类名大部分保持不变，但为旧版本 Gantt 编写的 CSS 样式在 v9.0 中可能无法如预期生效。

例如，以下样式用于根据任务优先级着色:

<style>
    /* 覆盖边框/进度颜色的通用样式 */
    .gantt_task_line{
        border-color: rgba(0, 0, 0, 0.25);
    }
    .gantt_task_line .gantt_task_progress {
        background-color: rgba(0, 0, 0, 0.25);
    }

    /* 高优先级 */
    .gantt_task_line.high {
        background-color: #03A9F4;
    }
    .gantt_task_line.high .gantt_task_content {
        color: #fff;
    }

    /* 中优先级 */
    .gantt_task_line.medium {
        background-color: #f57730;
    }
    .gantt_task_line.medium .gantt_task_content {
        color: #fff;
    }

    /* 低优先级 */
    .gantt_task_line.low {
        background-color: #e157de;
    }
    .gantt_task_line.low .gantt_task_content {
        color: #fff;
    }
</style>

从 v9.0 开始，可以使用以下样式实现相同效果:

<style>
    /* 高优先级 */
    .gantt_task_line.high {
        --dhx-gantt-task-background: #d96c49;
        --dhx-gantt-task-color: #fff;
    }

    /* 中优先级 */
    .gantt_task_line.medium {
        --dhx-gantt-task-background: #f57730;
        --dhx-gantt-task-color: #fff;
    }

    /* 低优先级 */
    .gantt_task_line.low {
        --dhx-gantt-task-background: #fff;
        --dhx-gantt-task-color: #fff;
    }
</style>

可在 스킨 커스터마이제이션 页面查看可用变量。

注释

迁移时很可能需要更新现有 CSS 以达到所需设计效果。

单一 CSS 文件​

所有主题现在都集成在一个 dhtmlxgantt.css 文件中。

如需激活特定皮肤，请使用 gantt.skin 属性:

gantt.skin = "material";

或使用 setSkin 方法:

gantt.setSkin("material");
注释

请注意，gantt.setSkin() 会重新渲染 Gantt。

如果你使用的是 terrace 以外的皮肤，迁移步骤如下:

  1. 替换皮肤的 CSS 文件为 dhtmlxgantt.css 文件:
<!-- 旧 -->
<link rel="stylesheet" href="./codebase/dhtmlxgantt_material.css" type="text/css">
<!-- 新 -->
<link rel="stylesheet" href="./codebase/dhtmlxgantt.css" type="text/css">
  1. 在 JavaScript 中启用所需皮肤:
gantt.setSkin("material");
gantt.init("gantt_here");

内置基线、截止日期和约束支持​

此前，添加基线需要通过 gantt.addTaskLayer API 手动实现。从 Gantt 9.0 起，已内置对基线实体、截止日期和任务约束的支持。

如果需要关闭默认设置，手动渲染基线和截止日期，可以使用相关配置项:baselines 与 deadlines:

// 禁用内置基线功能
gantt.config.baselines = false;

// 禁用内置截止日期功能
gantt.config.deadlines = false;

任务约束的内置显示也可通过扩展的 auto_scheduling 配置关闭:

gantt.config.auto_scheduling = {
  enabled: true, 
  show_constraints: false /*!*/
};

这样会关闭任务约束的默认显示，但仍保留自动调度功能。

时间线中的粘性标签​

自 v9.0 起，时间刻度标签默认为粘性。即标签在滚动时始终可见，直到自然滚动出视口。在旧版本中，标签居中显示在单元格内，滚动时不会保持可见。

如需恢复旧行为并禁用粘性标签，可将 scale 对象的 sticky 属性设为 false:

gantt.config.scales = [
  {unit: "year", step: 1, format: "%Y", sticky: false},
  {unit: "month", step: 1, format: "%F", sticky: false},
  {unit: "day", step:1, format: "%j", sticky: false}
];

Promise 实现​

Bluebird 库已从 Gantt 包中移除。Promise 现在使用原生 Promise 实现。

自 v9.0 起，resizeLightbox 方法已弃用并从 Gantt 代码中移除。现在 lightbox 的尺寸调整已自动实现，无需手动调用。 请注意，如果你的配置中包含 resizeLightbox() 方法，应将其移除以避免报错。

7.1 -> 8.0​

资源分配​

在早期版本的 DHTMLX Gantt 中，资源分配的变更作为任务对象的属性发送到后端，这在某些情况下使后端 API 集成变得更复杂。

从 DHTMLX Gantt v8.0 起，对资源及资源分配的变更可通过 dataProcessor 路由。详见 Routing CRUD actions of resources and resource assignments 部分。

导出服务​

自 v8.0 起，导入/导出功能已集成到 gantt 库中。

因此，如果你已在页面中包含 https://export.dhtmlx.com/gantt/api.js 以启用在线导出服务，例如:

<script src="codebase/dhtmlxgantt.js"></script>
<script src="https://export.dhtmlx.com/gantt/api.js"></script>

则需移除该文件，并通过 gantt.plugins 方法启用 export_api 扩展:

gantt.plugins({
    export_api: true
});

已弃用的类名​

自 v8.0 起，以下已弃用的类名被移除并替换为新的类名:

  • ".dhtmlx-info" -> ".gantt-info"
  • ".dhtmlx-error" -> ".gantt-info"
  • ".dhtmlx_popup_title" -> ".gantt_popup_title"
  • ".dhtmlx_popup_text" -> ".gantt_popup_text"
  • ".dhtmlx_popup_controls" -> ".gantt_popup_controls"
  • ".dhtmlx_ok_button" -> ".gantt_ok_button"
  • ".dhtmlx_click_me_button" -> ".gantt_click_me_button"
  • ".dhtmlx_popup_button" -> ".gantt_popup_button"
  • ".dhtmlx_modal_box" -> ".gantt_modal_box"
  • ".dhtmlx-" + config.type -> ".gantt-" + config.type
  • ".dhtmlx_" + btn.label.toLowerCase() + "button" -> **".gantt" + btn.label.toLowerCase() + "_button"**

7.0 -> 7.1​

7.1 版本未引入任何需要修改现有代码的重大变更。

里程碑渲染方式有细微视觉变化，如有需要可通过代码还原。对于使用资源面板的大型项目，由于资源分配新逻辑，可能会出现性能下降问题，可通过禁用不需要的逻辑进行优化。

里程碑​

与旧版本相比，里程碑元素的尺寸已更改，使其高度与常规条形一致。

如需让里程碑外观与旧版本一致，可通过 bar_height 属性调整里程碑元素高度:

{
    id:23, text:"Mediate milestone", start_date:"13-04-2018", 
    type:"milestone", parent:"15", bar_height: 35
}

资源分配​

7.1 版本为资源分配增加了复杂逻辑，允许指定资源分配的日期，并可通过 DataStore 操作资源分配。 该更改不会影响现有代码，但可能会对资源计算带来明显性能开销。

如果不需要为任务的特定日期分配资源，可通过 process_resource_assignments 配置关闭新功能以提升性能:

gantt.config.process_resource_assignments = false;

任务对象的新可选属性​

以下任务对象属性现在被 gantt 处理，并影响任务显示:

  • "task.row_height"
  • "task.bar_height"
  • "task.hide_bar"
  • "task.rollup"

如果你有同名的自定义属性，请重命名以避免冲突。

数据解析时的深拷贝​

Gantt 在 v6.3.2 到 v7.1 期间在数据解析时会深拷贝数据对象。

从 v7.1 起，该功能默认禁用。

可通过设置 gantt.config.deepcopy_on_parse 为 true 启用旧行为:

gantt.config.deepcopy_on_parse = true;

已弃用的配置项​

自 v7.1 起，gantt.config.task_height 属性已弃用。尽管该属性仍可用，且如指定会继续生效，建议使用新的 gantt.config.bar_height 选项:

gantt.config.bar_height = 50;

6.3 -> 7.0​

扩展和本地化文件​

最新的 v7.0 更新在 Gantt 包结构上有两项重要变更:

  1. 所有扩展文件现已与 dhtmlxgantt.js 文件打包在一起。 因此，如需激活 dhtmlxGantt 提供的任何扩展，需使用 API 调用。
  • 如果你已在页面中引入内置包中的扩展文件，例如:
<script src="../codebase/dhtmlxgantt.js"></script>
<script src="../codebase/ext/dhtmlxgantt_auto_scheduling.js"></script>

或

import "dhtmlx-gantt";
import "dhtmlx-gantt/ext/dhtmlxgantt_auto_scheduling";

则需移除扩展文件，并通过 gantt.plugins 方法启用扩展:

gantt.plugins({
   auto_scheduling: true
});

完整扩展列表见 此处。

  • 如果你使用的是修改过的扩展文件或自定义扩展，可像以前一样作为文件引入页面即可正常使用。

  • 注意，dhtmlxgantt_smart_rendering.js 和 dhtmlxgantt_csp.js 扩展已完全移除，无需手动启用。

  1. 所有本地化文件现已集成在 dhtmlxgantt.js 文件中。如需启用，可通过 API 调用。
  • 如果你在页面中引入了本地化文件，需将其移除，并通过 gantt.i18n.setLocale 启用所需语言:
gantt.i18n.setLocale("de");
  • 如使用自定义本地化文件，可继续按原方式加载。

工作时间默认设置变更​

7.0 之前的所有版本，默认工作时间为 8:00 至 17:00，即每天 9 小时。

从 v7.0 起，工作时间为 8:00-12:00, 13:00-17:00，即每天 8 小时。

如需恢复旧设置，请手动设置:

gantt.setWorkTime({hours: [8, 17]});

内容安全策略（Content Security Policy）​

ext/dhtmlxgantt_csp.js 扩展已被移除，不再需要。它已被默认启用的 csp config 替代；应将该扩展从 gantt 中移除。

由于 dhtmlxGantt 库新增了 csp 属性，所有 Gantt 元素将分配有效的 HTML5 属性，这些属性可在支持 HTML5 doctype 的任何浏览器中使用。

因此，建议将已有属性更新为新的属性:

不过，旧属性仍包含在标记中，因此如果不更改属性名称，您的代码仍可继续运行。

栅格单元格样式​

早期，栅格单元格的对齐方式通过 display:inline-block 实现。从 v7.0 开始，改为使用 display:flex，单元格位于 flex 容器内。

此更改不会影响用户可见的界面（保持完全一致），通常不会引发迁移问题。但如果栅格单元格样式出现回归，可能与此更新有关。

移除 "xml_date" 配置和模板，以及 "xml_format" 模板​

在 v6.2 已弃用的配置和模板，在 v7.0 被移除，并用新方案替代:

如果您代码中已定义旧名称，它们仍可继续使用。否则，请使用新版 API。

6.2 -> 6.3​

多任务选择​

自 v6.3 起，ext/dhtmlxgantt_multiselect.js 扩展自动允许同时水平拖动多个已选任务。 如需禁用该功能，请使用 drag_multiple 属性并将其设为 false（默认启用）。

gantt.config.drag_multiple = false;

Google Roboto 字体不再包含在 Material 皮肤中​

在 v6.3 之前，Google Roboto 字体通过 import 语句包含在 dhtmlxGantt 的 'Material' 皮肤 中。 自 v6.3 起，该导入已被移除，因此您需要手动添加 Roboto 字体:

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family="Open+Sans|Roboto:regular,medium,thin,bold"">

与 Require.JS 的配合使用​

早期，在基于 RequireJS 的应用中，dhtmlxGantt 库的不同文件可使用任意名称:

requirejs.config({
  paths: {
    "gantt": "../../codebase/dhtmlxgantt",
    "tooltip": "../../codebase/ext/dhtmlxgantt_tooltip",
    "marker": "../../codebase/ext/dhtmlxgantt_marker",
    "locale_de": "../../codebase/locale/locale_de",
  },
  shim: {
    "tooltip": ["gantt"],
    "marker": ["gantt"],
    "locale_de": ["gantt"],
  }
});
requirejs(["gantt", "tooltip", "marker", "locale_de"],
function (dhx) {
  var gantt = dhx.gantt;
 ...
});

自 6.3 起，模块名称必须根据 dhtmlxGantt 库的文件夹结构固定:

requirejs.config({
  paths: {
    "dhtmlxgantt": "../../codebase/dhtmlxgantt",
    "ext/dhtmlxgantt_tooltip": "../../codebase/ext/dhtmlxgantt_tooltip",
    "ext/dhtmlxgantt_critical_path": "../../codebase/ext/dhtmlxgantt_critical_path",
    "locale/locale_de": "../../codebase/locale/locale_de",
  },
  shim: {
    "ext/dhtmlxgantt_tooltip": ["dhtmlxgantt"],
    "ext/dhtmlxgantt_critical_path": ["dhtmlxgantt"],
    "locale/locale_de": ["dhtmlxgantt"],
  }
});
 
requirejs(["dhtmlxgantt", "ext/dhtmlxgantt_tooltip", "ext/dhtmlxgantt_critical_path", 
            "locale/locale_de"], 
function (dhx) {
  var gantt = dhx.gantt;
...
});

请确保包内任意文件的模块名为包中 codebase 文件夹内的相对路径加文件名，例如:

核心库:

  • "dhtmlxgantt": "./vendor/dhtmlxgantt/dhtmlxgantt"

扩展:

  • "ext/dhtmlxgantt_critical_path": "./vendor/dhtmlxgantt/ext/dhtmlxgantt_critical_path"
  • "ext/dhtmlxgantt_tooltip": "./vendor/dhtmlxgantt/ext/dhtmlxgantt_tooltip"

语言包:

  • "locale/locale_de": "./vendor/dhtmlxgantt/locale/locale_de"
  • "locale/locale_be": "./vendor/dhtmlxgantt/locale/locale_be"

内联编辑器​

在 6.3 之前，date 内联编辑器 的最小和最大值受时间轴可见日期限制，除非自定义了 min/max。

自 v6.3 起，日期编辑器默认不再有最小和最大值限制。

如需恢复旧行为，可指定动态 min/max 值:

const dateEditor = {type: "date", map_to: "start_date", 
  min: function(taskId){
    return gantt.getState().min_date
  },
  max: function( taskId ){
    return gantt.getState().max_date
  }
};

6.1 -> 6.2​

升级到 v6.2 通常与 v6.1 兼容，无需更改代码。 但部分组件行为已更改（可通过配置恢复旧行为），部分 API 已弃用。

智能渲染与静态背景​

智能渲染功能已更新并内嵌到组件中。现在主时间线区域和资源面板均支持。所有时间线仅渲染当前可见的行和单元格。

可通过 smart_rendering 配置禁用智能渲染，恢复 v6.1 的默认行为:

gantt.config.smart_rendering = false;

dhtmlxgantt_smart_rendering 扩展已不再需要，应从 gantt 中移除。该扩展仍包含在包内以防兼容性问题。 如果页面中添加了该扩展，gantt 会回退至 v6.1 的智能渲染模式。

static_background 配置的行为也已更新。从 v6.2 起，将渲染 PNG 背景以及通过模板函数附加了 CSS 类的所有单元格。

如需回退到 v6.1 行为，请使用 static_background_cells 配置:

gantt.config.static_background_cells = false;

时间轴设置​

时间轴配置已简化。无需为每个刻度分别指定多个配置项，现在只需用一项配置 [scales]，包含多个刻度对象及其设置。

以下时间轴 API 已弃用:

  • gantt.config.scale_unit
  • gantt.config.step
  • gantt.config.date_scale
  • gantt.templates.date_scale
  • gantt.config.subscales

例如，以下代码:

gantt.config.scale_unit = "day"; 
gantt.config.step = 1; 
gantt.config.date_scale = "%d %M"; 
gantt.templates.date_scale = null; 
gantt.config.subscales = [];

现在应写为:

gantt.config.scales = [ { unit:"day", step: 1, format: "%d %M"} ];

task_cell_class 模板重命名​

用于定义时间线区域单元格 CSS 类的模板已重命名:

重命名后的模板用法示例:

<style>
.weekend{ background: #f4f7f4 !important;}
</style>
 
gantt.templates.timeline_cell_class = function(task,date){
    if(date.getDay()==0||date.getDay()==6){
        return "weekend";
    }
};

"xml_date" 配置和模板，以及 "xml_format" 模板重命名​

以下为旧 API 的替换方案:

自 v6.2 起，xml_date 配置及 xml_date 和 xml_format 模板的默认值为 undefined。如果未为其赋值，则不会生效。

不过，Gantt 仍会继续支持这些旧名称，因此如果代码中重定义了这些 API，仍可正常工作。例如:

// 仍可正常工作
gantt.templates.xml_date = function(datestring){
    return new Date(datestring);
};

移除未使用的 API​

gantt.config.api_date 配置和 gantt.templates.api_date 模板已从 API 移除，因为 gantt 代码内部未使用。如果您的代码中有用到，请重新声明:

gantt.config.api_date = "%d-%m-%Y %H:%i";
gantt.templates.api_date = gantt.date.date_to_str(gantt.config.api_date);

6.0 -> 6.1​

时间约束和自动调度​

dhtmlxgantt_auto_scheduling.js 扩展已升级并支持 任务约束 功能。由于此功能会修改自动调度的默认行为， Gantt 支持兼容模式，可恢复原有行为，在自动调度时不考虑任务约束。

进入兼容模式，请使用以下配置项:

gantt.config.auto_scheduling_compatibility = true;

工具提示显示区域​

在6.1版本之前，工具提示 仅显示在甘特图的时间轴区域内。从v6.1版本开始，工具提示的显示不再受限，工具提示会跟随鼠标指针移动。

如有需要，可以在Gantt初始化前，通过以下代码恢复之前的行为:

gantt.attachEvent("onGanttReady", function(){
    var tooltips = gantt.ext.tooltips;
     tooltips.tooltip.setViewport(gantt.$task_data);
});

gantt.init("gantt_here");
gantt.parse(demo_tasks);

5.2 -> 6.0​

在6.0版本中，getSlack() 方法已废弃。新增了两个方法:

在v4.0中标记为废弃的方法在v6.0中已停止工作。dhtmlx 对象定义已从 dhtmlxgantt.js 中移除。

如果你仍在使用这些已废弃的方法，需要根据下表将其替换为支持的方法。方法的参数和行为没有变化。

废弃方法可用方法
dhtmlx.alertgantt.alert
dhtmlx.confirmgantt.confirm
dhtmlx.modalboxgantt.modalbox
dhtmlx.uidgantt.uid
dhtmlx.copygantt.copy
dhtmlx.mixingantt.mixin
dhtmlx.definedgantt.defined
dhtmlx.bindgantt.bind
dhtmlx.assertgantt.assert
window.dataProcessorgantt.dataProcessor

3.x -> 4.0​

4.0版本对公共API做了一些调整，主要包括:

  • 旧版模块以及与dhtmlxSuite模块重叠的模块不再由dhtmlxGantt库定义
  • 常用模块，如dhtmlxMessage、dataProcessor、Ajax被移至 window.gantt 命名空间，并成为dhtmlxGantt公共API的一部分

v4.x中包含了对旧API的兼容，因此为v3.3及更早版本编写的代码仍可继续使用。但在某些情况下需要做出调整。 通常，除 window.gantt 和 window.Gantt（仅限企业版）外的所有全局声明都已废弃，并将在5.0版本中移除。

废弃的API​

有些方法已被废弃。在v4.x中仍可使用，但每次调用时会在控制台发出警告（终端用户不可见）。

gantt_deprecated_warning

概述:

  • dhtmlxMessage模块已从 window.dhtmlx 对象移至 window.gantt 对象。更多关于消息框的信息见此处
  • dhtmlxDataProcessor 构造函数已从 window.dataProcessor 移至 window.gantt.dataProcessor
  • 工具方法如 dhtmlx.copy、dhtmlx.uid 和 dhtmlx.mixin 已移至 window.gantt 对象

如果你正在使用这些方法，升级到v4.0后应用仍可继续正常运行，无需立即调整。但建议后续升级为新版API。

完整的废弃方法列表如下:

3.3及以前版本4.0及以后版本
dhtmlx.alertgantt.alert
dhtmlx.confirmgantt.confirm
dhtmlx.modalboxgantt.modalbox
dhtmlx.uidgantt.uid
dhtmlx.copygantt.copy
dhtmlx.mixingantt.mixin
dhtmlx.definedgantt.defined
dhtmlx.bindgantt.bind
dhtmlx.assertgantt.assert
window.dataProcessorgantt.dataProcessor

废弃的API​

某些方法已被废弃，在v4.x中不再使用。 如果你仍在使用这些方法或对象，需要修改应用代码，或在页面中引入 dhtmlxgantt_deprecated.js 文件。

概述:

  • window.dhx4 不再由 dhtmlxgantt.js 定义
  • 之前定义在 window.dhx4 中的环境变量现在可以通过 gantt.env 对象获得
  • Ajax模块已从 dhx4.ajax 移至 gantt.ajax
  • 应使用 gantt.event、gantt.eventRemove 替代 dhtmlxEvent/dhtmlxDetachEvent

完整的废弃API列表如下:

3.3及以前版本4.0及以后版本
window.dhtmlxEventgantt.event
window.dhtmlxDetachEventgantt.eventRemove
window.dhx4.isIEgantt.env.isIE
window.dhx4.isIE6gantt.env.isIE6
window.dhx4.isIE7gantt.env.isIE7
window.dhx4.isIE8gantt.env.isIE8
window.dhx4.isOperagantt.env.isOpera
window.dhx4.isChromegantt.env.isChrome
window.dhx4.isKHTMLgantt.env.isKHTML
window.dhx4.isFFgantt.env.isFF
window.dhx4.isIPadgantt.env.isIPad

2.0 -> 3.0​

  1. 为避免与dhtmlxScheduler的CSS冲突，dhtmlxGantt中与lightbox相关的类名已全部重命名。 如果你自定义了lightbox的样式，迁移时需将类名更改为对应的新类名。

有两种重命名模式:

  • 将 '.dhx_gantt_' 替换为 '.gantt_'（如 .dhx_gantt_duration -> .gantt_duration）
  • 将 '.dhx_' 前缀替换为 '.gantt_'（如 .dhx_custom_button -> .gantt_custom_button）

如果在迁移CSS类名时遇到困难，请参见完整重命名类列表。

  1. buttons_right 和 buttons_left 配置项的默认值做了如下更改:
gantt.config.buttons_left = [
        "dhx_save_btn",
        "dhx_cancel_btn"
];
gantt.config.buttons_right = [
        "dhx_delete_btn"
],

*/}

gantt.config.buttons_left = [
        "gantt_save_btn",
        "gantt_cancel_btn"
];
gantt.config.buttons_right = [
        "gantt_delete_btn"
];

旧配置（"dhx_save_btn", "dhx_cancel_btn", "gantt_delete_btn"）仍然可用。此更改不会影响现有行为。

  1. 以下功能现在仅在商业版或企业版中提供（GPL版dhtmlxGantt不支持）:
  • 在周、月、时间轴视图中隐藏某些天的能力
  • 项目、里程碑及其他自定义类型

1.0 -> 2.0​

  1. 多种对象（GanttProjectInfo、GanttTaskInfo、GanttChart、GanttProject、GanttTask）被统一为一个静态对象--gantt。

gantt 对象包含一组方法和两个主要属性:config 和 templates。

  1. dhtmlxGantt 通过 init 方法初始化

var gantt = new GanttChart() -> gantt.init("gantt_div")。

  1. 现在数据以包含若干强制属性和任意自定义属性的普通对象数组存储，而不再使用GanttProject和GanttTask:
{
    data:[
        {id:1, text:"Project #2", start_date:"01-04-2013", duration:18,
    progress:0.4, open: true},
        {id:2, text:"Task #1",    start_date:"02-04-2013", duration:8,
    progress:0.6, parent:1},
        {id:3, text:"Task #2",    start_date:"11-04-2013", duration:8,
    progress:0.6, parent:1}
    ],
    links:[
        { id:1, source:1, target:2, type:"1"},
        { id:2, source:2, target:3, type:"0"},
        { id:3, source:3, target:4, type:"0"},
        { id:4, source:2, target:5, type:"2"},
  ]
}
  1. XML格式已更改，但旧XML格式仍可加载。
gantt.load("tasks.xml","oldxml");

Loading data in Gantt 1.6 format

  1. 设计时对象:
  1. 运行时对象:

dhtmlxGantt 2.0 不再区分项目和任务对象类型。现在，任何任务对象都可以有一个父对象和任意数量的子任务。

  • GanttProject
    • 以前的 getDuration()、getId()、getName()、getPercentCompleted()、getStartDate() 方法，现在通过 gantt.getTask(projectTaskId).(name_of_property) 访问
  • GanttTask
    • 以前的 getDuration()、getId()、getName()、getParentTaskId()、getPercentCompleted()、getPredecessorTaskId()、setDuration(, ) 方法，现在通过 gantt.getTask(taskId).(name_of_property) 访问

获取父/子对象的方法列表:

注释

父任务的id可通过 gantt.getTask(task_id).parent 获取。根元素没有 'parent' 属性。

Need help?
Got a question about the documentation? Reach out to our technical support team for help and guidance. For custom component solutions, visit the Services page.
Need more help?Contact Support