跳转到主要内容

Methods overview

NameDescription
DataProcessorDataProcessor 构造函数
Promise用于创建 Promise 对象的构造函数
addEvent添加一个新事件
addEventNow创建一个新的事件并打开lightbox进行确认
addMarkedTimespan标记日期,并且在某些设置下,可以阻止这些日期(允许对限制的边界应用自定义样式)
addSection向当前活动视图添加一个新的 section
addShortcut创建一个新的键盘快捷键
alert显示一个 alert 消息框
assert如果给定的表达式为 false,将在屏幕右上角以红色弹窗形式显示错误信息
attachEvent将处理程序附加到 dhtmlxScheduler 的内部事件
backbone保持调度器与Backbone模型中的所有更新同步,反之亦然
batchUpdate一次更新多个事件
bind创建一个新函数,该函数在被调用时,其 this 关键字被设置为指定的值
blockTime阻止给定的日期,并应用默认的"dimmed"样式。
callEvent触发一个内部事件
changeEventId更新事件的 id
checkCollision验证给定的事件是否在相同时段与任何已有事件重叠
checkEvent验证是否有处理程序分配给特定事件
checkInMarkedTimespan判断一个事件是否落在指定类型的时间段内
checkLimitViolation判断给定的事件是否与被阻止的时间段重叠
clearAll从调度器中移除所有事件
closeAllSections关闭当前活动视图中的所有 sections
closeSection关闭当前活动视图中的指定 section。
collapse将 scheduler 从展开状态恢复到常规大小
confirm打开一个 confirm 消息框
copy创建给定对象的深拷贝
createDataProcessor生成一个新的 dataProcessor 实例并将其链接到 scheduler
createGridView在调度程序中设置 Grid 视图
createTimelineView在调度程序中创建 Timeline 视图。
createUnitsView在调度器中设置 Units 视图
defined当参数为 undefined 时返回 false;否则返回 true
deleteAllSections从当前活动视图中移除所有 section
deleteEvent删除指定的事件
deleteMarkedTimespan移除使用 addMarkedTimespan() 方法创建的标记或阻塞
deleteSection从当前活动视图中移除一个 section
destroyCalendar移除之前创建的迷你日历
destructor移除一个 scheduler 实例
detachEvent移除之前通过 attachEvent 方法添加的事件处理程序
edit在事件框内直接打开内联编辑器以更改事件文本
editStop结束打开时的inline事件编辑器
endLightbox用于关闭lightbox
event在HTML元素上设置事件处理器
eventRemove从HTML元素中移除事件处理程序
expand打开scheduler,使其占据整个屏幕以提升可见性
exportToPDF将 Scheduler 导出为 PDF 格式
exportToPNG允许您将 Scheduler 导出为 PNG 图片
focus激活 scheduler 的 focus
formSection提供对lightbox sections对象的访问
getActionData返回当前光标下的日期和区段(如果有的话)
getEvent提供对应于给定 id 的事件对象
getEventEndDate获取事件的结束日期
getEventStartDate获取事件的开始日期
getEventText获取与事件关联的文本
getEvents返回指定时间范围内发生的事件集合
getLabel获取 lightbox 中 select 控件的标签
getLightbox获取 lightbox 的 HTML 元素
getRecDates获取重复事件的所有发生时间
getRenderedEvent返回当前显示事件的 HTML 元素
getSection获取当前活动视图中特定 section 的对象
getShortcutHandler获取一个键盘导航快捷键的处理函数
getState获取调度器的当前状态
getUserData获取与特定事件关联的用户数据
getView根据视图名称返回一个视图对象。如果未提供名称,则返回当前视图。
hideCover移除阻止与屏幕其他部分交互的lightbox模态覆盖层
hideLightbox关闭 lightbox 而不保存任何更改
hideQuickInfo如果弹出事件表单当前处于打开状态,则隐藏该表单。
highlightEventPosition在时间线上标记事件的持续时间
init这是用于创建 dhtmlxScheduler 实例的构造函数。
invertZones翻转给定的时区范围
isCalendarVisible用于识别调度器中日历当前是否显示
isOneDayEvent判断给定事件是否仅持续一天,还是跨越多天
isViewExists验证是否存在指定名称的视图
linkCalendar每当调度器(scheduler)中的活动日期发生变化时,此方法会更新迷你日历中的活动日期。
load从外部数据源将数据加载到调度器
markCalendar为特定日期添加一个 CSS 类
markTimespan通过应用默认或自定义样式来高亮或阻止特定日期。高亮会在应用内部任何更新后立即移除。此功能适用于强调某些日期。
message打开一个指定类型的 message box
mixin将 'source' 对象的属性合并到 'target' 对象中
modalbox打开一个 modalbox
openAllSections打开当前活动视图中的所有 section(仅当视图为 Timeline 且处于"Tree"模式时有效;否则,该方法将被忽略)
openSection在当前活动视图中打开特定的section(仅当活动视图为"Tree"模式的Timeline时生效;否则该方法将被忽略)
parse从客户端资源加载数据
plugins启用所选的 extensions
removeShortcut移除键盘快捷键
render刷新scheduler显示
renderCalendar生成一个紧凑型日历
renderEvent创建自定义事件框的HTML内容
resetLightbox移除当前 lightbox 的 HTML 对象元素
scrollUnit在 Units 视图中滚动指定数量的单位
select选择你指定的事件
serialize序列化当前加载在scheduler中的所有事件
serverList定义一个命名集合,可加载到 Units、Timeline 视图或 Lightbox 中
setCurrentView显示指定的视图和日期
setEvent向调度器的数据池中添加一个新的事件
setEventEndDate更新事件的结束日期
setEventStartDate更新事件的开始日期
setEventText更新特定事件的文本内容
setLightboxSize更新 lightbox 的大小
setLoadMode设置分段加载数据的模式,实现动态加载
setSkin更改当前激活的 skin
setUserData将用户数据分配给特定事件
showCover显示一个 lightbox 模态覆盖层,防止与屏幕其他部分进行交互
showEvent在当前视图或指定视图中显示并高亮指定的事件
showLightbox为指定事件打开lightbox
showQuickInfo为指定事件打开弹出事件表单
startLightbox在指定的 HTML 容器内显示自定义的 lightbox,并居中显示在屏幕上
toICal将调度器数据转换为ICal格式
toJSON将调度器的数据转换为 JSON 格式的字符串
toPDF将当前视图导出为 PDF 文档,方便打印使用。
toPDFRange导出多个调度器视图到PDF文档(适用于打印)
toXML将调度器的数据转换为XML格式
uid创建一个在当前 scheduler 实例内保证唯一的唯一 ID(不是全局 GUID)
unblockTime移除之前通过 blockTime() 方法设置的时间阻断
unmarkCalendar从指定日期移除一个 CSS 类
unmarkTimespan清除由 markTimespan() 方法应用的标记或阻止
unselect从指定事件中移除选中状态
updateCalendar在迷你 calendar 中显示所选日期
updateCollection使用新的选项更新指定的 collection
updateEvent修改指定的事件
updateView显示指定的视图和日期(不触发任何事件)
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.