跳到主要内容

API overview

Gantt methods

NameDescription
PromisePromise 对象的构造函数
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以确认
dataProcessorDataProcessor 构造函数
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

NameDescription
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控制页面上标记的可见性
show_progress允许在任务栏内显示进度
show_quick_info开启或关闭 'quick_info' 扩展(显示任务详情的弹出窗口)
show_task_cells控制图表区域中列边框的显示与隐藏
show_tasks_outside_timescale允许在甘特图上显示超出定义日期范围的任务
show_unscheduled允许切换未排程任务的可见性
skip_off_time隐藏时间刻度中的非工作时间
smart_rendering激活 smart rendering 模式以显示 gantt 的任务和链接
smart_scales指定仅在屏幕上绘制时间刻度的可见部分
sort允许在表格中进行排序
start_date定义时间刻度的起始点
start_on_monday设置一周的起始天
static_background为时间线部分创建背景图像,而不是直接绘制列和行的线条
static_background_cells允许在使用 static_background 模式时渲染高亮单元格
step定义时间刻度(X轴)的增量
task_attribute定义用于指定任务HTML元素id的属性名称
task_date定义在 lightbox 的"时间段"部分显示的日期标签格式
task_grid_row_resizer_attribute定义用于网格行调整大小器DOM元素上的属性名称,表示该行的索引
task_height控制时间线区域中任务条的高度
task_scroll_offset定义时间轴左边缘与最近任务之间的偏移量(以像素为单位)
time_picker定义 lightbox 中时间下拉选择器的格式
time_step设置任务时间值的最小步长(以分钟为单位)
timeline_placeholder当timeline为空时显示背景grid
tooltip_hide_timeout设置 tooltip 在消失前保持可见的时间,单位为毫秒
tooltip_offset_x当设置为正值时,调整tooltip水平偏移量,使其向右移动
tooltip_offset_y调整tooltip垂直方向的位置偏移,正值会使tooltip向下移动
tooltip_timeout指定任务tooltip出现前的延迟时间,单位为毫秒
touch控制甘特图是否启用或禁用 touch 支持
touch_drag设置区分长按手势与滚动手势的时间周期,单位为毫秒
touch_feedback在触摸设备上启用拖放操作前或后的振动反馈
touch_feedback_duration指定触摸设备上拖放操作前后振动反馈持续的时间(以毫秒为单位)
type_renderers重新定义负责显示不同类型任务的函数
types存储 lightbox 结构的名称(用于不同类型的任务)
undo启用 gantt 的 Undo 功能
undo_actions定义 Undo 功能将要撤销的操作
undo_steps指定 undo 方法将回滚的步骤数
undo_types设置撤销操作将影响的实体类型
wai_aria_attributes启用 WAI-ARIA 支持,使组件能够被屏幕阅读器正确识别
wheel_scroll_sensitivity控制使用鼠标滚轮时甘特图滚动的速度
wide_form将区块及其标签并排放置在同一行
work_time根据工作时间而非日历时间计算任务持续时间
xml_date指定用于从数据集解析数据和向服务器发送数据的日期格式

Gantt events

