API overview
Gantt methods
| Name | Description |
|---|---|
| Promise | Promise 对象构造函数 |
| addCalendar | 向 Gantt 中添加日历 |
| addLink | 添加一个新的依赖关系链接 |
| addLinkLayer | 在时间轴区域为链接显示一个带有自定义元素的附加层 |
| addMarker | 向时间线区域添加一个标记 |
| addShortcut | 添加一个新的键盘快捷键 |
| addTask | 添加一个新任务 |
| addTaskLayer | 在时间线区域为任务显示一个带自定义元素的附加图层 |
| adjustTaskHeightForBaselines | 调整任务的行高以正确显示基线元素 |
| alert | 调用一个警报消息框 |
| assert | 如果指定的表达式为假,则在屏幕右上角的红色弹出框中显示 errorMessage |
| attachEvent | 将处理程序附加到 dhtmlxGantt 的内部事件 |
| autoSchedule | 重新计算项目的进度安排 |
| batchUpdate | 一次性更新多个任务/链接 |
| bind | 在被调用时,将其 this 关键字设置为提供的值,从而返回一个新的函数 |
| calculateDuration | 计算任务的持续时间 |
| calculateEndDate | 计算任务的结束日期 |
| calculateTaskLevel | 计算任务的嵌套级别 |
| callEvent | 调用内部事件 |
| changeLightboxType | 根据任务的类型重新绘制该任务的 lightbox |
| changeLinkId | 更改链接的 ID |
| changeTaskId | 更改任务的 ID |
| checkEvent | 检查事件是否已指定一个或多个处理程序 |
| clearAll | 从甘特图中移除所有任务及附加元素(包括标记) |
| clearRedoStack | 清空存储的重做命令堆栈 |
| clearUndoStack | 清空存储的撤销命令栈 |
| close | 关闭具有指定 id 的分支 |
| collapse | 将甘特图从全屏模式折叠回普通模式 |
| columnIndexByDate | 根据日期返回列的索引 |
| confirm | 调用一个确认消息框 |
| copy | 创建提供对象的深拷贝 |
| correctTaskWorkTime | 在工作时间内重新计算任务的时长 |
| createCalendar | 创建一个工作日历 |
| createDataProcessor | 创建一个新的 dataProcessor 实例并将其附加到 gantt |
| createDatastore | 根据提供的配置创建 datastore |
| createTask | 添加一个新任务并 打开 lightbox 以确认 |
| dataProcessor | dataProcessor 构造函数 |
| dateFromPos | 获取图表区域中指定水平位置的日期 |
| defined | 当提供的参数未定义时返回 false,否则返回 true |
| deleteCalendar | 通过其 ID 删除任务日历 |
| deleteLink | 删除指定的依赖链接 |
| deleteMarker | 删除指定的标记 |
| deleteTask | 删除指定的任务 |
| destructor | 销毁 gantt 实例 |
| detachAllEvents | 从 dhtmlxGantt 解除所有事件(包括自定义和内部事件) |
| detachEvent | 从事件中分离一个处理程序(该事件之前通过 attachEvent() 方法附加) |
| eachParent | 遍历 Gantt 图中指定任务的所有父任务 |
| eachSelectedTask | 遍历甘特图中所有被选中的任务 |
| eachTask | 迭代指定任务的所有子任务,或遍历整个甘特图中的所有任务 |
| event | 给一个 HTML 元素附加一个事件处理程序 |
| eventRemove | 从 HTML 元素移除一个事件处理程序 |
| expand | 将甘特图扩展到全屏模式 |
| exportToExcel | 将甘特图中的数据导出到一个 Excel 文档 |
| exportToICal | 将甘特图数据导出为 iCal 字符串 |
| exportToJSON | 将甘特图的结构和数据导出为一个 JSON 对象 |
| exportToMSProject | 将甘特图中的数据导出到 MS Project |
| exportToPDF | 将甘特图导出为 PDF 格式 |
| exportToPNG | 将甘特图导出为 PNG 格式 |
| exporttoprimaverap6 | 将甘特图中的数据导出到 Primavera P6 |
| findCycles | 返回图表中的所有依赖环路 |
| focus | 将焦点设置在甘特图上 |
| getCalendar | 按 ID 获取工作时间日历 |
| getCalendars | 获取已添加到甘特图中的所有日历 |
| getChildren | 返回指定父分支的一级子任务 |
| getClosestWorkTime | 返回最近的工作时间 |
| getColumnIndex | 返回通过名称获取列的索引 |
| getConnectedGroup | 返回一个任务所连接的所有任务和链接 |
| getConstraintLimitations | 返回应用于任务的约束所允许的最早日期和最晚日期 |
| getConstraintType | 若应用于任务的约束类型 |
| getDatastore | 返回 datastore 的配置对象 |
| getFreeSlack | 返回任务的自由松弛时间 |
| getGlobalTaskIndex | 获取树状图中任务的索引 |
| getGridColumn | 获取列的配置对象 |
| getGridColumns | 获取甘特图的列 |
| getLabel | 在 lightbox 中获取 select 控件的标签 |
| getLastSelectedTask | 返回最后选中的任务的 ID |
| getLayoutView | 根据名称返回布局视图对象 |
| getLightbox | 获取灯箱的 HTML 对象元素 |
| getLightboxSection | 返回光箱分区的对象 |
| getLightboxType | 返回当前活动 lightbox 的结构名称 |
| getLightboxValues | 从值的各个中获取值 |
| getLink | 根据指定 ID 返回依赖链接对象 |
| getLinkCount | 返回在甘特图中显示的所有依赖链接的数量 |
| getLinkNode | 返回指定依赖链接的 HTML 元素 |
| getLinks | 返回在甘特图中显示的所有链接 |
| getMarker | 获取标记对象 |
| getNext | 返回下一个项的 id(无论嵌套层级是相同还是不同) |
| getNextSibling | 返回同一级别的下一个任务的 id |
| getParent | 返回父任务的 ID |
| getPrev | 返回前一个项的 id(无论嵌套层级是相同还是不同) |
| getPrevSibling | 返回同一级别的前一个任务的 ID |
| getRedoStack | 提供存储的重做用户操作堆栈 |
| getResourceAssignments | 返回分配给该资源的所有任务 |
| getResourceCalendar | 返回分配给资源的日历 |
| getScale | 返回时间刻度的配置 |
| getScrollState | 返回滚动位置 |
| getSelectedId | 返回所选任务的 id |
| getSelectedTasks | 返回当前选中的任务的数组 |
| getShortcutHandler | 获取一个键盘导航快捷键处理程序 |
| getSiblings | 返回指定任务的同级任务(包括自身) |
| getSlack | 检查在当前持续时间单位内,一个任务在开始影响其他任务之前还能剩余多少时间 |
| getState | 获取甘特图的当前状态 |
| getSubtaskDates | 计算嵌套在项目或其他任务中的任务的起始日期和结束日期的组合值 |
| getSubtaskDuration | 计算嵌套在项目或其他任务中的任务的总持续时间。 |
| getTask | 返回任务对象 |
| getTaskAssignments | 从数据存储中返回特定任务的解析资源分配 |
| getTaskBarHeight | 返回任务的 DOM 元素的高度(以像素为单位) |
| getTaskBaselines | 从数据存储中返回特定任务的基线数组 |
| getTaskBy | 根据指定 条件查找任务 |
| getTaskByIndex | 根据其全局任务索引返回一个任务 |
| getTaskByTime | 返回在指定时间段内发生的任务集合 |
| getTaskByWBSCode | 根据其 WBS 代码返回一个任务 |
| getTaskCalendar | 获取分配给指定任务的日历(任务级日历) |
| getTaskCount | 当前在甘特图中加载的任务数量 |
| getTaskHeight | 返回任务的可见高度 |
| getTaskIndex | 获取分支中任务的索引 |
| getTaskNode | 返回任务栏的 HTML 元素 |
| getTaskPosition | 计算任务的 DOM 元素在时间线区域的位置和大小 |
| getTaskResources | 从数据存储中返回分配给特定任务的唯一资源数组 |
| getTaskRowNode | 返回表格中任务行的 HTML 元素 |
| getTaskTop | 获取任务的 DOM 元素在时间线区域的顶部位置 |
| getTaskType | 返回任务的类型 |
| getTotalSlack | 返回任务的总松弛时间 |
| getUndoStack | 返回存储的撤销用户操作栈 |
| getVisibleTaskCount | 获取屏幕上可见任务的数量(那些未折叠的任务) |
| getWBSCode | 返回任务的 WBS 代码(大纲号) |
| getWorkHours | 返回指定日期的工作时间 |
| groupBy | 依据指定任务的属性对任务进行分组 |
| hasChild | 返回子任务的数量 |
| hideCover | 隐藏阻止剩余屏幕交互的灯箱模态覆盖层 |
| hideLightbox | 若灯箱当前处于活动状态,则关闭灯箱 |
| hideQuickInfo | 隐藏弹出式任务表单(如果当前处于活动状态) |
| importFromExcel | 将 Excel 文件转换为 JSON |
| importFromMSProject | 将一个 XML 或 MPP MS Project 文件转换为 JSON |
| importfromprimaverap6 | 将 XML 或 XER Primavera P6 文件转换为 JSON |
| init | 在一个容器中初始化一个 dhtmlxGantt |
| isChildOf | 检查一个任务是否是另一个任务的子任务 |
| isCircularLink | 检查链接是否为循环 |
| isCriticalLink | 检查指定链接是否为关键路径 |
| isCriticalTask | 检查指定任务是否为关键任务 |
| isLinkAllowed | 检查指定的链接是否正确 |
| isLinkExists | 检查指定链接是否存在 |
| isReadonly | 检查指定的任务/链接,或整个甘特图是否为只读 |
| isSelectedTask | 检查指定任务当前是否被选中 |
| isSplitTask | 检查指定任务是否已拆分 |
| isSummaryTask | 检查指定任务是否为汇总 |
| isTaskExists | 检查指定任务是否存在 |
| isTaskVisible | 检查指定任务当前是否在甘特图中呈现 |
| isUnscheduledTask | 检查任务是否未排程 |
| isWorkTime | 检查指定日期是否在工作时间内 |
| load | 从外部数据源将数据加载到甘特图 |
| locate | 从指定的 HTML 事件中获取任务的 ID |
| mergeCalendars | 将 多个工作日历合并为一个 |
| message | 调用指定类型的消息框 |
| mixin | 将 'source' 对象的属性添加到 'target' 对象中 |
| modalbox | 调用一个 modalbox |
| moveTask | 将任务移动到新位置 |
| open | 打开具有指定 ID 的分支 |
| parse | 从客户端资源加载数据 |
| plugins | 激活指定的扩展 |
| posFromDate | 在图表区域中获取指定日期的相对水平位置 |
| redo | 再次将撤销的修改应用到甘特图 |
| refreshData | 刷新甘特图中的数据 |
| refreshLink | 刷新指定的链接 |
| refreshTask | 刷新任务及其相关链接 |
| removeLinkLayer | 删除与链接相关的指定层 |
| removeShortcut | 移除一个快捷键 |
| removeTaskLayer | 移除与任务相关的指定图层 |
| render | 渲染整个甘特图 |
| renderMarkers | 更新页面上的所有标记 |
| resetLayout | 使用当前布局配置重新构建甘特图布局 |
| resetLightbox | 移除当前 lightbox 的 HTML object 元素 |
| resetProjectDates | 根据子任务的日期重新计算项目任务的持续时间 |
| resetSkin | 根据相关附带的 skin CSS 文件重新计算皮肤设置 |
| resizeLightbox | 强制将 lightbox 调整大小 |
| roundDate | 将指定日期四舍五入到时间刻度上的最近日期 |
| roundTaskDates | 将开始和结束任务的日期四舍五入到时间刻度中的最近日期 |
| scrollLayoutCell | 将布局视图滚动到指定位置 |
| scrollTo | 将 Gantt 容器滚动到指定位置 |
| selectTask | 选择指定的任务 |
| serialize | 将数据序列化为 JSON 或 XML 格式 |
| serverList | 返回一个选项列表 |
| setParent | 为任务设置父任务 |
| setSizes | 调整甘特图大小 |
| setSkin | 设置活动皮肤 |
| setWorkTime | 为甘特图设置工作时间 |
| showCover | 显示 lightbox 模态覆盖层,阻止与屏幕其他部分的交互 |
| showDate | 将图表区域滚动以使指定日期可见 |
| showLightbox | 打开指定任务的 lightbox |
| showQuickInfo | 显示指定任务的弹出任务表单 |
| showTask | 使指定的任务在屏幕上可见 |
| silent | 使其中的所有代码不触发内部事件或服务器端调用 |
| sort | 将网格中的任务排序 |
| toggleTaskSelection | 选择指定的任务(如果未被选中则选中,若已选中则取消选中) |
| uid | 返回一个唯一的 id |
| undo | 撤销对甘特图所做的更改 |
| unselectTask | 从所选任务中取消选中状态 |
| unsetWorkTime | 在甘特图中取消工作时间的设定 |
| updateCollection | 使用新选项更新指定的集合 |
| updateLink | 更新指定的依赖关系链接 |
| updateMarker | 更新指定的标记 |
| updateTask | 更新指定的任务 |
| updateTaskAssignments | 使用数据存储中的资源分配值更新任务对象的 resource 属性 |
Gantt properties
| Name | Description |
|---|---|
| auto_scheduling_compatibility | 禁用任务的时间约束 |
| auto_scheduling | 启用自动排程 |
| auto_scheduling_descendant_links | 允许或禁止从父任务(项目)向其子任务创建链接 |
| auto_scheduling_initial | 定义 gantt 在数据加载/解析时是否执行自动排程 |
| auto_scheduling_move_projects | 定义是否会移动整个项目(请参见下方的详细信息) |
| auto_scheduling_project_constraint | 定义任务是否应从其父项目继承约束类型 |
| auto_scheduling_strict | 启用自动排程模式,在该模式下,任务将始终被 重新排程到最早可用日期 |
| auto_scheduling_use_progress | 设置调度算法处理已完成任务的方式 |
| auto_types | 自动将带有子任务的任务转换为项目,且没有子任务的项目转换回任务 |
| autofit | 启用根据网格宽度自动调整网格列宽 |
| autoscroll | 启用在拖动任务或将链接拖出当前浏览器屏幕时的自动滚动 |
| autoscroll_speed | 在拖动任务或链接离开当前浏览器屏幕时,定义 autoscroll_speed 的滚动速度(单位:毫秒) |
| autosize | 强制甘特图自动调整大小以显示所有任务且无需滚动 |
| autosize_min_width | 设置 Gantt 图在水平 'autosize' 模式下可占用的最小宽度(以像素为单位) |
| bar_height | 设置时间线区域任务条的高度 |
| bar_height_padding | 当 bar_height 设置为 "full" 时,调整时间线中任务条周围的填充 |
| baselines | 配置 baselines 在甘特图中的功能 |
| branch_loading | 在甘特图中启用动态加载 |
| branch_loading_property | 指定任务具有尚未从后端加载的子项 |
| buttons_left | 存储在灯箱左下角的按钮集合 |
| buttons_right | 在 lightbox 的右下角驻留的一组按钮集合 |
| calendar_property | 改变影响日历绑定到一个任务或一组任务的属性名称 |
| cascade_delete | 启用嵌套任务和链接的级联删除 |
| click_drag | 启用高级拖拽 |
| columns | 配置表格的列 |
| constraint_types | 包含所有可用的约束类型 |
| container_resize_method | 定义甘特图是否应在时间间隔内跟踪容器的调整大小 |
| container_resize_timeout | 指定在调整容器大小时重新绘制甘特图之前的延迟时间(以毫秒为单位) |
| correct_work_time | 在拖动时将任务的开始和结束日期调整到工作时间 |
| csp | 定义日期格式化方法的内部实现代码 |
| date_format | 设置用于从数据集解析数据并将日期发送回服务器的日期格式 |
| date_grid | 设置表格中“Start time”列日期的格式 |
| date_scale | 设置时间刻度(X 轴)的格式 |
| deadlines | 启用或禁用任务截止日期元素的显示 |
| deepcopy_on_parse | 定义 gantt 是否在将数据对象传入到 gantt.parse() 方法时执行深拷贝 |
| details_on_create | 允许在点击"+"按钮创建新事件时,lightbox 自动打开。 |
| details_on_dblclick | 'says' 在双击任务后打开 lightbox |
| drag_lightbox | 通过头部实现对 lightbox 的拖动能力 |
| drag_links | 通过拖放创建依赖关系链接 |
| drag_mode | 存储可用拖拽模式的类型 |
| drag_move | 允许通过拖放操作重新定位任务 |
| drag_multiple | 允许一次拖动多个已选任务 |
| drag_progress | 通过拖动进度旋钮来改变任务进度的能力 |
| drag_project | 启用项目类型项的拖放 |
| drag_resize | 通过拖放实现对任务大小的调整 |
| drag_timeline | 配置 drag_timeline 扩展的行为 |
| duration_step | 设置与一个 'duration' 数据属性单位相对应的 'gantt.config.duration_unit' 单位数量。 |
| duration_unit | 设置持续时间单位 |
| dynamic_resource_calendars | 启用将多个资源日历自动合并为一个 |
| editable_property | 更改在只读甘特图中影响任务/链接编辑能力的属性名称 |
| editor_types | 一个包含内联编辑器定义的对象 |
| end_date | 设置时间刻度的结束值 |
| external_render | 将外部组件渲染到 DOM 中 |
| fit_tasks | "'says' 的 Gantt 图表会自动扩展时间刻度以适应显示的所有任务" |
| grid_elastic_columns | 调整滚动网格中列的宽度 |
| grid_resize | 通过拖动右侧网格的边框使网格可调整大小 |
| grid_resizer_attribute | 设置 grid resizer 的 DOM 元素属性名称 |
| grid_resizer_column_attribute | 设置列调整器的 DOM 元素的属性名。该属性表示列的索引 |
| grid_width | 设置网格的宽度 |
| highlight_critical_path | 显示图表中的关键路径 |
| horizontal_scroll_key | 通过 Shift |
| inherit_calendar | 定义任务是否应从其汇总父任务继承工作日历 |
| inherit_scale_class | 指定子刻度默认是否使用 scale_cell_class 模板 |
| initial_scroll | 设置时间线区域在初始时是否滚动以显示最早的任务 |
| inline_editors_date_processing | 在编辑任务的开始时间和结束时间时,保持任务持续时间不变 |
| inline_editors_multiselect_open | 定义在启用多任务选择时,一次单击任务后是否应打开内联编辑器 |
| keep_grid_width | 'says' 用于在调整列宽时保持初始网格宽度 |
| keyboard_navigation | 在甘特图中启用键盘导航 |
| keyboard_navigation_cells | 通过单元格启用键盘导航 |
| layer_attribute | 设置任务图层的 DOM 元素属性名称 |
| layout | 指定布局对象 |
| lightbox | 指定 lightbox 对象 |
| lightbox_additional_height | 增加 lightbox 的高度 |
| link_arrow_size | 设置链接箭头的大小 |
| link_attribute | 设置将用于指定链接的 HTML 元素的 id 的属性名 |
| link_line_width | 设置时间轴区域中依赖关系连线的宽度 |
| link_radius | 设置时间轴中链接线拐角的圆角半径 |
| link_wrapper_width | 设置链接上方可点击区域的宽度 |
| links | 存储链接依赖的类型 |
| min_column_width | 设置时间轴区域中列的最小宽度 |
| min_duration | 设置在调整大小期间可以为任务设定的最小持续时间(以毫秒为单位)。 |
| min_grid_column_width | 在调整网格大小时,为每个网格列设置最小宽度(以像素为单位) |
| min_task_grid_row_height | 设置在调整大小时可以为任务设置的最小行高 |
| multiselect | 启用/禁用甘特图中的多任务选择 |
| multiselect_one_level | 控制多任务选择是否限制在单一级别,还是可以跨多个级别 |
| open_split_tasks | 启用通过单击 +/- 按钮展开/折叠拆分任务的功能 |
| open_tree_initially | 初始时展开所有分支 |
| order_branch | 激活 'branch' 模式,允许在同一树级别内垂直重新排序任务 |
| order_branch_free | 启用允许在整个甘特图中重新排序任务的 'branch' 模式 |
| placeholder_task | 在任务列表末尾添加一个空行,以简化通过键盘编辑任务 |
| preserve_scroll | 在重新绘制甘特图时,保留纵向和横向滚动条的当前位置 |
| prevent_default_scroll | 指定甘特图容器是否应阻止鼠标滚轮事件,还是应将该事件向上传递至 window 元素 |
| process_resource_assignments | 启用/禁用资源分配的解析 |
| project_end | 指定项目的结束日期 |
| project_start | 指定项目的开始日期 |
| quick_info_detached | 定义任务表单将从屏幕的左侧/右侧弹出,还是在所选任务附近显示 |
| quickinfo_buttons | 在弹出任务详情表单中存放一组按钮 |
| readonly | 将甘特图置于只读模式 |
| readonly_property | 更改影响任务/链接只读行为的属性名称 |
| redo | 启用甘特图的 Redo 功能 |
| reorder_grid_columns | 允许通过拖放来重新排序 grid 列 |
| resize_rows | 通过拖拽调整行高的能力 |
| resource_assignment_store | 指定用于存储资源分配的 dataStore 的名称 |
| resource_attribute | 定义 Gantt 用于识别资源网格或时间轴中任务行对应的资源的属性名称。 |
| resource_calendars | 定义一组可以分配给特定资源(如用户)的工作日历 |
| resource_property | 定义 task 对象中存储与 resourceGrid/Timeline/Histogram/Calendar 相关的资源 ID 的属性 |
| resource_render_empty_cells | 指示资源时间线为未分配的单元格渲染元素并调用模板 |
| resource_store | 指定与 resourceGrid/resourceTimeline/resourceHistogram 视图相连的数据存储的名称 |
| resources | 定义资源存储的额外配置 |
| root_id | 设置虚拟根元素的 ID |
| round_dnd_dates | 启用将任务的开始和结束日期四舍五入到最近的刻度标记 |
| row_height | 设置表格行的默认高度 |
| rtl | 将甘特图切换为从右到左模式 |
| scale_height | 设置时间刻度和网格表头的高度 |
| scale_offset_minimal | 将最小刻度单位(在使用多条刻度时)设为前导/尾部空白区间的间隔 |
| scale_unit | 设置时间刻度的单位(X 轴) |
| scales | 定义时间刻度的配置设置 |
| schedule_from_end | 启用向后排程 |
| scroll_on_click | 指定在选择并显示所选任务时,时间轴区域是否应滚动 |
| scroll_size | 设置垂直(宽度)和水平(高度)滚动条的尺寸 |
| select_task | 在甘特图中启用任务选择 |
| server_utc | 允许在与服务器交换数据时,将服务器端日期在 UTC 和本地时区之间转换 |
| show_chart | 显示甘特图的时间线区域 |
| show_empty_state | 定义在网格为空时是否显示占位元素 |
| show_errors | 在出现意外行为时启用显示错误警报 |
| show_grid | 显示甘特图的网格区域 |
| show_links | 启用/禁用在甘特图中显示连线 |
| show_markers | 显示/隐藏页面上的标记 |
| show_progress | 在任务条内部显示进度 |
| show_quick_info | 激活/禁用 'quick_info' 扩展(弹出任务详情表单) |
| show_task_cells | 启用/禁用在图表区域显示列边框 |
| show_tasks_outside_timescale | 启用在甘特图中显示超出指定日期范围的任务 |
| show_unscheduled | 启用显示未排程的任务 |
| skip_off_time | 在时间刻度中隐藏非工作时间 |
| smart_rendering | 启用甘特图的任务和连线渲染的智能渲染模式 |
| smart_scales | 指定在屏幕上仅呈现时间刻度的可见部分 |
| sort | 启用表格中的排序 |
| start_date | 设置时间刻度的起始值 |
| start_on_monday |