Scheduler API

方法
DataProcessor DataProcessor 构造函数
Promise Promise 对象构造函数
addEvent 添加新事件
addEventNow 添加新事件并打开 lightbox 以确认
addMarkedTimespan 标记日期,并在特定设置下可阻止这些日期(允许自定义样式以限制)
addSection 向活动视图添加一个部分
addShortcut 添加新的键盘快捷键
alert 显示警告消息框
assert 如果指定表达式为假,则在右上角显示红色错误弹窗
attachEvent 绑定处理程序到内部 dhtmlxScheduler 事件
backbone 双向同步调度器与 Backbone 模型的变更
batchUpdate 同时更新多个事件
bind 创建一个函数,其 this 关键字绑定到指定值
blockTime 阻止指定日期并应用默认的“暗淡”样式
callEvent 触发内部事件
changeEventId 更改事件的 ID
checkCollision 检查事件是否与现有事件重叠
checkEvent 检查事件是否有指定的处理程序
checkInMarkedTimespan 检查事件是否落在某种类型的标记时间段内
checkLimitViolation 检查事件是否发生在被阻止的时间段内
clearAll 从调度器中移除所有事件
closeAllSections 关闭当前视图中的所有部分
closeSection 关闭当前视图中的指定部分
collapse 将调度器从展开状态折叠回正常大小
confirm 显示确认消息框
copy 创建对象的深拷贝
createDataProcessor 创建新的 dataProcessor 并绑定到调度器
createGridView 创建网格视图
createTimelineView 创建时间线视图
createUnitsView 创建单位视图
defined 如果参数未定义则返回 false,否则返回 true
deleteAllSections 从当前视图中移除所有部分
deleteEvent 删除指定事件
deleteMarkedTimespan 移除由 addMarkedTimespan() 设置的标记或阻止
deleteSection 从当前视图中删除部分
destroyCalendar 销毁先前创建的小型日历
destructor 销毁调度器实例
detachEvent 从事件中解绑处理程序(之前通过 attachEvent 绑定)
@short: 打开内联编辑器以更改事件文本(事件框内)
editStop 如果内联事件编辑器打开,则关闭它
endLightbox 关闭 lightbox
event 为 HTML 元素绑定事件处理程序
eventRemove 从 HTML 元素移除事件处理程序
expand 将调度器展开至全屏
exportToPDF 导出调度器数据为 PDF 格式
exportToPNG 导出调度器数据为 PNG 格式
focus 设置调度器焦点
formSection 访问 lightbox 的部分对象
getActionData 返回当前光标指向的日期和部分(如果定义)
getEvent 通过 ID 返回事件对象
getEventEndDate 获取事件结束日期
getEventStartDate 获取事件开始日期
getEventText 获取事件文本
getEvents 返回指定期间内所有事件
getLabel 获取 lightbox 中选择控件的标签
getLightbox 返回 lightbox 的 HTML 元素
getRecDates 返回重复事件的所有发生日期
getRenderedEvent 获取当前显示的事件对象
getSection 获取当前视图中的部分对象
getShortcutHandler 获取键盘快捷键处理程序
getState 返回调度器当前状态
getUserData 获取与事件关联的用户数据
getView 通过名称返回视图对象;无名称则返回当前视图
hideCover 隐藏阻止与屏幕其他部分交互的 lightbox 模态覆盖层
hideLightbox 隐藏 lightbox,且不保存更改
hideQuickInfo 如果弹出事件表单激活,则隐藏它
highlightEventPosition 在时间刻度上高亮事件的持续时间
init dhtmlxScheduler 对象构造函数
invertZones 反转指定的时区
isCalendarVisible 检查迷你日历是否当前打开
isOneDayEvent 检查事件是单日还是多日
isViewExists 检查指定名称的视图是否存在
linkCalendar 连接迷你日历以在调度器活动日期更改时更新
load 从外部源加载数据到调度器
markCalendar 对指定日期应用 CSS 类
markTimespan 通过应用默认或自定义样式标记或阻止日期;标记在内部更新后重置;用于高亮显示
message 显示指定类型的消息框
mixin 将源对象的属性添加到目标对象
modalbox 显示模态框
openAllSections 打开当前视图中的所有部分(时间线视图的“树”模式忽略)
openSection 打开当前视图中的指定部分(时间线视图的“树”模式忽略)
parse 从客户端资源加载数据
plugins 激活指定的扩展
removeShortcut 移除键盘快捷键
render 重新绘制调度器
renderCalendar 创建迷你日历
renderEvent 为事件框生成自定义 HTML 内容
resetLightbox 移除当前 lightbox HTML 元素
scrollUnit 在单位视图中滚动指定数量的单位
select 选择指定事件
serialize 序列化当前加载的所有事件
serverList 定义用于加载到 Units、Timeline 视图或 Lightbox 的命名集合
setCurrentView 显示指定视图和日期
setEvent 向调度器数据添加新事件
setEventEndDate 设置事件结束日期
setEventStartDate 设置事件开始日期
setEventText 设置事件文本
setLightboxSize 强制调整 lightbox 大小
setLoadMode 启用分段加载数据(动态加载)
setSkin 设置活动皮肤
setUserData 关联用户数据到事件
showCover 显示阻止与屏幕其他部分交互的 lightbox 模态覆盖层
showEvent 在当前或指定视图中显示并高亮指定事件
showLightbox 打开指定事件的 lightbox
showQuickInfo 显示指定事件的弹出事件表单
startLightbox 在指定 HTML 容器中居中显示自定义 lightbox
toICal 将调度器数据转换为 ICal 格式
toJSON 将调度器数据转换为 JSON 格式
toPDF 将当前视图导出为 PDF 文档(适合打印)
toPDFRange 将多个视图导出为 PDF 文档(适合打印)
toXML 将调度器数据转换为 XML 格式
uid 在当前调度器中生成唯一 ID(非 GUID)
unblockTime 移除 blockTime() 设置的阻止
unmarkCalendar 从指定日期移除 CSS 类
unmarkTimespan 移除由 markTimespan() 设置的标记/阻止
unselect 取消选择指定事件
updateCalendar 更新迷你日历以显示指定日期
updateCollection 使用新选项更新集合
updateEvent 更新指定事件
updateView 显示指定视图和日期,但不触发事件
事件
onAfterBatchUpdate batchupdate() 调用后触发
onAfterEventDisplay showEvent() 显示事件后触发(视图或日期更改后)
onAfterFolderToggle 树分支打开或关闭后触发(仅限时间线视图“树”模式)
onAfterLightbox lightbox(编辑表单)关闭后触发
onAfterQuickInfo 弹出事件表单关闭后触发
onAfterSchedulerResize 调度器调整大小并重绘数据区域后触发
onBeforeBatchUpdate batchupdate() 调用前触发
onBeforeCollapse 用户点击折叠调度器从全屏到原始大小时触发
onBeforeDrag 拖动或调整大小开始时触发(版本 2.1+)
onBeforeEventChanged 事件通过拖放更改但未保存时触发
onBeforeEventCreated 通过拖拽在调度器上创建新事件时触发
onBeforeEventDelete 用户点击事件删除按钮后触发
onBeforeEventDisplay showEvent() 显示特定事件前触发
onBeforeEventDragIn 拖动事件进入调度器前触发
onBeforeEventDragOut 拖动事件离开调度器前触发
onBeforeEventPasted 用户按下 'CTRL+V' 前触发
onBeforeExpand 用户点击展开调度器从原始到全屏时触发
onBeforeExternalDragIn 元素开始从外部拖入调度器前触发(带 dnd 扩展)
onBeforeFolderToggle 树分支打开或关闭前触发(仅限时间线视图“树”模式)
onBeforeLightbox lightbox 打开前触发
onBeforeParse 数据解析开始前触发
onBeforeQuickInfo 快速信息弹出显示前触发
onBeforeSectionRender 时间线部分配置但未渲染前触发(仅限时间线视图)
onBeforeTodayDisplayed 点击“今天”按钮时触发
onBeforeTooltip 工具提示显示前触发(带“tooltip”扩展)
onBeforeViewChange 当前视图更改前触发
onCellClick 单击单元格时触发(仅限时间线视图)
onCellDblClick 双击单元格时触发(仅限时间线视图)
onClearAll 清除所有调度器数据后触发
onClick 左键点击事件时触发
onCollapse 用户折叠调度器从全屏到原始大小时触发
onConfirmedBeforeEventDelete 用户确认删除事件后触发
onContextMenu 右键点击调度器内部打开上下文菜单时触发
onDataRender 数据渲染后触发
onDblClick 双击事件时触发
onDestroy 调度器通过析构函数清除后触发
onDragEnd 拖动或调整大小结束时触发
onEmptyClick 点击调度器空白区域(非事件)时触发
onError 断言失败时触发(assert() 返回 false)
onEventAdded 新事件添加时触发
onEventCancel lightbox 中点击“取消”按钮时触发
onEventChanged 事件编辑并保存后触发
onEventCollision 事件创建或修改时与现有事件重叠触发
onEventCopied 按下 'CTRL+C' 键盘命令时触发(带键盘导航扩展)
onEventCreated 事件创建开始时触发(双击或拖拽)
onEventCut 按下 'CTRL+X' 键盘命令时触发(带键盘导航扩展)
onEventDeleted 事件删除后触发(版本 3.0+)
onEventDrag 事件拖动或调整大小时触发
onEventDragIn 拖动事件进入调度器时触发
onEventDragOut 拖动事件离开调度器时触发
onEventDropOut 拖动事件放置在调度器外时触发
onEventIdChange 事件 ID 变更时触发
onEventLoading 事件从数据源加载时触发
onEventPasted 按下 'CTRL+V' 键盘命令时触发
onEventSave lightbox 中点击“保存”按钮时触发
onEventSelected 事件被选中时触发
onEventUnselected 通过选择其他事件取消选中时触发
onExpand 用户将调度器展开至全屏时触发
onExternalDragIn 数据从外部拖入调度器时触发(带 dnd 扩展)
onLightbox lightbox 打开后触发
onLightboxButton lightbox 中自定义按钮点击时触发
onLimitViolation 事件设置在被阻止或限制时间内时触发
onLoadEnd 数据加载完成后触发
onLoadError 数据解析失败或服务器错误响应(4xx 或 5xx)时触发
onLoadStart 数据加载开始前触发
onLocationError 事件位置无法在地图上找到时触发(仅限地图视图)
onMouseDown 点击无预定义 onclick 处理程序的调度器元素时触发
onMouseMove 鼠标在调度器上移动时触发
onOptionsLoad 时间线/单位视图部分更新后触发
onOptionsLoadFinal 选项/部分加载完成后触发(仅限时间线视图)
onOptionsLoadStart 选项/部分加载开始前触发(仅限时间线视图)
onParse 数据解析后但渲染前触发
onQuickInfo 弹出编辑表单出现时触发
onSaveError 数据更新过程中出现错误时触发
onScaleAdd 单个视图单元(如列、部分)渲染后触发
onScaleDblClick 时间刻度双击时触发
onSchedulerReady 调度器初始化完成但渲染前触发
onSchedulerResize 调度器调整大小前触发
onTemplatesReady 调度器模板初始化时触发
onTimelineCreated 时间线视图初始化后但渲染前触发(仅限时间线视图)
onViewChange 当前视图更改后触发
onViewMoreClick 月视图中点击“查看更多”时触发
onXLE 数据加载完成后触发
onXLS 数据加载开始前触发
onXScaleClick X 轴单元格单击时触发(仅限时间线视图)
onXScaleDblClick X 轴单元格双击时触发(仅限时间线视图)
onYScaleClick Y 轴单元格单击时触发(仅限时间线视图)
onYScaleDblClick Y 轴单元格双击时触发(仅限时间线视图)
属性
active_link_view 启用月视图中可点击的日期数字,打开指定视图的相关日期
agenda_end 设置显示事件的结束日期
agenda_start 设置显示事件的开始日期
ajax_error 定义 XML 数据加载失败时默认错误通知的显示方式
all_timed 将多日事件显示为常规单日事件
api_date 定义 api_date 模板的日期格式
auto_end_date 当开始日期更改时自动调整事件结束日期
buttons_left lightbox 左下角显示的按钮集合
buttons_right lightbox 右下角显示的按钮集合
cascade_event_count 设置级联事件的最大数量
cascade_event_display 设置级联事件的显示模式
cascade_event_margin 设置级联事件的左边距
check_limits 启用或禁用限制检查
collision_limit 设置每个时间段允许的最大事件数
container_autoresize 使调度器容器自动调整大小以适应内容,无需滚动
csp 定义内部日期格式化实现
date_format 设置解析和发送日期到服务器的日期格式
day_column_padding 为视图列添加内边距
day_date 设置周视图和单位视图中 X 轴的日期格式
dblclick_create 启用双击创建事件
default_date 设置 day_date、week_date、day_scale_date 模板中视图标题使用的日期格式
delay_render 设置 updateview() 和 setcurrentview() 调用重绘调度器的延迟(毫秒)
details_on_create 通过拖拽或双击创建新事件时打开扩展表单
details_on_dblclick 双击事件后打开 lightbox
display_marked_timespans 控制是否高亮显示标记或阻止的时间段
displayed_event_color showEvent() 显示事件的默认背景色
displayed_event_text_color showEvent() 显示事件的默认字体颜色
drag_create 启用通过拖拽创建新事件
drag_event_body 允许通过事件任何部分拖动事件
drag_highlight 拖动时高亮显示原始事件位置和持续时间
drag_in 限制事件从其他调度器拖入
drag_lightbox 允许通过 lightbox 标题拖动 lightbox
drag_move 启用通过拖拽移动事件
drag_out 限制事件拖出调度器到其他调度器
drag_resize 启用通过拖拽调整事件大小
edit_on_create 创建新事件时打开 lightbox
event_attribute 指定事件 HTML 元素 ID 的属性名
event_duration 设置事件初始持续时间(分钟)
first_hour 设置 Y 轴刻度的最小小时值
fix_tab_position 将视图标签从左移到右
full_day 启用设置事件为全天持续时间
header 配置调度器头部布局(导航面板)
highlight_displayed_event 控制是否高亮显示 showEvent() 显示的事件
hour_date 设置 Y 轴和事件/lightbox 模板的时间格式
hour_size_px 设置一小时单元的像素高度
icons_edit 事件框侧边编辑菜单中的图标集合
icons_select 事件框侧边选择菜单中的图标集合
include_end_by 定义“结束于”日期是排他还是包含
key_nav 启用键盘导航
key_nav_step 键盘导航在事件间切换的最小步长(分钟)
last_hour 设置 Y 轴刻度的最大小时值
left_border 为调度器添加虚线左边框
lightbox 定义 lightbox 对象
lightbox_recurring 定义编辑重复事件时 lightbox 的行为
limit_drag_out 防止事件拖出可见调度器区域
limit_end 设置允许的日期范围结束限制
limit_start 设置允许的日期范围开始限制
limit_time_select 限制 lightbox 时间选择器在 last_hour 和 first_hour 之间
limit_view 限制用户查看事件的日期范围
load_date 设置动态加载请求中“from”和“to”参数的格式
map_end 设置地图上显示事件的结束日期
map_error_position 当事件位置未找到时地图显示的位置
map_infowindow_max_width 地图视图中弹出标记的最大宽度
map_initial_position 设置地图初始位置
map_initial_zoom 设置地图视图初始缩放级别
map_resolve_event_location 启用缺少坐标时尝试解析事件位置
map_resolve_user_location 启用或禁用提示共享用户位置以显示地图
map_settings 提供地图相关设置
map_start 设置地图上显示事件的开始日期
map_type 设置使用的 Google 地图类型
map_view_provider 指定地图提供商
map_zoom_after_resolve 授权后显示用户位置后设置缩放级别
mark_now 启用或禁用当前时间标记
max_month_events 设置每个单元格显示的最大事件数
min_grid_size 自动调整大小时网格视图的最小尺寸
min_map_size 自动调整大小时地图视图的最小尺寸
minicalendar 定义迷你日历对象
month_date 设置月视图标题的日期格式
month_day 设置月视图和年视图单元格中的日期格式
month_day_min_height 设置月视图单元格的最小高度
multi_day 启用多日事件渲染
multi_day_height_limit 设置多日事件显示区域高度
multisection 启用在多个部分(时间线或单位视图)中渲染相同事件
multisection_shift_all 控制拖动多部分事件时是移动所有实例还是仅移动选中实例
now_date 设置 Limit 扩展中当前时间标记的日期
occurrence_timestamp_in_utc 启用独立于时区处理重复事件
overwrite_marked_timespans 启用标记时间段的阻止优先级
parse_exact_format 控制调度器是否自动检测数据格式
positive_closing 定义直接在事件框中编辑事件文本时的保存行为
preserve_length 在非线性时间刻度上拖动时保持事件可见长度
preserve_scroll 禁用在同一视图内导航日期时保持滚动位置
prevent_cache 启用或禁用浏览器 GET 请求缓存
quick_info_detached 定义事件表单是出现在事件附近还是屏幕侧边
readonly 启用调度器只读模式
readonly_form 启用 lightbox 只读模式
recurring_overflow_instances 控制跨月重复事件的行为
recurring_workdays 定义影响“每个工作日”重复事件的工作日
repeat_date 设置重复 lightbox 中“结束于”字段的日期格式
repeat_precise 防止将过去日期包含在每周重复事件中
resize_month_events 启用通过拖拽调整月视图中多日事件大小
resize_month_timed 启用通过拖拽调整月视图中单日事件大小
responsive_lightbox 使 lightbox 在小屏幕上响应式显示
rtl 启用从右到左模式
scroll_hour 设置按小时(24 小时制)初始垂直滚动位置
section_delimiter 指定事件数据中多个部分/单位的分隔符
select 显示或隐藏事件框中的选择栏
separate_short_events 防止短事件重叠
server_utc 启用服务器日期在 UTC 和本地时区间转换
show_errors 启用在出现意外行为时显示错误警报
show_loading 数据加载时显示加载动画(适用于动态加载)
show_quick_info 启用或禁用“quick_info”扩展(弹出详情表单)
start_on_monday 设置每周起始日
time_step 设置事件时间值的最小步长(分钟)
timeline_swap_resize 允许调整事件大小时交换开始和结束日期(当结束早于开始)
tooltip_hide_timeout 设置工具提示隐藏的延迟毫秒数
tooltip_offset_x 设置工具提示水平偏移量
tooltip_offset_y 设置工具提示垂直偏移量
tooltip_timeout 设置任务工具提示出现前的延迟
touch 启用或禁用触摸支持
touch_drag 设置区分长按与滚动手势的时间段
touch_swipe_dates 启用或禁用移动设备上通过水平滑动切换日期
touch_tip 启用或禁用右上角的提示消息
touch_tooltip 启用触摸设备显示工具提示
undo_deleted 删除事件时提供撤销弹窗
update_render 控制调度器是否在任何操作时完全重绘
use_select_menu_space 定义事件是否占满单元格宽度
wai_aria_application_role 设置主调度器容器和迷你日历是否使用 role="application"
wai_aria_attributes 启用屏幕阅读器的 WAI-ARIA 支持
week_agenda_select 高亮显示周议程视图中选中的事件
week_date 设置月视图子标题的日期格式
wide_form 启用或禁用标准(宽)lightbox 替代短版
xml_date 设置解析数据集时的日期格式
year_x 设置年视图的行数
year_y 设置年视图的列数
模板
agenda_date 定义议程视图标题中显示的日期
agenda_day 定义议程视图中日期单元格的内容
agenda_text 定义议程视图第二列的文本
agenda_time 定义议程视图第一列的日期
api_date 定义 API 方法使用的日期格式;用于解析传入日期
calendar_date 定义迷你日历(日期选择器)中日期单元格内容
calendar_month 定义迷你日历中的标题日期
calendar_scale_date 定义迷你日历标题中的周日格式
calendar_time 定义 lightbox 开始和结束日期输入的日期格式
day_date 定义日视图和单位视图标题中的日期
day_scale_date 定义日视图子标题中的日期
drag_marker_class 定义应用于时间刻度上高亮事件持续时间的 CSS 类
drag_marker_content 定义时间刻度上高亮块的内容
event_bar_date 定义单日事件的日期
event_bar_text 定义多日事件的事件文本
event_class 定义应用于事件容器的 CSS 类
event_date 定义事件开始和结束日期的时间部分;供其他模板使用
event_header 定义事件头部内容
event_text 定义事件文本内容
format_date 将日期对象转换为字符串;用于发送数据到服务器
hour_scale 定义 Y 轴上的项目
load_format 定义动态加载模式下的请求格式
map_date 定义地图视图标题中的日期
map_info_content 定义地图视图中信息窗口的内容
map_text 定义地图视图第二列的文本
map_time 定义地图视图第一列的日期
month_date 定义月视图标题中的日期
month_date_class 定义应用于日期单元格的 CSS 类
month_day 定义月视图单元格中的日期格式
month_events_link 定义月视图单元格中“查看更多”链接的呈现
month_scale_date 定义月视图 X 轴上的日期格式
parse_date 将日期字符串转换为日期对象
quick_info_content 定义弹出编辑表单的内容
quick_info_date 定义弹出编辑表单中的日期
quick_info_title 定义弹出编辑表单的标题
time_picker 定义 lightbox 中的下拉时间选择器
time_slot_class 定义日/周视图中背景单元格的 CSS 类
time_slot_text 定义日/周视图中背景单元格的内容
tooltip_date_format 定义工具提示中开始和结束日期的格式
tooltip_text 定义工具提示文本
week_agenda_date 定义周议程视图标题中的日期
week_agenda_event_text 定义周议程视图中的事件文本
week_agenda_scale_date 定义周议程视图中日期单元格的日期
week_date 定义视图标题中的日期
week_date_class 定义应用于日期单元格的 CSS 类
week_scale_date 定义视图子标题中的日期
year_date 定义年视图标题中的日期
year_month 定义年视图月份块标题中的月份名称
year_scale_date 定义年视图月份块子标题中的日期名称
year_tooltip 定义包含事件的日期单元格的工具提示
lightbox_header 定义 lightbox 头部内容
{gridName}_date 定义网格视图标题中的日期
{gridName}_full_date 定义 id='date' 列的日期格式
{gridName}_single_date 定义 id='start_date' 或 'end_date' 列的日期格式
{gridName}_field 定义网格列中的文本
{timelineName}_cell_value 定义时间线视图单元格中的事件数量
{timelineName}_cell_class 定义应用于时间线视图单元格的 CSS 类
{timelineName}_scalex_class 定义应用于 X 轴项目的 CSS 类
{timelineName}_second_scalex_class 定义应用于第二 X 轴项目的 CSS 类
{timelineName}_scaley_class 定义应用于 Y 轴项目的 CSS 类
{timelineName}_scale_label 定义 Y 轴上的项目
{timelineName}_tooltip 定义时间线日单元格中事件的工具提示
{timelineName}_date 定义时间线视图标题中的日期
{timelineName}_scale_date 定义 X 轴上的项目
{timelineName}_second_scale_date 定义第二 X 轴上的项目
{unitsName}_date 定义单位视图标题中的日期
{unitsName}_scale_text 定义 X 轴上的项目
xml_date 根据此模板将 XML 字符串转换为日期对象
xml_format 根据此模板将日期对象转换为字符串;用于发送数据到服务器
{timelineName}_row_class 定义应用于时间线视图行的 CSS 类
其他
ajax 调度器 ajax 模块
config 日期、刻度、控件的配置选项
date 日期格式化方法
env 描述当前环境的标志
i18n 调度器本地化方法
ical ICal 序列化与解析
json JSON 序列化与解析
keys 定义调度器快捷键
locale 带有区域特定标签的本地化对象
matrix 存储页面上所有时间线的配置
skin 返回当前调度器皮肤
templates 定义日期、标题和工具提示的格式化
tooltip 显示事件工具提示
version 返回 dhtmlxScheduler 版本
xy 定义调度器元素的尺寸
返回顶部