NameDescription
onAfterAutoSchedule当自动排程过程完成时触发。
onAfterBatchUpdatebatchUpdate 方法完成后立即触发
onAfterBranchLoading当启用动态加载时,此事件在任务分支加载完成后立即触发。
onAfterLightbox当用户关闭 lightbox(编辑表单)时触发
onAfterLinkAdd在甘特图中添加新链接后立即触发
onAfterLinkDelete当用户删除链接后立即触发
onAfterLinkUpdate用户修改链接后立即触发
onAfterQuickInfo在弹出编辑表单关闭后触发
onAfterRedo在 redo() 方法执行完毕后立即触发
onAfterRowResize在行高度调整完成后触发
onAfterSort当 grid 中的任务排序完成后触发
onAfterTaskAdd在任务添加到甘特图后立即触发
onAfterTaskAutoSchedule触发每个被自动调度的任务
onAfterTaskDelete在用户删除任务后立即触发
onAfterTaskDrag当用户完成拖拽并释放鼠标按钮时触发
onAfterTaskMove在任务被移动到新的垂直位置后立即触发
onAfterTaskUpdate在用户更新任务后立即触发
onAfterUndo在执行 undo() 方法后立即触发
onAjaxError当服务器响应错误时触发
onAutoScheduleCircularLink在自动排程过程中检测到依赖循环时触发
onBeforeAutoSchedule在自动排程开始之前触发
onBeforeBatchUpdatebatchUpdate 方法执行之前触发
onBeforeBranchLoading当启用动态加载时,该事件在用户展开任务分支后且加载过程开始前触发。
onBeforeCollapse在甘特图退出全屏模式并返回普通视图之前触发
onBeforeDataRender在数据展示到页面之前触发
onBeforeExpand在甘特图切换到全屏模式之前触发
onBeforeGanttReady在 dhtmlxGantt 初始化开始之前触发
onBeforeGanttRender在甘特图渲染到页面之前触发
onBeforeLightbox在 lightbox(编辑表单)打开之前触发
onBeforeLinkAdd在甘特图中新链接添加之前触发
onBeforeLinkDelete在用户删除链接之前触发
onBeforeLinkDisplay在链接加载到甘特图中后、但显示到屏幕上之前触发
onBeforeLinkUpdate在链接更新之前触发
onBeforeMultiSelect在选择一个或多个任务之前触发
onBeforeParse在数据解析开始之前触发
onBeforeRedo在 redo() 方法执行之前触发
onBeforeRedoStack在操作被推入重做栈之前触发
onBeforeRollupTaskDisplay在汇总任务显示于其父项目之前触发
onBeforeRowDragEnd当用户在grid中拖放一行时触发。
onBeforeRowDragMove在网格中某行垂直拖动到新位置之前触发
onBeforeRowResize当用户开始通过拖拽调整行高之前触发
onBeforeRowResizeEnd在行高度调整过程完成之前触发
onBeforeSplitTaskDisplay在拆分任务的某个分段出现在甘特图上之前触发
onBeforeTaskAdd在向甘特图添加新任务之前触发
onBeforeTaskAutoSchedule触发于每个被重新安排时间的任务
onBeforeTaskChanged在用户完成拖拽并释放鼠标按钮后触发,但在任何更改应用之前触发
onBeforeTaskDelete在用户删除任务之前触发
onBeforeTaskDisplay任务加载到甘特图中后,且显示之前触发
onBeforeTaskDrag当用户按下鼠标按钮并开始拖动时立即触发,但在 dhtmlxGantt 开始拖放过程之前。
onBeforeTaskMove在任务垂直位置变化之前触发
onBeforeTaskMultiSelect在任务的选择状态即将改变时触发(当任务即将被选中或取消选中时)。
onBeforeTaskSelected在任务被选中之前触发
onBeforeTaskUpdate在用户更新任务之前触发
onBeforeUndo在 undo() 方法执行之前触发
onBeforeUndoStack在操作被推入撤销栈之前触发。
onCircularLinkError当检测到循环引用且自动排程无法继续时触发
onClear当通过 clearAll 方法从甘特图中移除所有任务时触发一次
onCollapse当甘特图视图从全屏模式切换回普通模式时触发。
onColumnResize当用户拖动列边界调整列宽时触发
onColumnResizeEnd当用户拖动列边界调整宽度完成时触发
onColumnResizeStart在用户开始拖动列边界调整列宽之前触发
onContextMenu当用户在甘特图内右键点击时触发(详见说明)
onDataProcessorReady当调用 dp.init(gantt) 时触发
onDataRender数据在页面上显示后立即触发
onDestroy当通过 destructor 方法清除甘特图后触发一次
onEmptyClick当用户点击甘特图中空白区域(任务之外)时触发
onErrorassert 返回 'false' 值时触发,表示断言未通过。
onExpand当甘特图切换到全屏模式时触发
onGanttLayoutReady当甘特图布局设置完成但尚未渲染时触发
onGanttReady当 dhtmlxGantt 完成初始化时触发,尽管甘特图本身尚未显示在页面上
onGanttRender当甘特图在页面上完成渲染时触发
onGanttScroll当甘特图滚动到特定位置时触发
onGridHeaderClick当用户点击 grid 表头时触发
onGridResize当用户拖动grid边框调整其大小时触发
onGridResizeEnd用户拖动grid边界调整大小后立即触发的事件
onGridResizeStart在用户开始拖动grid边界调整大小之前触发
onLightbox当用户打开 lightbox(编辑表单)时触发一次
onLightboxButton当用户点击 lightbox 内的自定义按钮时触发
onLightboxCancel当用户在lightbox中按下"取消"按钮时触发
onLightboxChange当 lightbox 结构更新时触发
onLightboxDelete当用户点击 lightbox 中的"删除"按钮时触发
onLightboxSave当用户点击 lightbox 中的"保存"按钮时触发
onLinkClick当用户点击链接时触发
onLinkCreated当用户在任务之间建立新连接时触发
onLinkDblClick当链接被双击时触发
onLinkIdChange当链接的 id 更新时触发
onLinkValidation当用户添加新链接时触发,dhtmlxGantt 会验证该链接是否有效
onLoadEnd当数据从源完全加载完成时触发
onLoadStart在从数据源开始加载数据之前触发
onMouseMove当鼠标在甘特图容器上移动时触发
onMultiSelect当选中一个或多个任务完成时触发
onOptionsLoad在从服务器加载一组选项后立即触发,但在解析它们之前触发
onParse当数据解析完成(准备好供API使用)但尚未显示在甘特图中时触发
onQuickInfo当弹出编辑表单显示时触发
onRowDragEnd当用户在grid中垂直重新排序并放下某一行后触发
onRowDragStart在网格中某行被拖动进行垂直重排之前触发
onRowResize当用户拖动行边界以更改其高度时触发
onScaleAdjusted当比例尺重新渲染以确保所有任务完全可见时触发
onScaleClick当用户点击时间刻度中的单元格时触发
onTaskClick当用户点击网格区域中的任务行(包括"展开/折叠"和"添加任务"按钮)或时间轴区域内的任务条时触发。
onTaskClosed当一个分支被关闭时触发
onTaskCreated当用户通过点击 grid 中的 '+' 按钮添加新任务,或调用 createTask 方法时触发
onTaskDblClick当任务被双击时触发
onTaskDrag当用户拖动任务时触发
onTaskIdChange当任务的ID被更新时触发
onTaskLoading当任务从数据源加载时触发。
onTaskMultiSelect当任务的选中状态发生变化时触发(任务被选中或取消选中时)
onTaskOpened当分支被打开时触发
onTaskRowClick当用户点击表格中的某一行时触发
onTaskSelected当用户选择一个任务时触发
onTaskUnselected当用户通过选择其他任务取消选中某个任务时触发
onTemplatesReady当 dhtmlxGantt 模板初始化完成时触发

