API overview
Gantt methods
| Name | Description |
|---|---|
| Promise | Promise 对象的构造函数 |
| addCalendar | 在甘特图中插入一个日历 |
| addLink | 添加一个新的依赖链接 |
| addLinkLayer | 在时间轴区域显示带有自定义元素的额外链接层 |
| addMarker | 向时间轴区域添加一个marker |
| addShortcut | 添加一个新的键盘快捷键 |
| addTask | 添加一个新任务 |
| addTaskLayer | 在时间线区域显示带有自定义任务元素的额外图层 |
| adjustTaskHeightForBaselines | 调整任务的行高以正确显示基线元素 |
| alert | 调用 alert 消息框 |
| assert | 如果给定的表达式为假,则在屏幕右上角以红色弹出框显示错误信息 |
| 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 | 显示一个 confirm 消息框 |
| copy | 创建给定对象的深拷贝 |
| correctTaskWorkTime | 根据工作时间重新计算任务持续时间 |
| createCalendar | 设置一个功能完整的日历 |
| createDataProcessor | 创建一个新的 dataProcessor 实例并将其链接到甘特图 |
| createDatastore | 基于给定配置创建一个datastore |
| createTask | 添加一个新任务并打开lightbox以确认 |
| dataProcessor | DataProcessor 构造函数 |
| dateFromPos | 获取图表区域内给定水平位置对应的日期 |
| defined | 当给定参数为 undefined 时返回 false,否则返回 true |
| deleteCalendar | 使用日历的 id 删除任务日历 |
| deleteLink | 移除指定的依赖链接 |
| deleteMarker | 删除指定的 marker |
| deleteTask | 删除指定的任务 |
| destructor | 清理 gantt 实例 |
| detachAllEvents | 从 dhtmlxGantt 中移除所有事件(包括自定义事件和内置事件) |
| detachEvent | 移除先前通过 attachEvent() 方法附加的事件处理程序 |
| eachParent | 遍历甘特图中指定任务的所有父任务 |
| 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 | 激活甘特图的focus |
| getCalendar | 通过其ID获取工作时间日历 |
| getCalendars | 获取当前所有已添加到甘特图中的日历 |
| getChildren | 获取指定父节点的直接子任务 |
| getClosestWorkTime | 返回最近的工作时间 |
| getColumnIndex | 根据列名返回该列的位置 |
| getConnectedGroup | 返回与特定任务连接的所有任务和链接 |
| getConstraintLimitations | 返回应用于任务的约束所允许的最早和最晚日期 |
| getConstraintType | 返回应用于任务的约束类型 |
| getDatastore | 返回数据存储的配置对象 |
| getFreeSlack | 返回任务的自由时差 |
| getGlobalTaskIndex | 查找任务在整个树结构中的位置 |
| getGridColumn | 获取特定列的配置对象 |
| getGridColumns | 获取甘特图的列 |
| getLabel | 获取 lightbox 中 select 控件的标签 |
| getLastSelectedTask | 提供最近一次选中任务的ID |
| getLayoutView | 通过名称获取布局视图对象 |
| getLightbox | 获取 lightbox 的 HTML 元素 |
| getLightboxSection | 返回 lightbox 中某个 section 的对象 |
| getLightboxType | 提供当前活动的 lightbox 结构的名称 |
| getLightboxValues | 从lightbox的各个section中获取值 |
| getLink | 使用给定的 id 获取依赖关系 link 对象 |
| 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 | 移除阻止与屏幕其他部分交互的lightbox modal覆盖层 |
| hideLightbox | 如果 lightbox 打开,则关闭它 |
| hideQuickInfo | 如果弹出任务表单当前已打开,则隐藏它 |
| importFromExcel | 将 Excel 文件转换为 JSON 格式 |
| importFromMSProject | 将 MS Project 的 XML 或 MPP 格式文件转换为 JSON |
| importfromprimaverap6 | 将 Primavera P6 的 XML 或 XER 文件转换为 JSON 格式 |
| init | 在指定的容器内设置一个 dhtmlxGantt |
| isChildOf | 确定一个任务是否是另一个任务的子任务 |
| isCircularLink | 验证链接是否为循环链接 |
| isCriticalLink | 判断给定的链接是否为关键路径链接 |
| isCriticalTask | 检查给定任务是否为关键任务 |
| isLinkAllowed | 检查指定的链接是否有效 |
| isLinkExists | 验证给定的链接是否存在 |
| isReadonly | 确定指定的任务、链接或整个甘特图是否设置为只读模式 |
| isSelectedTask | 检查指定的任务当前是否被选中 |
| isSplitTask | 判断指定任务是否为拆分任务 |
| isSummaryTask | 验证给定的任务是否为汇总任务 |
| isTaskExists | 验证是否存在具有指定 ID 的任务 |
| isTaskVisible | 确定指定任务当前是否显示在甘特图中 |
| isUnscheduledTask | 验证任务是否为未计划任务 |
| isWorkTime | 判断给定日期是否处于工作时间内 |
| load | 从外部源加载数据到甘特图中。 |
| locate | 根据给定的 HTML 事件检索任务的 id |
| mergeCalendars | 将多个工作日历合并为一个日历 |
| message | 打开指定类型的 message 框 |
| mixin | 将 'source' 对象的属性合并到 'target' 对象中 |
| modalbox | 打开一个 modalbox |
| moveTask | 将任务移动到不同的位置 |
| open | 打开由给定 id 标识的 branch |
| parse | 从客户端资源加载数据 |
| plugins | 启用指定的扩展插件 |
| posFromDate | 获取图表区域内指定日期的相对水平位置 |
| redo | 重新应用之前在gantt上撤销的更改 |
| refreshData | 刷新甘特图中的数据 |
| refreshLink | 更新指定的 link |
| refreshTask | 更新任务及其相关的链接 |
| removeLinkLayer | 移除与链接相关的指定图层 |
| removeShortcut | 移除键盘快捷键 |
| removeTaskLayer | 移除与任务相关的特定图层 |
| render | 绘制整个甘特图 |
| renderMarkers | 刷新页面上显示的所有标记 |
| resetLayout | 根据当前布局配置重建甘特图布局 |
| resetLightbox | 移除当前 lightbox 的 HTML 对象元素 |
| 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 | 在grid中对任务进行排序 |
| toggleTaskSelection | 切换指定任务的选择状态 - 如果任务未被选中,则选中它;如果任务已被选中,则取消选择 |
| uid | 返回一个唯一的id |
| undo | 撤销甘特图中的更改 |
| unselectTask | 从已选中的任务中移除选择 |
| unsetWorkTime | 在甘特图中移除工作时间设置 |
| updateCollection | 使用新的选项更新指定的 collection |
| updateLink | 更新指定的依赖链接 |
| updateMarker | 刷新指定的 marker |
| updateTask | 更新指定的任务 |
| updateTaskAssignments | 根据数据存储中当前的资源分配,更新任务对象的 resource 属性 |
Gantt properties
| Name | Description |
|---|---|
| auto_scheduling_compatibility | 关闭任务的时间约束使用 |
| auto_scheduling | 启用自动排程 |
| auto_scheduling_descendant_links | 控制是否允许从父任务(项目)创建到其子任务的链接 |
| auto_scheduling_initial | 定义甘特图在加载或解析数据时是否执行自动排程 |
| auto_scheduling_move_projects | 定义在调度过程中是否整个项目都会被移动(详情见下文) |
| auto_scheduling_project_constraint | 控制任务是否继承其父项目的约束类型 |
| auto_scheduling_strict | 开启自动调度模式,每次任务都会重新安排到最早的可能日期 |
| auto_scheduling_use_progress | 设置调度算法如何处理已完成的任务 |
| auto_types | 自动将包含子任务的任务切换为项目,并将没有子任务的项目转换回任务 |
| autofit | 自动调整 grid 的列宽以适应 grid 的宽度 |
| autoscroll | 允许甘特图在拖动任务 或链接超出浏览器可见区域时自动滚动 |
| autoscroll_speed | 定义当拖动任务或链接超出当前浏览器视图时,自动滚动的速度(以毫秒为单位) |
| autosize | 自动调整甘特图大小以显示所有任务,无需滚动 |
| autosize_min_width | 定义在使用水平 'autosize' 模式时,甘特图的最小宽度(以像素为单位) |
| bar_height | 定义时间轴区域内任务条的高度 |
| bar_height_padding | 控制当 bar_height 设置为 "full" 时,时间轴中任务条周围的间距 |
| baselines | 设置甘特图中 baselines 的工作方式 |
| branch_loading | 允许甘特图动态加载数据 |
| branch_loading_property | 表示任务有尚未从后端加载的子任务 |
| buttons_left | 保存位于 lightbox 左下角的一组按钮 |
| buttons_right | 保存位于 lightbox 右下角的一组按钮 |
| calendar_property | 设置用于将日历关联到任务或任务组的属性名称 |
| cascade_delete | 允许在删除父任务时自动删除嵌套的子任务和链接 |
| click_drag | 启用高级拖放功能 |
| columns | 设置表格中的columns |
| constraint_types | 包含所有可用的约束类型 |
| container_resize_method | 指定甘特图是否通过定时器间隔监控容器大小变化 |
| container_resize_timeout | 设置在容器大小调整后,甘特图重新绘制前的延迟时间(以毫秒为单位) |
| correct_work_time | 允许在拖动任务时调整任务的开始和结束日期,以适应工作时间内 |
| csp | 控制日期格式化方法在内部的实现方式 |
| date_format | 指定用于解析数据集中日期以及向服务器发送日期时所使用的日期格式 |
| date_grid | 设置表格中"开始时间"列所使用的日期格式 |
| date_scale | 设置时间刻度(X轴)的格式 |
| deadlines | 控制任务的 deadline 元素显示开关 |
| deepcopy_on_parse | 控制 gantt 是否对传入 gantt.parse() 方法的数据对象进行深拷贝 |
| details_on_create | 允许在点击"+"按钮创建新事件时,lightbox 自动打开。 |
| details_on_dblclick | 通过双击任务启用打开lightbox功能 |
| drag_lightbox | 允许通过 lightbox 的 header 来拖动 lightbox |
| drag_links | 允许通过拖放创建依赖链接 |
| drag_mode | 包含不同类型的拖放模式 |
| drag_move | 允许通过拖放操作重新定位任务 |
| drag_multiple | 允许同时拖动多个选中的任务 |
| drag_progress | 允许通过拖动进度旋钮来调整任务进度 |
| drag_project | 启用项目类型条目的拖放功能 |
| drag_resize | 允许通过拖放操作调整任务大小 |
| drag_timeline | 设置 drag_timeline 扩展的行为方式 |
| duration_step | 定义多少个单位的 'gantt.config.duration_unit' 组成 'duration' 数据属性的一个单位。 |
| duration_unit | 设置持续时间单位 |
| dynamic_resource_calendars | 允许自动将多个资源日历合并为一个日历 |
| editable_property | 修改一 个属性的名称,该属性控制在只读 Gantt 图中任务或链接是否可编辑 |
| editor_types | 一个包含内联编辑器定义的对象 |
| end_date | 定义时间刻度的结束点 |
| external_render | 将外部组件插入到 DOM 中 |
| fit_tasks | 告诉甘特图自动调整时间刻度以适应所有显示的任务 |
| grid_elastic_columns | 调整可滚动grid中列的宽度 |
| grid_resize | 允许通过拖动右侧边框来调整 grid 的大小 |
| grid_resizer_attribute | 指定用于 grid resizer 的 DOM 元素的属性名称 |
| grid_resizer_column_attribute | 指定用于列调整大小器DOM元素的属性名称。该属性表示列的索引 |
| grid_width | 设置 grid 的宽度 |
| highlight_critical_path | 在图表中高亮显示关键路径 |
| horizontal_scroll_key | 控制在使用 Shift、Alt 或 Meta 键结合鼠标滚轮时是否触发水平滚动 |
| inherit_calendar | 定义任务是否应继承其汇总父任务的工作日历 |
| inherit_scale_class | 控制子刻度是否默认使用 scale_cell_class 模板 |
| initial_scroll | 控制时间线区域是否初始滚动以显示最早的任务 |
| inline_editors_date_processing | 编辑任务的开始或结束日期时,保持任务的持续时间 |
| inline_editors_multiselect_open | 控制当多任务选择激活时,是否通过单击任务打开 inline editor |
| keep_grid_width | 在调整列宽时保持原始 grid 宽度不变 |
| keyboard_navigation | 启用甘特图中的键盘导航 |
| keyboard_navigation_cells | 允许通过单个单元格进行键盘导航 |
| layer_attribute | 定义任务层 DOM 元素的属性名称 |
| layout | 定义 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 | 定义调整 grid 大小时,每个 grid 列的最小宽度(以像素为单位) |
| 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 | 控制 gantt 容器是否阻止 mousewheel 事件,或允许其传播到 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 | 定义存储资源分配信息的数据存储名称 |
| resource_attribute | 定义 Gantt 用于识别资源网格或时间轴中任务行对应的资源的属性名称。 |
| resource_calendars | 提供了一种定义工作日历的方法,可以将其链接到特定资源,如用户 |
| resource_property | 定义任务对象中哪个属性保存与 resourceGrid/Timeline/Histogram/Calendar 关联的资源 ID |
| resource_render_empty_cells | 允许资源时间线为没有分配任务的单元格渲染元素并使用模板 |
| resource_store | 指定与 resourceGrid/resourceTimeline/resourceHistogram 视图关联的数据存储名称 |
| resources | 定义资源存储的附加设置 |
| root_id | 设置虚拟根元素的 id |
| round_dnd_dates | 允许将任务的开始和结束日期四舍五入到最接近的刻度标记 |
| row_height | 设置表格中行的默认高度 |
| rtl | 切换 gantt 到从右到左模式 |
| scale_height | 调整时间刻 度和grid header的高度 |
| 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 | 控制当 grid 为空时是否显示占位符 |
| show_errors | 当出现意外错误时,开启错误提醒 |
| show_grid | 控制甘特图中网格区域的可见性 |
| show_links | 控制甘特图中链接的显示开关 |
| show_markers |