跳到主要内容

API overview

Gantt methods

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

NameDescription
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_paddingbar_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设置一周的起始日
static_background为时间线区域生成背景图像,而不是渲染实际的列和行的线条
static_background_cells在 static_background 模式中启用高亮单元格的呈现
step设置时间刻度的步长(X 轴)
task_attribute设置将用于指定任务的 HTML 元素 ID 的属性名
task_date设置 lightbox 的 'Time period' 部分日期标签的格式
task_grid_row_resizer_attribute设置网格行的 resizer 的 DOM 元素的属性名称。该属性表示行的索引
task_height设置时间线区域中任务条的高度
task_scroll_offset将时间线中离左边界最近任务的偏移量(以像素为单位)设置
time_picker设置 lightbox 中时间下拉选择器的格式
time_step设置任务时间值的最小步长(以分钟为单位)
timeline_placeholder在空的时间线中显示背景网格
tooltip_hide_timeout设置工具提示在隐藏前的持续时间,单位为毫秒
tooltip_offset_x设置工具提示位置的右偏移量(正数时为右偏)
tooltip_offset_y设置 tooltip 位置的顶端偏移量(若为正值)
tooltip_timeout设置在任务的 tooltip 显示前的毫秒超时
touch启用/禁用甘特图的触控支持
touch_drag定义用于将长按手势与滚动手势区分开的毫秒级时间段
touch_feedback在触控设备上拖放前后提供振动反馈
touch_feedback_duration定义在触摸设备上拖放前后的振动反馈持续时间(以毫秒为单位)
type_renderers重新定义用于显示不同类型任务的函数
typesLightbox 的结构名称(用于不同类型的任务)
undo启用甘特图的 Undo 功能
undo_actions设置 Undo 操作将撤销的操作
undo_steps设置 undo 方法应回滚的步骤数量
undo_types设置将应用 Undo 操作的实体类型
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在网格中对任务排序后触发
onAfterTaskAdd在用户向甘特图中添加任务后触发
onAfterTaskAutoSchedule对于每个已自动排程的任务触发
onAfterTaskDelete在用户删除任务后触发
onAfterTaskDrag在用户完成拖拽并松开鼠标按钮后触发
onAfterTaskMove任务移动到新的垂直位置后触发
onAfterTaskUpdate在用户更新任务后触发
onAfterUndo在调用 undo() 方法之后触发
onAjaxError当服务器返回错误时触发
onAutoScheduleCircularLink在自动调度过程中发现某些依赖循环时触发
onBeforeAutoSchedule在自动排程之前触发
onBeforeBatchUpdate在调用 batchUpdate 方法之前触发
onBeforeBranchLoading如果启用动态加载,在用户展开任务分支后但加载开始之前触发
onBeforeCollapse在甘特图退出全屏模式并返回到普通模式之前
onBeforeDataRender在页面渲染数据之前触发
onBeforeExpand在 gantt 展开为全屏之前触发
onBeforeGanttReady在开始 dhtmlxGantt 初始化之前触发
onBeforeGanttRender在页面上呈现甘特图之前触发
onBeforeLightbox在用户打开 lightbox(编辑表单)之前立即触发
onBeforeLinkAdd在 Gantt 图中添加新连线之前触发
onBeforeLinkDelete在用户删除链接之前触发
onBeforeLinkDisplay在甘特图已加载链接后但在显示之前触发
onBeforeLinkUpdate在更新链接之前触发
onBeforeMultiSelect在选择一个任务或一组任务之前触发
onBeforeParse在数据开始被解析之前触发
onBeforeRedo在调用 redo() 方法之前触发
onBeforeRedoStack在将动作加入到重做栈之前触发
onBeforeRollupTaskDisplay在父项目中显示 rollup 任务之前触发
onBeforeRowDragEnd当用户在网格中放下某一行时触发
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在甘特图内点击鼠标右键时触发(请参见详情)
onDataProcessorReadydp.init(gantt) 调用时触发
onDataRender数据已在页面渲染完成后触发
onDestroy在 gantt 已被 destructor 方法清空后调用
onEmptyClick当用户点击甘特图中空白区域时触发(非任务区域)
onErrorassert 接收到 'false' 值时触发,即断言失败时
onExpand在甘特图扩展为全屏时触发
onGanttLayoutReady在 Gantt 布局就绪后,但在渲染之前触发
onGanttReady在 dhtmlxGantt 初始化完成后触发,但 Gantt 图尚未在页面上呈现
onGanttRender在页面上甘特图渲染完成后触发
onGanttScroll当甘特图滚动到特定位置时触发
onGridHeaderClick当用户单击网格的表头时触发
onGridResize在用户拖动网格边框以调整网格大小时触发
onGridResizeEnd在用户完成拖动网格边框以调整网格大小后触发
onGridResizeStart在用户开始拖动网格边框以调整网格大小之前触发
onLightbox在用户打开 lightbox(编辑表单)后触发
onLightboxButton当用户在 lightbox 中点击自定义按钮时触发
onLightboxCancel当用户在灯箱中点击「取消」按钮时触发
onLightboxChangelightbox 的结构发生变化时触发
onLightboxDelete当用户在灯箱中点击“删除”按钮时触发
onLightboxSave当用户在灯箱中点击“保存”按钮时触发
onLinkClick当用户点击链接时触发
onLinkCreated当用户创建任务之间的新链接时触发
onLinkDblClick当用户对链接进行双击时触发
onLinkIdChange当链接的 id 发生变化时触发
onLinkValidation当用户添加新链接时触发,dhtmlxGantt 会验证该链接是否有效
onLoadEnd数据源加载完成后触发
onLoadStart在从数据源开始加载数据之前立即触发
onMouseMove当鼠标在甘特图容器上移动时触发
onMultiSelect在完成对一个任务或一组任务的选择后触发
onOptionsLoad当从服务器加载完一组选项后触发,但尚未被解析
onParse数据在解析后可供 API 使用,但在甘特图渲染之前触发
onQuickInfo当弹出编辑表单出现时触发
onRowDragEnd当用户在网格中释放一个垂直重新排序的行时触发
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重新定义 Gantt 图中按钮的默认点击行为
ajaxGantt ajax 模块
calendar工作日历对象的接口
config定义日期、刻度、控件的配置选项
constants存储各种常量以减少代码中魔术数字的使用
dataprocessor一组 dataprocessor 方法
datastore一组 datastore 方法
date一组日期格式化方法
env描述当前环境的一组标志
ext一个用于存储各种扩展的对象
form_blocksLightbox 控件对象
i18n用于甘特图本地化的一组方法
ignore_time在时间刻度中隐藏一个时间单位
json指定 JSON 序列化与解析
keys定义甘特图的快捷键
license返回 dhtmlxGantt 的许可证名称
locale甘特图的当前区域设置对象(区域特定标签)
oldxml指定 dhtmlxGantt 1.0 的 XML 格式的序列化与解析
skin返回甘特图当前的皮肤
skins返回可用皮肤的对象
templates定义甘特图中日期、标题、工具提示的格式化模板
treeDatastore一组 treeDatastore 方法
utils各种辅助模块
version返回 dhtmlxGantt 的 version
xml指定 XML 序列化和解析
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.