API overview
Scheduler methods
| Name | Description |
|---|---|
| DataProcessor | DataProcessor 构造函数 |
| 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 | 在 scheduler 中设置 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 | 从外部源加载数据到scheduler中 |
| 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 | 显示指定的视图和日期,但不触发任何事件 |
Scheduler properties
| Name | Description |
|---|---|
| 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"显示模式 |
| cascade_event_margin | 定义一系列级联事件的左边距 |
| check_limits | 切换是否启用限制检查 |
| collision_limit | 定义单个时间段内允许的最大事件数量 |
| container_autoresize | 使调度器的容器自动调整大小以适应全部内容,无需滚动 |
| csp | 指定日期格式化方法在内部的实现方式 |
| date_format | 定义用于从数据集中解析数据以及向服务器发送日期时使用的日期格式 |
| day_column_padding | 为视图列添加内边距 |
| day_date | 指定在 Week 和 Units 视图中 X 轴使用的日期格式 |
| dblclick_create | 允许用户通过双击创建事件 |
| default_date | 定义模板 'day_date'、'week_date'、'day_scale_date' 用于在视图头部显示日期的日期格式 |
| delay_render | 设置一个超时(以毫秒为单位),用于包装 updateView 和 setCurrentView 的调用(这些调用会触发scheduler的重绘) |
| 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 | 此选项在拖动事件穿过scheduler的时间刻度时,高亮显示事件的起始点和持续时间。 |
| drag_in | 限制拖动事件,使其只能在发起拖动的调度器内移动,防止在不同调度器之间转移。 |
| drag_lightbox | 允许通过标题栏拖动lightbox |
| drag_move | 允许通过拖放操作重新定位事件 |
| drag_out | 防止事件从此scheduler拖动到其他scheduler |
| drag_resize | 允许通过拖放操作调整事件的大小 |
| edit_on_create | 允许在创建新事件时打开lightbox |
| event_attribute | 定义用于通过id识别事件HTML元素的属性名称 |
| event_duration | 设置事件的初始持续时间(以分钟为单位) |
| first_hour | 定义小时刻度(Y轴)的起始小时 |
| fix_tab_position | 将视图的 tabs 从左侧移到右侧 |
| full_day | 允许将事件设置为全天持续 |
| header | 设置调度器 header(导航面板)的布局 |
| highlight_displayed_event | 决定通过 showEvent 方法获取的事件在显示时是否高亮显示 |
| hour_date | 定义Y轴上显示的时间格式。该格式同样应用于默认事件和lightbox模板中,用于格式化时间部分。 |
| hour_size_px | 定义小时块的高度,单位为像素 |
| icons_edit | 包含一组图标,这些图标会显示在事件框内的侧边编辑菜单中 |
| icons_select | 保持一组图标,这些图标会显示在事件框的侧边选择菜单中 |
| include_end_by | 设置"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 | 通过设置 'last_hour' 和 'first_hour' 选项的最大值和最小值,限制 lightbox 中时间选择器的时间范围。 |
| 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 Maps 的类型 |
| map_view_provider | 定义使用哪个地图提供商 |
| map_zoom_after_resolve | 设置在浏览器请求权限且用户同意时,显示用户位置的缩放级别 |
| mark_now | 打开或关闭当前时间的标记器 |
| max_month_events | 控制单个单元格中显示的最大事件数量 |
| min_grid_size | 定义 Grid 视图在自动调整大小时可以缩小到的最小尺寸 |
| min_map_size | 定义 Map 视图在自动调整大小时可以缩小到的最小尺寸 |
| minicalendar | 定义 mini calendar 对象 |
| month_date | 定义月视图头部的日期格式 |
| month_day | 定义用于在月视图和年视图的单元格中显示日期的格式 |
| month_day_min_height | 设置月视图中单元格的最小高度 |
| multi_day | 允许显示跨越多天的事件 |
| multi_day_height_limit | 控制显示多日事件部分的高度 |
| multisection | 允许在 Timeline 或 Units 视图中跨多个 section 渲染相同的事件 |
| multisection_shift_all | 控制在 Timeline 或 Units 视图中拖动分配给多个 section 的事件时,是否同时移动所有实例('true')还是仅移动选中的那个('false') |
| now_date | 设置 Limit 扩展中当前时间标记的日期(通过 - mark_now 配置激活) |
| 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 | 定义在 lightbox 中选择 "Every workday" 选项时,哪些天被视为工作日的数组。 |
| repeat_date | 指定"recurring" lightbox 中"End by"字段使用的日期格式 |
| repeat_precise | 停止在"weekly"重复事件中包含过去的日期 |
| resize_month_events | 允 许在月视图中通过拖放操作调整多日事件的大小 |
| resize_month_timed | 允许通过拖拽调整月视图中单日事件的大小 |
| responsive_lightbox | 使 lightbox 在较小屏幕上能够平滑调整 |
| rtl | 为调度器开启 RTL(从右到左)模式 |
| scroll_hour | 定义调度器中垂直滚动位置的起始点,基于24小时制的小时数。 |
| section_delimiter | 定义用于拆分事件相关数据属性中多个区段或单元的分隔符 |
| select | 切换事件框内select栏的可见性 |
| separate_short_events | 帮助避免短事件重叠 |
| server_utc | 允许在与服务器交换数据时,将服务器端日期在 UTC 和本地时区之间转换 |
| show_errors | 当出现错误时,启用错误提示弹窗 |
| show_loading | 在数据加载期间显示进度指示器或spinner,这对于动态加载场景非常有用。 |
| show_quick_info | 开启或关闭 'quick_info' 扩展(显示任务详情的弹出框) |
| start_on_monday | 设置一周的起始天 |
| time_step | 设置事件时间值的最小增量(以分钟为单位) |
| timeline_swap_resize | 允许在调整大小时,如果结束日期被拖动到开始日期之前,事件的结束日期与开始日期互换 |
| tooltip_hide_timeout | 设置tooltip在消失前保持可见的时间,单位为毫秒 |
| tooltip_offset_x | 当设置为正值时,调整tooltip水平偏移量,使其位置向右移动。 |
| tooltip_offset_y | 通过设置正值的顶部偏移量来调整 tooltip 的垂直位置 |
| tooltip_timeout | 定义任务的tooltip出现前的延迟时间,单位为毫秒 |
| touch | 开启或关闭调度器中的touch支持 |
| touch_drag | 设置区分长按手势和滚动手势的持续时间,单位为毫秒 |
| touch_swipe_dates | 允许您开启或关闭在移动设备上通过水平滑动手势切换活动日期的功能 |
| touch_tip | 控制提示消息是否显示在屏幕右上角 |
| touch_tooltip | 使 dhtmlxScheduler 在触摸设备上显示 tooltips |
| undo_deleted | 启用删除事件后出现的Undo弹出窗口 |
| update_render | 控制调度器是否在每次操作后完全重绘自身 |
| use_select_menu_space | 定义事件是否占用单元格的整个宽度 |
| wai_aria_application_role | 指定是否应将 role="application" 分配给主调度器容器和迷你日历元素 |
| wai_aria_attributes | 启用 WAI-ARIA 支持,使组件能够被屏幕阅读器识别 |
| week_agenda_select | 在 Week Agenda 视图中突出显示所选事件 |
| week_date | 定义月视图子标题中显示的日期格式。 |
| wide_form | 控制是否显示标准(wide)lightbox,而非简短版本 |
| xml_date | 定义用于解析数据集中数据的日期格式 |
| year_x | 指定Year视图中显示的行数 |
| year_y | 设置年视图中显示的列数 |
Scheduler events
| Name | Description |
|---|---|
| onAfterBatchUpdate | 在 batchUpdate 方法执行完成后立即触发 |
| onAfterEventDisplay | 当scheduler切换视图、日期、时间等以显示通过'showEvent'方法指定的事件时触发,该事件在事件显示之后发生。 |
| onAfterFolderToggle | 当树状分支被打开或关闭后立即触发(仅适用于Timeline视图中的"tree"模式) |
| onAfterLightbox | 当用户关闭 lightbox(编辑表单)时触发 |
| onAfterQuickInfo | 在弹出事件窗体关闭后立即触发。 |
| onAfterSchedulerResize | 当调度器的大小更新且数据区域重新绘制后触发 |
| onBeforeBatchUpdate | 在 batchUpdate 方法执行之前触发 |
| onBeforeCollapse | 当用户点击展开图标,将调度器的大小从"全屏"切换回其原始大小时触发。 |
| onBeforeDrag | 当用户开始拖动或调整大小操作时触发(自版本 2.1+ 起可用) |
| onBeforeEventChanged | 当通过拖拽修改事件但更改尚未保存时触发。 |
| onBeforeEventCreated | 当用户通过拖动光标在scheduler上创建新事件时触发 |
| onBeforeEventDelete | 在用户点击删除按钮(无论是在事件栏还是详情窗口)后立即触发 |
| onBeforeEventDisplay | 在调用 'showEvent' 方法显示特定事件之前触发,允许您在事件出现之前运行代码。 |
| onBeforeEventDragIn | 在被拖动的事件进入 scheduler 区域之前触发 |
| onBeforeEventDragOut | 在事件被拖出调度器之前触发 |
| onBeforeEventPasted | 在用户按下 'CTRL+V' 快捷键之前触发 |
| onBeforeExpand | 当用户点击展开图标,将调度器从原始大小切换到"全屏"时触发。 |
| onBeforeExternalDragIn | 在元素开始从外部 DHTMLX 组件拖入 scheduler 之前触发(需要启用 dnd 扩展) |
| onBeforeFolderToggle | 在树状分支打开或关闭之前触发(仅适用于Timeline视图的"tree"模式) |
| onBeforeLightbox | 在用户打开lightbox(编辑表单)之前触发 |
| onBeforeParse | 在数据解析开始之前触发 |
| onBeforeQuickInfo | 在 Quick Info 弹出窗口显示之前触发的事件 |
| onBeforeSectionRender | 在单个 Timeline 区段设置但尚未渲染之前触发(仅适用于 Timeline 视图) |
| onBeforeTodayDisplayed | 当调度器中的"Today"按钮被点击时触发 |
| onBeforeTooltip | 在 tooltip 即将显示于某个数据项之前触发(仅当启用 'tooltip' 扩展时生效) |
| onBeforeViewChange | 在用户从当前视图切换到另一个视图之前触发 |
| onCellClick | 当用户单击单元格时触发(仅适用于Timeline视图) |
| onCellDblClick | 当用户双击单元格时触发(仅限时间线视图) |
| onClearAll | 当调度器的数据被清除后触发一次 |
| onClick | 当用户点击事件的左键鼠标时触发 |
| onCollapse | 当用户点击展开图标,将调度器从"全屏"切换回原始大小时触发。 |
| onConfirmedBeforeEventDelete | 当用户点击删除按钮并确认删除(无论是在事件条还是详情窗口中)后立即触发 |
| onContextMenu | 当用户在调度器内右键点击以打开上下文菜单时触发 |
| onDataRender | 当数据完 成在页面上的渲染时触发 |
| onDblClick | 当用户双击某个事件时触发 |
| onDestroy | 当使用 destructor 方法清除调度器后触发一次 |
| onDragEnd | 当拖拽或调整大小操作完成时触发 |
| onEmptyClick | 当用户点击调度器中空白区域(非事件部分)时触发 |
| onError | 当 assert 返回 'false' 值时触发,表示断言失败。 |
| onEventAdded | 当调度器中添加新事件时触发 |
| onEventCancel | 当用户在lightbox(编辑表单)中按下"取消"按钮时触发 |
| onEventChanged | 当用户完成编辑事件并保存更新后触发(在事件栏或详情窗口中点击编辑和保存按钮之后) |
| onEventCollision | 当用户尝试在已被占用的时间段内创建新事件或修改现有事件时触发 |
| onEventCopied | 当用户按下 'CTRL+C' 键盘快捷键时触发(仅在启用了 'keyboard navigation' 扩展时有效) |
| onEventCreated | 当用户开始创建新事件时触发(通过双击或拖动) |
| onEventCut | 当用户按下 'CTRL+X' 快捷键时触发该事件(仅当启用了"keyboard navigation"扩展时有效) |
| onEventDeleted | 在事件被删除后立即触发(自版本 3.0+ 起可用) |
| onEventDrag | 当事件在调度器中被拖动或调整大小时触发 |
| onEventDragIn | 当拖动的事件进入调度器时触发 |
| onEventDragOut | 当拖拽的事件离开scheduler区域时触发 |
| onEventDropOut | 当拖拽的事件被放置到调度器区域外时触发 |
| onEventIdChange | 当事件的 id 更新时触发 |
| onEventLoading | 当事件从数据源加载时触发 |
| onEventPasted | 当用户按下 'CTRL+V' 键盘快捷键时触发 |
| onEventSave | 当用户点击 lightbox(编辑表单)中的"保存"按钮时触发 |
| onEventSelected | 当用户在调度器中选择一个事件时触发 |
| onEventUnselected | 当用户通过选择另一个事件取消选择某个事件时触发 |
| onExpand |