Gantt templates

NameDescription
baseline_text定义显示在 baseline 元素内部的文本内容
date_grid定义在显示日期(返回 Date 值)的列中展示的内容,这些列位于 grid 中
drag_link_class定义当用户拖动链接时显示的弹出窗口所应用的CSS类。
drag_link定义在创建新依赖链接时显示的tooltip文本
format_date将日期对象转换为日期字符串。这在向服务器发送数据时非常有用。
grid_blank定义在树形列中子项标签之前显示的自定义内容
grid_date_format定义在显示日期值的列中日期的显示方式(返回Date值)
grid_file定义树状列中子项的图标
grid_folder定义树形列中父项使用的图标
grid_header_class定义将分配给表格列标题的CSS类
grid_indent控制树形列中分支内子项的缩进
grid_open指定用于树形列中展开/关闭指示图标的图标
grid_row_class定义分配给 grid 行的 CSS 类
histogram_cell_allocated指定 resourceHistogram 中填充部分的高度
histogram_cell_capacity定义表示资源可用容量的线条高度
histogram_cell_class定义应用于资源面板单元格的CSS类
histogram_cell_label定义显示在单元格内的标签
leftside_text定义显示在任务条左侧的文本
lightbox_header指定 lightbox 的 header 部分
link_class定义分配给链接的CSS类
link_description设置链接"删除"确认窗口头部显示的文本
marker_class定义分配给 markers 的 CSS 类
parse_date将日期字符串转换为 Date 对象
progress_text定义任务条中已完成部分显示的文本
quick_info_class定义应用于弹出编辑表单的CSS类
quick_info_content定义弹出编辑表单中显示的内容
quick_info_date设置弹出编辑表单中显示的日期
quick_info_title设置弹出编辑表单的标题
resource_cell_class定义资源时间线视图中单元格的CSS类名
resource_cell_value设置资源时间线中单元格的HTML内容
rightside_text定义任务条右侧显示的文本
scale_cell_class定义将分配给时间线区域时间刻度中单元格的CSS类
scale_row_class定义应用于时间刻度的 CSS 类
task_class定义应用于任务条的 CSS 类
task_date定义用于 lightbox 中"Time period"部分标签的日期格式
task_end_date控制任务结束日期在lightbox中的显示方式
task_row_class指定应用于timeline区域行的CSS类
task_text设置显示在任务条和lightbox标题中的文本
task_time定义在lightbox标题中显示的日期范围
task_unscheduled_time指定未计划任务的日期
timeline_cell_class定义应用于 timeline 区域单元格的 CSS 类
timeline_cell_content允许在 timeline 单元格内指定自定义 HTML 内容
time_picker定义 lightbox 中下拉时间选择器使用的格式
tooltip_date_format定义开始和结束日期在tooltip中的显示格式
tooltip_text设置在tooltip中显示的文本
xml_date此模板用于将 XML 文件中的字符串根据指定格式转换为日期对象。
xml_format将日期对象转换为符合此模板的字符串。此方法用于将数据发送回服务器。

Gantt others

NameDescription
$click更改甘特图中按钮的默认点击操作
ajaxGantt ajax 模块
calendar工作日历对象的接口
config定义日期、刻度、控件的配置选项
constants保存各种常量,避免在代码中使用魔法数字
dataprocessor一组 dataprocessor 方法
datastore一组 datastore 方法的集合
date一组日期格式化工具集合
env一组标志,用于指示当前环境
ext一个包含多种扩展功能的对象
form_blocks一个包含 lightbox 控件的对象
i18n一组用于本地化甘特图的方法集合
ignore_time在时间刻度中隐藏某个时间单位
json处理 JSON 序列化和解析
keys定义甘特图的快捷键
license返回 dhtmlxGantt 的 license 名称
locale当前使用的 locale 对象,包含甘特图的区域特定标签
oldxml处理 dhtmlxGantt 1.0 中 XML 格式的序列化和解析
skin提供当前应用于甘特图的 skin
skins提供可用的 skin 对象
templates设置甘特图中日期、标题和tooltip的格式化templates
treeDatastore一组 treeDatastore 方法的集合
utils各种辅助模块
version提供当前 dhtmlxGantt 的版本信息
xml指定 XML 序列化和解析