dhtmlx-scheduler 6.0.4 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (226) hide show
  1. package/README.md +3 -3
  2. package/bower.json +1 -1
  3. package/codebase/dhtmlxscheduler.css +1 -10
  4. package/codebase/dhtmlxscheduler.d.ts +192 -9
  5. package/codebase/dhtmlxscheduler.es.d.ts +2310 -0
  6. package/codebase/dhtmlxscheduler.es.js +8104 -0
  7. package/codebase/dhtmlxscheduler.es.js.map +1 -0
  8. package/codebase/dhtmlxscheduler.js +76 -36
  9. package/codebase/dhtmlxscheduler.js.map +1 -1
  10. package/codebase/sources/dhtmlxscheduler.css +3172 -2607
  11. package/codebase/sources/dhtmlxscheduler.es.js +16322 -0
  12. package/codebase/sources/dhtmlxscheduler.es.js.map +1 -0
  13. package/codebase/sources/dhtmlxscheduler.js +14670 -23427
  14. package/codebase/sources/dhtmlxscheduler.js.map +1 -0
  15. package/codebase/sources/less/package.json +2 -8
  16. package/codebase/sources/less/scripts.js +4 -3
  17. package/codebase/sources/less/src/agenda.less +70 -0
  18. package/codebase/sources/less/src/agenda_legacy.less +68 -0
  19. package/codebase/sources/less/src/base.less +415 -0
  20. package/codebase/sources/less/src/buttons.less +203 -0
  21. package/codebase/sources/less/src/columns_event.less +216 -0
  22. package/codebase/sources/less/src/columns_view.less +115 -0
  23. package/codebase/sources/less/src/datepicker.less +279 -0
  24. package/codebase/sources/less/src/grid_view.less +68 -0
  25. package/codebase/sources/less/src/iconfont/dhx-scheduler-icons.woff +0 -0
  26. package/codebase/sources/less/src/iconfont/dhx-scheduler-icons.woff2 +0 -0
  27. package/codebase/sources/less/src/icons.less +228 -0
  28. package/codebase/sources/less/src/imgs/alert.svg +3 -0
  29. package/codebase/sources/less/src/imgs/arrow/down.svg +3 -0
  30. package/codebase/sources/less/src/imgs/arrow/left.svg +3 -0
  31. package/codebase/sources/less/src/imgs/arrow/right.svg +3 -0
  32. package/codebase/sources/less/src/imgs/arrow/up.svg +3 -0
  33. package/codebase/sources/less/src/imgs/calendar.svg +3 -0
  34. package/codebase/sources/less/src/imgs/cancel.svg +3 -0
  35. package/codebase/sources/less/src/imgs/check.svg +3 -0
  36. package/codebase/sources/less/src/imgs/chevron/down.svg +3 -0
  37. package/codebase/sources/less/src/imgs/chevron/left.svg +3 -0
  38. package/codebase/sources/less/src/imgs/chevron/right.svg +3 -0
  39. package/codebase/sources/less/src/imgs/chevron/up.svg +3 -0
  40. package/codebase/sources/less/src/imgs/clock.svg +3 -0
  41. package/codebase/sources/less/src/imgs/close.svg +3 -0
  42. package/codebase/sources/less/src/imgs/delete.svg +3 -0
  43. package/codebase/sources/less/src/imgs/details.svg +3 -0
  44. package/codebase/sources/less/src/imgs/dots/h.svg +3 -0
  45. package/codebase/sources/less/src/imgs/dots/v.svg +3 -0
  46. package/codebase/sources/less/src/imgs/drag.svg +3 -0
  47. package/codebase/sources/less/{skins/material/imgs_dhx_material/drag-horizontal.svg → src/imgs/drag_horizontal.svg} +1 -1
  48. package/codebase/sources/less/{skins/material/imgs_dhx_material/drag-vertical.svg → src/imgs/drag_vertical.svg} +0 -3
  49. package/codebase/sources/less/src/imgs/edit.svg +4 -0
  50. package/codebase/sources/less/src/imgs/form.svg +3 -0
  51. package/codebase/sources/less/src/imgs/iclose.svg +3 -0
  52. package/codebase/sources/less/src/imgs/loading.svg +3 -0
  53. package/codebase/sources/less/src/imgs/menu/down.svg +3 -0
  54. package/codebase/sources/less/src/imgs/menu/right.svg +3 -0
  55. package/codebase/sources/less/src/imgs/menu.svg +1 -0
  56. package/codebase/sources/less/src/imgs/ok.svg +10 -0
  57. package/codebase/sources/less/src/imgs/plus.svg +3 -0
  58. package/codebase/sources/less/src/imgs/save.svg +3 -0
  59. package/codebase/sources/less/src/imgs/sort/asc.svg +3 -0
  60. package/codebase/sources/less/src/imgs/sort/desc.svg +3 -0
  61. package/codebase/sources/less/src/index.less +22 -0
  62. package/codebase/sources/less/src/layout.less +0 -0
  63. package/codebase/sources/less/src/lightbox.less +480 -0
  64. package/codebase/sources/less/src/misc.less +46 -0
  65. package/codebase/sources/less/src/modals.less +138 -0
  66. package/codebase/sources/less/src/month_event.less +85 -0
  67. package/codebase/sources/less/src/month_view.less +112 -0
  68. package/codebase/sources/less/src/quick_info.less +145 -0
  69. package/codebase/sources/less/src/themes/contrast_black.less +51 -0
  70. package/codebase/sources/less/src/themes/contrast_white.less +51 -0
  71. package/codebase/sources/less/src/themes/dark.less +34 -0
  72. package/codebase/sources/less/src/themes/flat.less +108 -0
  73. package/codebase/sources/less/src/themes/index.less +6 -0
  74. package/codebase/sources/less/src/themes/material.less +138 -0
  75. package/codebase/sources/less/src/themes/variables.less +263 -0
  76. package/codebase/sources/less/src/timeline.less +269 -0
  77. package/codebase/sources/less/src/tooltip.less +21 -0
  78. package/codebase/sources/less/src/week_agenda_view.less +80 -0
  79. package/codebase/sources/less/src/year_view.less +83 -0
  80. package/codebase/sources/less/theme.less +2 -0
  81. package/package.json +3 -3
  82. package/whatsnew.md +28 -0
  83. package/codebase/dhtmlxscheduler_contrast_black.css +0 -10
  84. package/codebase/dhtmlxscheduler_contrast_white.css +0 -10
  85. package/codebase/dhtmlxscheduler_flat.css +0 -10
  86. package/codebase/dhtmlxscheduler_material.css +0 -10
  87. package/codebase/dhtmlxscheduler_material_nofont.css +0 -10
  88. package/codebase/dhtmlxscheduler_terrace.css +0 -10
  89. package/codebase/sources/less/dhtmlxscheduler.less +0 -9
  90. package/codebase/sources/less/dhtmlxscheduler_contrast_black.less +0 -3
  91. package/codebase/sources/less/dhtmlxscheduler_contrast_white.less +0 -3
  92. package/codebase/sources/less/dhtmlxscheduler_flat.less +0 -2
  93. package/codebase/sources/less/dhtmlxscheduler_material.less +0 -5
  94. package/codebase/sources/less/dhtmlxscheduler_material_nofont.less +0 -3
  95. package/codebase/sources/less/dhtmlxscheduler_terrace.less +0 -2
  96. package/codebase/sources/less/skins/basic/clear.less +0 -106
  97. package/codebase/sources/less/skins/basic/ext.less +0 -1135
  98. package/codebase/sources/less/skins/basic/imgs/but_repeat.gif +0 -0
  99. package/codebase/sources/less/skins/basic/imgs/buttons.png +0 -0
  100. package/codebase/sources/less/skins/basic/imgs/calendar.gif +0 -0
  101. package/codebase/sources/less/skins/basic/imgs/clock_big.gif +0 -0
  102. package/codebase/sources/less/skins/basic/imgs/clock_small.gif +0 -0
  103. package/codebase/sources/less/skins/basic/imgs/collapse_expand_icon.gif +0 -0
  104. package/codebase/sources/less/skins/basic/imgs/controls.gif +0 -0
  105. package/codebase/sources/less/skins/basic/imgs/databg.png +0 -0
  106. package/codebase/sources/less/skins/basic/imgs/databg_now.png +0 -0
  107. package/codebase/sources/less/skins/basic/imgs/export_ical.png +0 -0
  108. package/codebase/sources/less/skins/basic/imgs/export_pdf.png +0 -0
  109. package/codebase/sources/less/skins/basic/imgs/icon.png +0 -0
  110. package/codebase/sources/less/skins/basic/imgs/images.png +0 -0
  111. package/codebase/sources/less/skins/basic/imgs/loading.gif +0 -0
  112. package/codebase/sources/less/skins/basic/imgs/resize_dots.png +0 -0
  113. package/codebase/sources/less/skins/basic/index.less +0 -7
  114. package/codebase/sources/less/skins/basic/layout.less +0 -638
  115. package/codebase/sources/less/skins/basic/lightbox.less +0 -423
  116. package/codebase/sources/less/skins/basic/lightbox_responsive.less +0 -322
  117. package/codebase/sources/less/skins/basic/message_default.less +0 -242
  118. package/codebase/sources/less/skins/basic/note.less +0 -272
  119. package/codebase/sources/less/skins/basic/recurring.less +0 -168
  120. package/codebase/sources/less/skins/basic/skin.less +0 -735
  121. package/codebase/sources/less/skins/basic/suite.less +0 -8
  122. package/codebase/sources/less/skins/contrast_black/add_styles.less +0 -519
  123. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/arrow_left.png +0 -0
  124. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/arrow_right.png +0 -0
  125. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/but_repeat.gif +0 -0
  126. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/calendar.gif +0 -0
  127. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/clock_big.gif +0 -0
  128. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/clock_small.gif +0 -0
  129. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/close_icon.png +0 -0
  130. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/collapse_expand_icon.gif +0 -0
  131. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/controls.png +0 -0
  132. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/databg.png +0 -0
  133. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/databg_now.png +0 -0
  134. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/export_ical.png +0 -0
  135. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/export_pdf.png +0 -0
  136. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/resize_dots.png +0 -0
  137. package/codebase/sources/less/skins/contrast_black/imgs_contrast_black/resizing.png +0 -0
  138. package/codebase/sources/less/skins/contrast_black/index.less +0 -4
  139. package/codebase/sources/less/skins/contrast_black/skin.less +0 -758
  140. package/codebase/sources/less/skins/contrast_white/dhx_skin_contrast_white.less +0 -1017
  141. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/arrow_left.png +0 -0
  142. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/arrow_right.png +0 -0
  143. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/but_repeat.gif +0 -0
  144. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/calendar.gif +0 -0
  145. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/clock_big.gif +0 -0
  146. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/clock_small.gif +0 -0
  147. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/close_icon.png +0 -0
  148. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/collapse_expand_icon.gif +0 -0
  149. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/controls.png +0 -0
  150. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/databg.png +0 -0
  151. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/export_ical.png +0 -0
  152. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/export_pdf.png +0 -0
  153. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/quick_info_edit.png +0 -0
  154. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/resize_dots.png +0 -0
  155. package/codebase/sources/less/skins/contrast_white/imgs_contrast_white/resizing.png +0 -0
  156. package/codebase/sources/less/skins/contrast_white/index.less +0 -4
  157. package/codebase/sources/less/skins/flat/add_styles.less +0 -286
  158. package/codebase/sources/less/skins/flat/imgs_flat/agenda_bg.gif +0 -0
  159. package/codebase/sources/less/skins/flat/imgs_flat/arrow_left.png +0 -0
  160. package/codebase/sources/less/skins/flat/imgs_flat/arrow_right.png +0 -0
  161. package/codebase/sources/less/skins/flat/imgs_flat/but_repeat.gif +0 -0
  162. package/codebase/sources/less/skins/flat/imgs_flat/calendar.gif +0 -0
  163. package/codebase/sources/less/skins/flat/imgs_flat/clock.png +0 -0
  164. package/codebase/sources/less/skins/flat/imgs_flat/clock_big.gif +0 -0
  165. package/codebase/sources/less/skins/flat/imgs_flat/clock_small.gif +0 -0
  166. package/codebase/sources/less/skins/flat/imgs_flat/close_icon.png +0 -0
  167. package/codebase/sources/less/skins/flat/imgs_flat/collapse_expand_icon.gif +0 -0
  168. package/codebase/sources/less/skins/flat/imgs_flat/controls.png +0 -0
  169. package/codebase/sources/less/skins/flat/imgs_flat/databg.png +0 -0
  170. package/codebase/sources/less/skins/flat/imgs_flat/databg_now.png +0 -0
  171. package/codebase/sources/less/skins/flat/imgs_flat/export_ical.png +0 -0
  172. package/codebase/sources/less/skins/flat/imgs_flat/export_pdf.png +0 -0
  173. package/codebase/sources/less/skins/flat/imgs_flat/resize_dots.png +0 -0
  174. package/codebase/sources/less/skins/flat/imgs_flat/resizing.png +0 -0
  175. package/codebase/sources/less/skins/flat/index.less +0 -4
  176. package/codebase/sources/less/skins/flat/skin.less +0 -674
  177. package/codebase/sources/less/skins/material/add_styles.less +0 -2055
  178. package/codebase/sources/less/skins/material/imgs_dhx_material/Shape.svg +0 -3
  179. package/codebase/sources/less/skins/material/imgs_dhx_material/agenda-calendar-hov.svg +0 -4
  180. package/codebase/sources/less/skins/material/imgs_dhx_material/agenda-calendar.svg +0 -4
  181. package/codebase/sources/less/skins/material/imgs_dhx_material/agenda_bg.png +0 -0
  182. package/codebase/sources/less/skins/material/imgs_dhx_material/arrow_left.svg +0 -3
  183. package/codebase/sources/less/skins/material/imgs_dhx_material/arrow_left_hov.svg +0 -3
  184. package/codebase/sources/less/skins/material/imgs_dhx_material/arrow_right.svg +0 -3
  185. package/codebase/sources/less/skins/material/imgs_dhx_material/arrow_right_hov.svg +0 -3
  186. package/codebase/sources/less/skins/material/imgs_dhx_material/but_repeat.png +0 -0
  187. package/codebase/sources/less/skins/material/imgs_dhx_material/calendar.svg +0 -4
  188. package/codebase/sources/less/skins/material/imgs_dhx_material/clock_big.png +0 -0
  189. package/codebase/sources/less/skins/material/imgs_dhx_material/clock_small.png +0 -0
  190. package/codebase/sources/less/skins/material/imgs_dhx_material/close_icon.png +0 -0
  191. package/codebase/sources/less/skins/material/imgs_dhx_material/collapse_expand_icon.png +0 -0
  192. package/codebase/sources/less/skins/material/imgs_dhx_material/controls.png +0 -0
  193. package/codebase/sources/less/skins/material/imgs_dhx_material/databg.png +0 -0
  194. package/codebase/sources/less/skins/material/imgs_dhx_material/export_ical.png +0 -0
  195. package/codebase/sources/less/skins/material/imgs_dhx_material/export_pdf.png +0 -0
  196. package/codebase/sources/less/skins/material/imgs_dhx_material/icon.png +0 -0
  197. package/codebase/sources/less/skins/material/imgs_dhx_material/menu-down.svg +0 -1
  198. package/codebase/sources/less/skins/material/imgs_dhx_material/resizing.png +0 -0
  199. package/codebase/sources/less/skins/material/imgs_dhx_material/time.svg +0 -24
  200. package/codebase/sources/less/skins/material/imgs_dhx_material/tree_arrow.svg +0 -3
  201. package/codebase/sources/less/skins/material/index.less +0 -10
  202. package/codebase/sources/less/skins/material/skin.less +0 -879
  203. package/codebase/sources/less/skins/terrace/add_styles.less +0 -351
  204. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/arrow_left.png +0 -0
  205. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/arrow_right.png +0 -0
  206. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/but_repeat.gif +0 -0
  207. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/calendar.gif +0 -0
  208. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/clock_big.gif +0 -0
  209. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/clock_small.gif +0 -0
  210. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/close_icon.png +0 -0
  211. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/collapse_expand_icon.gif +0 -0
  212. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/controls.png +0 -0
  213. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/databg.png +0 -0
  214. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/databg_now.png +0 -0
  215. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/export_ical.png +0 -0
  216. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/export_pdf.png +0 -0
  217. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/resize_dots.png +0 -0
  218. package/codebase/sources/less/skins/terrace/imgs_dhx_terrace/resizing.png +0 -0
  219. package/codebase/sources/less/skins/terrace/index.less +0 -4
  220. package/codebase/sources/less/skins/terrace/skin.less +0 -687
  221. package/codebase/sources/skins/dhtmlxscheduler_contrast_black.css +0 -3218
  222. package/codebase/sources/skins/dhtmlxscheduler_contrast_white.css +0 -3644
  223. package/codebase/sources/skins/dhtmlxscheduler_flat.css +0 -2975
  224. package/codebase/sources/skins/dhtmlxscheduler_material.css +0 -4360
  225. package/codebase/sources/skins/dhtmlxscheduler_material_nofont.css +0 -4359
  226. package/codebase/sources/skins/dhtmlxscheduler_terrace.css +0 -3080
@@ -0,0 +1,2310 @@
1
+ // Type definitions for dhtmlxScheduler <%= pkg.version %>
2
+ // Project: http://dhtmlx.com/docs/products/dhtmlxScheduler
3
+
4
+ type SchedulerCallback = (...args: any[]) => any;
5
+ type SchedulerFilterCallback = { (id: string | number, event: any): boolean }
6
+
7
+
8
+ type SchedulerEventName = "onAfterEventDisplay" |
9
+ "onAfterFolderToggle" |
10
+ "onAfterLightbox" |
11
+ "onAfterQuickInfo" |
12
+ "onAfterSchedulerResize" |
13
+ "onBeforeCollapse" |
14
+ "onBeforeDrag" |
15
+ "onBeforeEventChanged" |
16
+ "onBeforeEventCreated" |
17
+ "onBeforeEventDelete" |
18
+ "onBeforeEventDisplay" |
19
+ "onBeforeEventDragIn" |
20
+ "onBeforeEventDragOut" |
21
+ "onBeforeEventPasted" |
22
+ "onBeforeExpand" |
23
+ "onBeforeExternalDragIn" |
24
+ "onBeforeFolderToggle" |
25
+ "onBeforeLightbox" |
26
+ "onBeforeParse" |
27
+ "onBeforeQuickInfo" |
28
+ "onBeforeTodayDisplayed" |
29
+ "onBeforeTooltip" |
30
+ "onBeforeViewChange" |
31
+ "onCellClick" |
32
+ "onCellDblClick" |
33
+ "onClearAll" |
34
+ "onClick" |
35
+ "onCollapse" |
36
+ "onConfirmedBeforeEventDelete" |
37
+ "onContextMenu" |
38
+ "onDataRender" |
39
+ "onDblClick" |
40
+ "onDestroy" |
41
+ "onDragEnd" |
42
+ "onEmptyClick" |
43
+ "onError" |
44
+ "onEventAdded" |
45
+ "onEventCancel" |
46
+ "onEventChanged" |
47
+ "onEventCollision" |
48
+ "onEventCopied" |
49
+ "onEventCreated" |
50
+ "onEventCut" |
51
+ "onEventDeleted" |
52
+ "onEventDrag" |
53
+ "onEventDragIn" |
54
+ "onEventDragOut" |
55
+ "onEventDropOut" |
56
+ "onEventIdChange" |
57
+ "onEventLoading" |
58
+ "onEventPasted" |
59
+ "onEventSave" |
60
+ "onEventSelected" |
61
+ "onEventUnselected" |
62
+ "onExpand" |
63
+ "onExternalDragIn" |
64
+ "onLightbox" |
65
+ "onLightboxButton" |
66
+ "onLimitViolation" |
67
+ "onLoadEnd" |
68
+ "onLoadError" |
69
+ "onLoadStart" |
70
+ "onLocationError" |
71
+ "onMouseDown" |
72
+ "onMouseMove" |
73
+ "onOptionsLoad" |
74
+ "onOptionsLoadFinal" |
75
+ "onOptionsLoadStart" |
76
+ "onParse" |
77
+ "onQuickInfo" |
78
+ "onSaveError" |
79
+ "onScaleAdd" |
80
+ "onScaleDblClick" |
81
+ "onSchedulerReady" |
82
+ "onSchedulerResize" |
83
+ "onTemplatesReady" |
84
+ "onTimelineCreated" |
85
+ "onViewChange" |
86
+ "onViewMoreClick" |
87
+ "onXLE" |
88
+ "onXLS" |
89
+ "onXScaleClick" |
90
+ "onXScaleDblClick" |
91
+ "onYScaleClick" |
92
+ "onYScaleDblClick";
93
+
94
+
95
+ export interface SchedulerTemplates {
96
+
97
+ /**
98
+ * specifies the date in the header of the view
99
+ * @param start the start date of the view
100
+ * @param end the end date of the view
101
+ */
102
+ agenda_date(start: Date, end: Date): string;
103
+
104
+ /**
105
+ * specifies the content of the day cell of the Agenda view
106
+ */
107
+ agenda_day(): void;
108
+
109
+ /**
110
+ * specifies the text in the second column of the Agenda view
111
+ * @param start the date when an event is scheduled to begin
112
+ * @param end the date when an event is scheduled to be completed
113
+ * @param event the event object
114
+ */
115
+ agenda_text(start: Date, end: Date, event: any): string;
116
+
117
+ /**
118
+ * specifies the date in the first column of the Agenda view
119
+ * @param start the date when an event is scheduled to begin
120
+ * @param end the date when an event is scheduled to be completed
121
+ * @param event the event object
122
+ */
123
+ agenda_time(start: Date, end: Date, event: any): string;
124
+
125
+ /**
126
+ * specifies the format of dates that are set by means of API methods. Used to parse incoming dates
127
+ * @param date the date which needs formatting
128
+ */
129
+ api_date(date: Date): string;
130
+
131
+ /**
132
+ * specifies the content of day-cells in the Mini-Calendar (date picker)
133
+ * @param date the cell's date
134
+ */
135
+ calendar_date(date: Date): string;
136
+
137
+ /**
138
+ * specifies the date in the header of the Mini-Calendar (date picker)
139
+ * @param date the first day of a selected month
140
+ */
141
+ calendar_month(date: Date): string;
142
+
143
+ /**
144
+ * specifies the format of week-days in the header of the Mini-Calendar (date picker)
145
+ * @param date the date of a week-day for a header cell
146
+ */
147
+ calendar_scale_date(date: Date): string;
148
+
149
+ /**
150
+ * specifies the date format of the lightbox's start and end date inputs
151
+ * @param date the date which needs formatting
152
+ */
153
+ calendar_time(date: Date): string;
154
+
155
+ /**
156
+ * specifies the date in the header of the Day and Units views
157
+ * @param date the date which needs formatting
158
+ */
159
+ day_date(date: Date): string;
160
+
161
+ /**
162
+ * specifies the date in the sub-header of the Day view
163
+ * @param date the date which needs formatting
164
+ */
165
+ day_scale_date(date: Date): string;
166
+
167
+ /**
168
+ * specifies the CSS class that will be applied to the highlighted event's duration on the time scale
169
+ * @param start the date when an event is scheduled to begin
170
+ * @param end the date when an event is scheduled to be completed
171
+ * @param ev the event's object
172
+ */
173
+ drag_marker_class(start: Date, end: Date, ev: any): void;
174
+
175
+ /**
176
+ * specifies the content of the highlighted block on the time scale
177
+ * @param start the date when an event is scheduled to begin
178
+ * @param end the date when an event is scheduled to be completed
179
+ * @param ev the event's object
180
+ */
181
+ drag_marker_content(start: Date, end: Date, ev: any): void;
182
+
183
+ /**
184
+ * specifies the date of an event. Applied to one-day events only
185
+ * @param start the date when an event is scheduled to begin
186
+ * @param end the date when an event is scheduled to be completed
187
+ * @param event the event object
188
+ */
189
+ event_bar_date(start: Date, end: Date, event: any): string;
190
+
191
+ /**
192
+ * specifies the event's text. Applied to multi-day events only
193
+ * @param start the date when an event is scheduled to begin
194
+ * @param end the date when an event is scheduled to be completed
195
+ * @param event the event's object
196
+ */
197
+ event_bar_text(start: Date, end: Date, event: any): string;
198
+
199
+ /**
200
+ * specifies the CSS class that will be applied to the event's container
201
+ * @param start the date when an event is scheduled to begin
202
+ * @param end the date when an event is scheduled to be completed
203
+ * @param ev the event's object
204
+ */
205
+ event_class(start: Date, end: Date, ev: any): string;
206
+
207
+ /**
208
+ * specifies the time part of the start and end dates of the event. Mostly used by other templates for presenting time periods
209
+ * @param date the date which needs formatting
210
+ */
211
+ event_date(date: Date): string;
212
+
213
+ /**
214
+ * specifies the event's header
215
+ * @param start the date when an event is scheduled to begin
216
+ * @param end the date when an event is scheduled to be completed
217
+ * @param event the event's object
218
+ */
219
+ event_header(start: Date, end: Date, event: any): string;
220
+
221
+ /**
222
+ * specifies the event's text
223
+ * @param start the date when an event is scheduled to begin
224
+ * @param end the date when an event is scheduled to be completed
225
+ * @param event the event object
226
+ */
227
+ event_text(start: Date, end: Date, event: any): string;
228
+
229
+ /**
230
+ * сonverts date object to a date string. Used to send data back to the server
231
+ * @param date the date which needs formatting
232
+ */
233
+ format_date(date: Date): string;
234
+
235
+ /**
236
+ * specifies the items of the Y-Axis
237
+ * @param date the date which needs formatting
238
+ */
239
+ hour_scale(date: Date): string;
240
+
241
+ /**
242
+ * specifies the format of requests in the dynamic loading mode
243
+ * @param date the date which needs formatting
244
+ */
245
+ load_format(date: Date): string;
246
+
247
+ /**
248
+ * specifies the date in the header of the view
249
+ * @param start the start date of the view
250
+ * @param end the end date of the view
251
+ */
252
+ map_date(start: Date, end: Date): string;
253
+
254
+ /**
255
+ * specifies the text in the second column of the view
256
+ * @param start the date when an event is scheduled to begin
257
+ * @param end the date when an event is scheduled to be completed
258
+ * @param event the event object
259
+ */
260
+ map_text(start: Date, end: Date, event: any): string;
261
+
262
+ /**
263
+ * specifies the date in the first column of the view
264
+ * @param start the date when an event is scheduled to begin
265
+ * @param end the date when an event is scheduled to be completed
266
+ * @param event the event object
267
+ */
268
+ map_time(start: Date, end: Date, event: any): string;
269
+
270
+ /**
271
+ * specifies the date of the event in the Google Maps popup marker
272
+ * @param start the date when an event is scheduled to begin
273
+ * @param end the date when an event is scheduled to be completed
274
+ * @param event the event object
275
+ */
276
+ marker_date(start: Date, end: Date, event: any): string;
277
+
278
+ /**
279
+ * specifies the text of the event in the Google Maps popup marker
280
+ * @param start the date when an event is scheduled to begin
281
+ * @param end the date when an event is scheduled to be completed
282
+ * @param event the event object
283
+ */
284
+ marker_text(start: Date, end: Date, event: any): string;
285
+
286
+ /**
287
+ * specifies the date in the header of the view
288
+ * @param date the date which needs formatting
289
+ */
290
+ month_date(date: Date): string;
291
+
292
+ /**
293
+ * specifies the CSS class that will be applied to a day cell
294
+ * @param date the date which needs formatting
295
+ */
296
+ month_date_class(date: Date): string;
297
+
298
+ /**
299
+ * specifies the format of the day in a cell
300
+ * @param date the date which needs formatting
301
+ */
302
+ month_day(date: Date): string;
303
+
304
+ /**
305
+ * specifies the presentation of the 'View more' link in a cell of the Month view
306
+ * @param date the date of a month cell
307
+ * @param count the number of events in the cell
308
+ */
309
+ month_events_link(date: Date, count: number): string;
310
+
311
+ /**
312
+ * specifies the date format of the X-Axis of the view
313
+ * @param date the date which needs formatting
314
+ */
315
+ month_scale_date(date: Date): string;
316
+
317
+ /**
318
+ * converts date string into a Date object
319
+ * @param date the string which need to be parsed
320
+ */
321
+ parse_date(date: string): Date;
322
+
323
+ /**
324
+ * specifies the content of the pop-up edit form
325
+ * @param start the date when an event is scheduled to begin
326
+ * @param end the date when an event is scheduled to be completed
327
+ * @param event the event object
328
+ */
329
+ quick_info_content(start: Date, end: Date, event: any): string;
330
+
331
+ /**
332
+ * specifies the date of the pop-up edit form
333
+ * @param start the date when an event is scheduled to begin
334
+ * @param end the date when an event is scheduled to be completed
335
+ * @param event the event object
336
+ */
337
+ quick_info_date(start: Date, end: Date, event: any): string;
338
+
339
+ /**
340
+ * specifies the title of the pop-up edit form
341
+ * @param start the date when an event is scheduled to begin
342
+ * @param end the date when an event is scheduled to be completed
343
+ * @param event the event object
344
+ */
345
+ quick_info_title(start: Date, end: Date, event: any): string;
346
+
347
+ /**
348
+ * specifies the drop-down time selector in the lightbox
349
+ */
350
+ time_picker(): string;
351
+
352
+ /**
353
+ * specifies the css class of background cell in Day/Week views
354
+ */
355
+ time_slot_class(): void;
356
+
357
+ /**
358
+ * specifies the content of background cell in Day/Week views
359
+ */
360
+ time_slot_text(): void;
361
+
362
+ /**
363
+ * specifies the format of start and end dates displayed in the tooltip
364
+ * @param date the date which needs formatting
365
+ */
366
+ tooltip_date_format(date: Date): string;
367
+
368
+ /**
369
+ * specifies the text of tooltips
370
+ * @param start the date when an event is scheduled to begin
371
+ * @param end the date when an event is scheduled to be completed
372
+ * @param event the event object
373
+ */
374
+ tooltip_text(start: Date, end: Date, event: any): string;
375
+
376
+ /**
377
+ * specifies the date in the header of the Week Agenda view
378
+ * @param start the start date of the view
379
+ * @param end the end date of the view
380
+ */
381
+ week_agenda_date(start: Date, end: Date): void;
382
+
383
+ /**
384
+ * specifies the event's text
385
+ * @param start the date when an event is scheduled to begin
386
+ * @param end the date when an event is scheduled to be completed
387
+ * @param event the event object
388
+ * @param cellDate the date of a day cell that a one-day event or a single occurrence of <br> the recurring event displays in
389
+ * @param pos the position of a single occurrence in the recurring event: 'start' - the first occurrence, 'end' - the last occurrence, 'middle' - for remaining occurrences
390
+ */
391
+ week_agenda_event_text(start: Date, end: Date, event: any, cellDate: Date, pos: string): string;
392
+
393
+ /**
394
+ * the date of a day cell of the view
395
+ * @param date the date which needs formatting
396
+ */
397
+ week_agenda_scale_date(date: Date): string;
398
+
399
+ /**
400
+ * specifies the date in the header of the view
401
+ * @param start the start date of the view
402
+ * @param end the end date of the view
403
+ */
404
+ week_date(start: Date, end: Date): string;
405
+
406
+ /**
407
+ * specifies the CSS class that will be applied to a day cell
408
+ * @param start the start date of the column
409
+ * @param today the current date
410
+ */
411
+ week_date_class(start: Date, today: Date): string;
412
+
413
+ /**
414
+ * specifies the date in the sub-header of the view
415
+ * @param date the date which needs formatting
416
+ */
417
+ week_scale_date(date: Date): string;
418
+
419
+ /**
420
+ * specifies the date in the header of the view
421
+ * @param date the date which needs formatting
422
+ */
423
+ year_date(date: Date): string;
424
+
425
+ /**
426
+ * specifies the month's name in the header of a month block of the view.
427
+ * @param date the date which needs formatting
428
+ */
429
+ year_month(date: Date): string;
430
+
431
+ /**
432
+ * specifies the day's name in the sub-header of a month block of the view
433
+ * @param date the date which needs formatting
434
+ */
435
+ year_scale_date(date: Date): string;
436
+
437
+ /**
438
+ * specifies the tooltip over a day cell containing some scheduled event(s)
439
+ * @param start the date when an event is scheduled to begin
440
+ * @param end the date when an event is scheduled to be completed
441
+ * @param event the event object
442
+ */
443
+ year_tooltip(start: Date, end: Date, event: any): string;
444
+
445
+ /**
446
+ * specifies the lightbox's header
447
+ * @param start the date when an event is scheduled to begin
448
+ * @param end the date when an event is scheduled to be completed
449
+ * @param event the event object
450
+ */
451
+ lightbox_header(start: Date, end: Date, event: any): string;
452
+
453
+ /**
454
+ * specifies the date in the header of the view
455
+ * @param start the start date of the view
456
+ * @param end the end date of the view
457
+ */
458
+ grid_date(start: Date, end: Date): string;
459
+
460
+ /**
461
+ * specifies the format of dates in columns with id='date'
462
+ * @param start the date when an event is scheduled to begin
463
+ * @param end the date when an event is scheduled to be completed
464
+ * @param ev the event object
465
+ */
466
+ grid_full_date(start: Date, end: Date, ev: any): string;
467
+
468
+ /**
469
+ * specifies the format of dates in columns with id='start_date' or id='end_date'
470
+ * @param date the date which needs formatting
471
+ */
472
+ grid_single_date(date: Date): string;
473
+
474
+ /**
475
+ * specifies the text in the columns
476
+ * @param field_name the column's id
477
+ * @param event the event object
478
+ */
479
+ grid_field(field_name: string, event: any): string;
480
+
481
+ /**
482
+ * specifies the number of scheduled events in a cell of the view
483
+ * @param evs an array of objects of events contained in a cell
484
+ * @param date the date of a cell
485
+ * @param section the section object
486
+ */
487
+ timeline_cell_value(evs: any[], date: Date, section: any): string;
488
+
489
+ /**
490
+ * specifies the CSS class that will be applied to a cell of the view
491
+ * @param evs an array of objects of events contained in a cell (defined only in the 'cell' mode)
492
+ * @param date the date of a column
493
+ * @param section the section object
494
+ */
495
+ timeline_cell_class(evs: any[], date: Date, section: any): string;
496
+
497
+ /**
498
+ * specifies the name of a CSS class that will be applied to items of the X-Axis
499
+ * @param date the date which needs formatting
500
+ */
501
+ timeline_scalex_class(date: Date): string;
502
+
503
+ /**
504
+ * specifies the name of a CSS class that will be applied to items of the second X-Axis
505
+ * @param date the date which needs formatting
506
+ */
507
+ timeline_second_scalex_class(date: Date): string;
508
+
509
+ /**
510
+ * specifies the name of a CSS class that will be applied to items of the Y-Axis
511
+ * @param key the section's id
512
+ * @param label the section's label
513
+ * @param section the section object that contains the 'key' and 'label' properties
514
+ */
515
+ timeline_scaley_class(key: string, label: string, section: any): string;
516
+
517
+ /**
518
+ * specifies items of the Y-Axis
519
+ * @param key the section's id (key)
520
+ * @param label the section's label
521
+ * @param section the section object containing the 'key' and 'label' properties
522
+ */
523
+ timeline_scale_label(key: string, label: string, section: any): string;
524
+
525
+ /**
526
+ * specifies the tooltip over a day cell containing some scheduled event(s)
527
+ * @param start the date when an event is scheduled to begin
528
+ * @param end the date when an event is scheduled to be completed
529
+ * @param event the event object
530
+ */
531
+ timeline_tooltip(start: Date, end: Date, event: any): string;
532
+
533
+ /**
534
+ * specifies the date in the header of the view
535
+ * @param date1 the date when an event is scheduled to begin
536
+ * @param date2 the date when an event is scheduled to be completed
537
+ */
538
+ timeline_date(date1: Date, date2: Date): string;
539
+
540
+ /**
541
+ * specifies items of the X-Axis
542
+ * @param date the date which needs formatting
543
+ */
544
+ timeline_scale_date(date: Date): string;
545
+
546
+ /**
547
+ * specifies items of the second X-Axis
548
+ * @param date the date which needs formatting
549
+ */
550
+ timeline_second_scale_date(date: Date): string;
551
+
552
+ /**
553
+ * specifies the date in the header of the view
554
+ * @param date the date which needs formatting
555
+ */
556
+ unit_date(date: Date): string;
557
+
558
+ /**
559
+ * specifies items of the X-Axis
560
+ * @param key the unit's id (key)
561
+ * @param label the unit's label
562
+ * @param unit the unit object containing the 'key' and 'label' properties
563
+ * @param date the date of a column (for multi-day Units view)
564
+ */
565
+ unit_scale_text(key: string, label: string, unit: any, date: Date): string;
566
+
567
+ /**
568
+ * a string from an XML file is converted into a date object in conformity with this template
569
+ * @param date the string which need to be parsed
570
+ */
571
+ xml_date(date: string): Date;
572
+
573
+ /**
574
+ * a date object is converted into a string in conformity with this template. Used to send data back to the server
575
+ * @param date the date which needs formatting
576
+ */
577
+ xml_format(date: Date): string;
578
+
579
+ /**
580
+ * specifies the CSS class that will be applied to a row of the Timeline view
581
+ * @param section the section object
582
+ * @param timeline the timeline object
583
+ */
584
+ timeline_row_class(section: any, timeline: any): string;
585
+
586
+ [customTemplate: string]: any;
587
+ }
588
+
589
+ export interface SchedulerConfigOptions {
590
+
591
+ /**
592
+ * 'says' to present the numbers of days in the Month view as clickable links that open the related day in the specified view
593
+ */
594
+ active_link_view: string;
595
+
596
+ /**
597
+ * sets the date to display events until
598
+ */
599
+ agenda_end: Date;
600
+
601
+ /**
602
+ * sets the date to start displaying events from
603
+ */
604
+ agenda_start: Date;
605
+
606
+ /**
607
+ * specifies how to display the default error notification in case the XML data loading failed
608
+ */
609
+ ajax_error: string|boolean;
610
+
611
+ /**
612
+ * 'says' to show multi-day events in the regular way (as one-day events are displayed)
613
+ */
614
+ all_timed: boolean|string;
615
+
616
+ /**
617
+ * defines the date format for the <strong>api_date</strong> template
618
+ */
619
+ api_date: string;
620
+
621
+ /**
622
+ * enables automatic changing of the end event date after changing the start date
623
+ */
624
+ auto_end_date: boolean;
625
+
626
+ /**
627
+ * stores a collection of buttons resided in the left bottom corner of the lightbox
628
+ */
629
+ buttons_left: any[];
630
+
631
+ /**
632
+ * stores a collection of buttons resided in the right bottom corner of the lightbox
633
+ */
634
+ buttons_right: any[];
635
+
636
+ /**
637
+ * sets the maximum number of events in a cascade
638
+ */
639
+ cascade_event_count: number;
640
+
641
+ /**
642
+ * sets the 'cascade' display mode
643
+ */
644
+ cascade_event_display: boolean;
645
+
646
+ /**
647
+ * sets the left margin for a cascade of events
648
+ */
649
+ cascade_event_margin: number;
650
+
651
+ /**
652
+ * activates/disables checking of limits
653
+ */
654
+ check_limits: boolean;
655
+
656
+ /**
657
+ * sets the maximum allowable number of events per time slot
658
+ */
659
+ collision_limit: number;
660
+
661
+ /**
662
+ * forces the scheduler container to automatically change its size to show the whole content without scrolling
663
+ */
664
+ container_autoresize: boolean;
665
+
666
+ /**
667
+ * defines internal implementation of the code of date formatting methods
668
+ */
669
+ csp: boolean|string;
670
+
671
+ /**
672
+ * sets the date format that is used to parse data from a data set and to send dates back to the server
673
+ */
674
+ date_format: string;
675
+
676
+ /**
677
+ * adds padding to a view column
678
+ */
679
+ day_column_padding: number;
680
+
681
+ /**
682
+ * sets the date format for the X-Axis of the Week and Units views
683
+ */
684
+ day_date: string;
685
+
686
+ /**
687
+ * enables the possibility to create events by double click
688
+ */
689
+ dblclick_create: boolean;
690
+
691
+ /**
692
+ * sets the date format used by the templates 'day_date', 'week_date', 'day_scale_date' for setting date in the views' headers
693
+ */
694
+ default_date: string;
695
+
696
+ /**
697
+ * sets a timeout (in milliseconds) that wraps the api/scheduler_updateview.md and api/scheduler_setcurrentview.md calls (that cause re-drawing of the scheduler)
698
+ */
699
+ delay_render: number;
700
+
701
+ /**
702
+ * 'says' to use the extended form while creating new events by drag or double click
703
+ */
704
+ details_on_create: boolean;
705
+
706
+ /**
707
+ * 'says' to open the lightbox after double clicking on an event
708
+ */
709
+ details_on_dblclick: boolean;
710
+
711
+ /**
712
+ * defines whether the marked(blocked) time spans should be highlighted in the scheduler
713
+ */
714
+ display_marked_timespans: boolean;
715
+
716
+ /**
717
+ * sets the default background color for the events retrieved by the showEvent() method
718
+ */
719
+ displayed_event_color: string;
720
+
721
+ /**
722
+ * sets the default font color for the events retrieved by the showEvent() method
723
+ */
724
+ displayed_event_text_color: string;
725
+
726
+ /**
727
+ * enables the possibility to create new events by drag-and-drop
728
+ */
729
+ drag_create: boolean;
730
+
731
+ /**
732
+ * allows dragging scheduler events by any part of the body
733
+ */
734
+ drag_event_body: boolean;
735
+
736
+ /**
737
+ * highlights the event's duration on the time scale when you drags an event over the scheduler
738
+ */
739
+ drag_highlight: boolean;
740
+
741
+ /**
742
+ * restrict dragging events to the calling scheduler from any other scheduler(s)
743
+ */
744
+ drag_in: boolean;
745
+
746
+ /**
747
+ * enables the possibility to drag the lightbox by the header
748
+ */
749
+ drag_lightbox: boolean;
750
+
751
+ /**
752
+ * enables the possibility to move events by drag-and-drop
753
+ */
754
+ drag_move: boolean;
755
+
756
+ /**
757
+ * restrict dragging events from the calling scheduler to any other scheduler(s)
758
+ */
759
+ drag_out: boolean;
760
+
761
+ /**
762
+ * enables the possibility to resize events by drag-and-drop
763
+ */
764
+ drag_resize: boolean;
765
+
766
+ /**
767
+ * 'says' to open the lightbox while creating new events
768
+ */
769
+ edit_on_create: boolean;
770
+
771
+ /**
772
+ * sets the name of the attribute that will specify the id of the event's HTML element
773
+ */
774
+ event_attribute: string;
775
+
776
+ /**
777
+ * sets the initial duration of events in minutes
778
+ */
779
+ event_duration: number;
780
+
781
+ /**
782
+ * sets the minimum value for the hour scale (Y-Axis)
783
+ */
784
+ first_hour: number;
785
+
786
+ /**
787
+ * moves views' tabs from the left to the right side
788
+ */
789
+ fix_tab_position: boolean;
790
+
791
+ /**
792
+ * enables setting of the event's duration to the full day
793
+ */
794
+ full_day: boolean;
795
+
796
+ /**
797
+ * provides a layout-like configuration for the scheduler header (navigation panel)
798
+ */
799
+ header: any;
800
+
801
+ /**
802
+ * specifies whether events retrieved by the showEvent method should be highlighted while displaying
803
+ */
804
+ highlight_displayed_event: boolean;
805
+
806
+ /**
807
+ * sets the time format of Y-Axis. Also used in the default event and lighbox templates for setting the time part.
808
+ */
809
+ hour_date: string;
810
+
811
+ /**
812
+ * sets the height of an hour unit in pixels
813
+ */
814
+ hour_size_px: number;
815
+
816
+ /**
817
+ * stores a collection of icons visible in the side edit menu of the event's box
818
+ */
819
+ icons_edit: any[];
820
+
821
+ /**
822
+ * stores a collection of icons visible in the side selection menu of the event's box
823
+ */
824
+ icons_select: any[];
825
+
826
+ /**
827
+ * defines whether the date specified in the 'End by' field should be exclusive or inclusive
828
+ */
829
+ include_end_by: boolean;
830
+
831
+ /**
832
+ * enables the keyboard navigation in the scheduler
833
+ */
834
+ key_nav: boolean;
835
+
836
+ /**
837
+ * defines the minimal step (in minutes) for navigating events
838
+ */
839
+ key_nav_step: number;
840
+
841
+ /**
842
+ * sets the maximum value of the hour scale (Y-Axis)
843
+ */
844
+ last_hour: number;
845
+
846
+ /**
847
+ * adds the dotted left border to the scheduler
848
+ */
849
+ left_border: boolean;
850
+
851
+ /**
852
+ * specifies the lightbox object
853
+ */
854
+ lightbox: any;
855
+
856
+ /**
857
+ * defines the lightbox's behavior, when the user opens the lightbox to edit a recurring event
858
+ */
859
+ lightbox_recurring: string;
860
+
861
+ /**
862
+ * denies to drag events out of the visible area of the scheduler
863
+ */
864
+ limit_drag_out: boolean;
865
+
866
+ /**
867
+ * sets the end limit of the allowable date range
868
+ */
869
+ limit_end: Date;
870
+
871
+ /**
872
+ * sets the start limit of the allowable date range
873
+ */
874
+ limit_start: Date;
875
+
876
+ /**
877
+ * sets max and min values of time selector in the lightbox to the values of the 'last_hour' and 'first_hour' options
878
+ */
879
+ limit_time_select: boolean;
880
+
881
+ /**
882
+ * limits the date period during which the user can view the events
883
+ */
884
+ limit_view: boolean;
885
+
886
+ /**
887
+ * sets the format of server request parameters 'from', 'to' in case of dynamic loading
888
+ */
889
+ load_date: string;
890
+
891
+ /**
892
+ * sets the date to display events until
893
+ */
894
+ map_end: Date;
895
+
896
+ /**
897
+ * sets the position that will be displayed on the map in case the event's location can't be identified
898
+ */
899
+ map_error_position: any;
900
+
901
+ /**
902
+ * the maximum width of the Google Maps's popup marker in the Map view
903
+ */
904
+ map_infowindow_max_width: number;
905
+
906
+ /**
907
+ * sets the initial position of the map
908
+ */
909
+ map_initial_position: any;
910
+
911
+ /**
912
+ * sets the initial zoom of Google Maps in the Map view
913
+ */
914
+ map_initial_zoom: number;
915
+
916
+ /**
917
+ * activates attempts to resolve the event's location, if the database doesn't have the event's coordinates stored
918
+ */
919
+ map_resolve_event_location: boolean;
920
+
921
+ /**
922
+ * enables/disables prompts asking the user to share his location for displaying on the map
923
+ */
924
+ map_resolve_user_location: boolean;
925
+
926
+ /**
927
+ * sets the date to start displaying events from
928
+ */
929
+ map_start: Date;
930
+
931
+ /**
932
+ * sets the type of Google Maps
933
+ */
934
+ map_type: any;
935
+
936
+ /**
937
+ * sets the zoom that will be used to show the user's location, if the user agrees to the browser's offer to show it
938
+ */
939
+ map_zoom_after_resolve: number;
940
+
941
+ /**
942
+ * enables/disables the marker displaying the current time
943
+ */
944
+ mark_now: boolean;
945
+
946
+ /**
947
+ * sets the maximum number of events displayable in a cell
948
+ */
949
+ max_month_events: number;
950
+
951
+ /**
952
+ * defines the minimal possible size of the Grid view during autoresize
953
+ */
954
+ min_grid_size: number;
955
+
956
+ /**
957
+ * defines the minimal possible size of the Map view during autoresize
958
+ */
959
+ min_map_size: number;
960
+
961
+ /**
962
+ * specifies the mini calendar object
963
+ */
964
+ minicalendar: any;
965
+
966
+ /**
967
+ * sets the format for the header of the Month view
968
+ */
969
+ month_date: string;
970
+
971
+ /**
972
+ * sets the format for the day in the cells of the Month and Year views
973
+ */
974
+ month_day: string;
975
+
976
+ /**
977
+ * sets the minimum height of cells in the Month view
978
+ */
979
+ month_day_min_height: number;
980
+
981
+ /**
982
+ * enables rendering of multi-day events
983
+ */
984
+ multi_day: boolean;
985
+
986
+ /**
987
+ * sets the height of the area that displays multi-day events
988
+ */
989
+ multi_day_height_limit: number|boolean;
990
+
991
+ /**
992
+ * enables the possibility to render the same events in several sections of the Timeline or Units view
993
+ */
994
+ multisection: boolean;
995
+
996
+ /**
997
+ * specifies whether while dragging events that assigned to several sections of the Timeline or Units view, all instances should be dragged at once ('true') or just the selected one ('false')
998
+ */
999
+ multisection_shift_all: boolean;
1000
+
1001
+ /**
1002
+ * sets the date for the current-time marker in the Limit extension (enabled by the configuration - mark_now)
1003
+ */
1004
+ now_date: Date;
1005
+
1006
+ /**
1007
+ * allows working with recurring events independently of time zones
1008
+ */
1009
+ occurrence_timestamp_in_utc: boolean;
1010
+
1011
+ /**
1012
+ * enables blocking priority for marked timespans
1013
+ */
1014
+ overwrite_marked_timespans: boolean;
1015
+
1016
+ /**
1017
+ * defines whether scheduler automatically identifies the format of data
1018
+ */
1019
+ parse_exact_format: boolean;
1020
+
1021
+ /**
1022
+ * defines the 'saving' behaviour for the case, when the user edits the event's text directly in the event's box
1023
+ */
1024
+ positive_closing: boolean;
1025
+
1026
+ /**
1027
+ * preserves the visible length of an event while dragging along a non-linear time scale
1028
+ */
1029
+ preserve_length: boolean;
1030
+
1031
+ /**
1032
+ * cancels preserving of the current scroll position while navigating between dates of the same view
1033
+ */
1034
+ preserve_scroll: boolean;
1035
+
1036
+ /**
1037
+ * enables/disables caching of GET requests in the browser
1038
+ */
1039
+ prevent_cache: boolean;
1040
+
1041
+ /**
1042
+ * defines whether the event form will appear from the left/right side of the screen or near the selected event
1043
+ */
1044
+ quick_info_detached: boolean;
1045
+
1046
+ /**
1047
+ * activates the read-only mode for the scheduler
1048
+ */
1049
+ readonly: boolean;
1050
+
1051
+ /**
1052
+ * activates the read-only mode for the lightbox
1053
+ */
1054
+ readonly_form: boolean;
1055
+
1056
+ /**
1057
+ * defines the behavior of the recurrences that transfer to the next month
1058
+ */
1059
+ recurring_overflow_instances: string;
1060
+
1061
+ /**
1062
+ * specifies working days that will affect the recurring event when the user selects the ""Every workday" option in the lightbox
1063
+ */
1064
+ recurring_workdays: any[];
1065
+
1066
+ /**
1067
+ * sets the date format of the 'End by' field in the 'recurring' lightbox
1068
+ */
1069
+ repeat_date: string;
1070
+
1071
+ /**
1072
+ * prevents including past days to events with the 'weekly' recurrence
1073
+ */
1074
+ repeat_precise: boolean;
1075
+
1076
+ /**
1077
+ * enables the possibility to resize multi-day events in the Month view by drag-and-drop
1078
+ */
1079
+ resize_month_events: boolean;
1080
+
1081
+ /**
1082
+ * enables the possibility to resize single-day events in the Month view by drag-n-drop
1083
+ */
1084
+ resize_month_timed: boolean;
1085
+
1086
+ /**
1087
+ * makes lightbox responsive on small screens
1088
+ */
1089
+ responsive_lightbox: boolean;
1090
+
1091
+ /**
1092
+ * enables RTL (right-to-left) mode for the scheduler
1093
+ */
1094
+ rtl: boolean;
1095
+
1096
+ /**
1097
+ * sets the initial position of the vertical scroll in the scheduler (an hour in the 24-hour clock format)
1098
+ */
1099
+ scroll_hour: number;
1100
+
1101
+ /**
1102
+ * specifies the delimeter that will be used to separate several sections/units in the related data property of the event
1103
+ */
1104
+ section_delimiter: string;
1105
+
1106
+ /**
1107
+ * shows/hides the select bar in the event's box
1108
+ */
1109
+ select: boolean;
1110
+
1111
+ /**
1112
+ * allows preventing short events from overlapping
1113
+ */
1114
+ separate_short_events: boolean;
1115
+
1116
+ /**
1117
+ * enables converting server-side dates from UTC to a local time zone (and backward) while sending data to the server
1118
+ */
1119
+ server_utc: boolean;
1120
+
1121
+ /**
1122
+ * enables showing error alerts in case of unexpected behavior
1123
+ */
1124
+ show_errors: boolean;
1125
+
1126
+ /**
1127
+ * enables showing a progress/spinner while data is loading (useful for dynamic loading)
1128
+ */
1129
+ show_loading: boolean;
1130
+
1131
+ /**
1132
+ * activates/disables the 'quick_info' extension (pop-up task's details form)
1133
+ */
1134
+ show_quick_info: boolean;
1135
+
1136
+ /**
1137
+ * sets the start day of weeks
1138
+ */
1139
+ start_on_monday: boolean;
1140
+
1141
+ /**
1142
+ * sets the minimum step (in minutes) for event's time values
1143
+ */
1144
+ time_step: number;
1145
+
1146
+ /**
1147
+ * defines that during event resizing the end date of the event can be swapped for the start date (after the end date becomes scheduled before the start one)
1148
+ */
1149
+ timeline_swap_resize: boolean;
1150
+
1151
+ /**
1152
+ * sets the length of time, in milliseconds, before the tooltip hides
1153
+ */
1154
+ tooltip_hide_timeout: number;
1155
+
1156
+ /**
1157
+ * sets the right (if positive) offset of the tooltip's position
1158
+ */
1159
+ tooltip_offset_x: number;
1160
+
1161
+ /**
1162
+ * sets the top (if positive) offset of the tooltip's position
1163
+ */
1164
+ tooltip_offset_y: number;
1165
+
1166
+ /**
1167
+ * sets the timeout in milliseconds before the tooltip is displayed for a task
1168
+ */
1169
+ tooltip_timeout: number;
1170
+
1171
+ /**
1172
+ * enables/disables the touch support in the scheduler
1173
+ */
1174
+ touch: boolean|string;
1175
+
1176
+ /**
1177
+ * defines the time period in milliseconds that is used to differ the long touch gesture from the scroll gesture
1178
+ */
1179
+ touch_drag: number|boolean;
1180
+
1181
+ /**
1182
+ * enables/disables switching active dates using the horizontal swipe gesture on mobiles
1183
+ */
1184
+ touch_swipe_dates: boolean;
1185
+
1186
+ /**
1187
+ * enables/disables prompting messages in the right top corner of the screen
1188
+ */
1189
+ touch_tip: boolean;
1190
+
1191
+ /**
1192
+ * disables dhtmxlScheduler's tooltips on the touch devices
1193
+ */
1194
+ touch_tooltip: boolean;
1195
+
1196
+ /**
1197
+ * updates the mode when the scheduler fully repaints itself on any action
1198
+ */
1199
+ update_render: boolean;
1200
+
1201
+ /**
1202
+ * defines that events occupy the whole width of the cell
1203
+ */
1204
+ use_select_menu_space: boolean;
1205
+
1206
+ /**
1207
+ * defines whether role="application" will be used for the main scheduler container and minicalendar elements
1208
+ */
1209
+ wai_aria_application_role: boolean;
1210
+
1211
+ /**
1212
+ * enables WAI-ARIA support to make the component recognizable for screen readers
1213
+ */
1214
+ wai_aria_attributes: boolean;
1215
+
1216
+ /**
1217
+ * highlights the selected event in the Week Agenda view
1218
+ */
1219
+ week_agenda_select: boolean;
1220
+
1221
+ /**
1222
+ * sets the format of the date in the sub-header of the Month view
1223
+ */
1224
+ week_date: string;
1225
+
1226
+ /**
1227
+ * enables/disables displaying of the standard (wide) lightbox instead of the short one
1228
+ */
1229
+ wide_form: boolean;
1230
+
1231
+ /**
1232
+ * sets the date format that is used to parse data from the data set
1233
+ */
1234
+ xml_date: string;
1235
+
1236
+ /**
1237
+ * sets the number of rows in the Year view
1238
+ */
1239
+ year_x: number;
1240
+
1241
+ /**
1242
+ * sets the number of columns in the Year view
1243
+ */
1244
+ year_y: number;
1245
+
1246
+ [customConfig: string]: any;
1247
+ }
1248
+
1249
+ export interface SchedulerDateHelpers {
1250
+ add(origin: Date, count: number, unit: string): Date;
1251
+ copy(origin: Date): Date;
1252
+ date_part(origin: Date): Date;
1253
+ time_part(origin: Date): Date;
1254
+ day_start(origin: Date): Date;
1255
+ month_start(origin: Date): Date;
1256
+ week_start(origin: Date): Date;
1257
+ year_start(origin: Date): Date;
1258
+ getISOWeek(origin: Date): number;
1259
+ getUTCISOWeek(origin: Date): number;
1260
+ date_to_str(format: string): any;
1261
+ str_to_date(format: string): any;
1262
+ convert_to_utc(origin: Date): Date;
1263
+ to_fixed(value: number): string;
1264
+ [customMethod: string]: any;
1265
+ }
1266
+
1267
+ export interface SchedulerHotkeys {
1268
+ edit_save: number;
1269
+ edit_cancel: number;
1270
+ }
1271
+
1272
+ export interface SchedulerLocaleDate {
1273
+ month_full: string[];
1274
+ month_short: string[];
1275
+ day_full: string[];
1276
+ day_short: string[];
1277
+ }
1278
+
1279
+ export interface SchedulerLocaleLabels {
1280
+ dhx_cal_today_button: string;
1281
+ day_tab: string;
1282
+ week_tab: string;
1283
+ month_tab: string;
1284
+ new_event: string;
1285
+ icon_save: string;
1286
+ icon_cancel: string;
1287
+ icon_details: string;
1288
+ icon_edit: string;
1289
+ icon_delete: string;
1290
+ confirm_closing: string;
1291
+ confirm_deleting: string;
1292
+ section_description: string;
1293
+ section_time: string;
1294
+ full_day: string;
1295
+ confirm_recurring: string;
1296
+ section_recurring: string;
1297
+ button_recurring: string;
1298
+ button_recurring_open: string;
1299
+ button_edit_series: string;
1300
+ button_edit_occurrence: string;
1301
+ agenda_tab: string;
1302
+ date: string;
1303
+ description: string;
1304
+ year_tab: string;
1305
+ week_agenda_tab: string;
1306
+ grid_tab: string;
1307
+ drag_to_create: string;
1308
+ drag_to_move: string;
1309
+ message_ok: string;
1310
+ message_cancel: string;
1311
+ next: string;
1312
+ prev: string;
1313
+ year: string;
1314
+ month: string;
1315
+ day: string;
1316
+ hour: string;
1317
+ minute: string;
1318
+ repeat_radio_day: string;
1319
+ repeat_radio_week: string;
1320
+ repeat_radio_month: string;
1321
+ repeat_radio_year: string;
1322
+ repeat_radio_day_type: string;
1323
+ repeat_text_day_count: string;
1324
+ repeat_radio_day_type2: string;
1325
+ repeat_week: string;
1326
+ repeat_text_week_count: string;
1327
+ repeat_radio_month_type: string;
1328
+ repeat_radio_month_start: string;
1329
+ repeat_text_month_day: string;
1330
+ repeat_text_month_count: string;
1331
+ repeat_text_month_count2_before: string;
1332
+ repeat_text_month_count2_after: string;
1333
+ repeat_year_label: string;
1334
+ select_year_day2: string;
1335
+ repeat_text_year_day: string;
1336
+ select_year_month: string;
1337
+ repeat_radio_end: string;
1338
+ repeat_text_occurences_count: string;
1339
+ repeat_radio_end2: string;
1340
+ repeat_radio_end3: string;
1341
+ month_for_recurring: string[];
1342
+ day_for_recurring: string[];
1343
+ [customLabel: string]: any;
1344
+ }
1345
+
1346
+ export interface SchedulerLocale {
1347
+ date: SchedulerLocaleDate;
1348
+ labels: SchedulerLocaleLabels;
1349
+ }
1350
+
1351
+ export interface SchedulerFormBlock {
1352
+
1353
+ /**
1354
+ * Renders the form block based on the provided configuration.
1355
+ * @function
1356
+ * @name SchedulerFormBlock#render
1357
+ * @param {any} config - The configuration object for the custom lightbox control.
1358
+ * @returns {string} Returns the HTML string representing the rendered the custom control.
1359
+ */
1360
+ render: (config: any) => string;
1361
+
1362
+ /**
1363
+ * Sets the value of the custom lightbox control.
1364
+ * @function
1365
+ * @name SchedulerFormBlock#set_value
1366
+ * @param {HTMLElement} node - HTML object related to HTML defined above.
1367
+ * @param {*} value - value defined by map_to property.
1368
+ * @param {Event} ev - The event object.
1369
+ * @param {any} config - Section configuration object.
1370
+ * @returns {void}
1371
+ */
1372
+ set_value: (node: HTMLElement, value: any, ev: Event, config: any) => void;
1373
+
1374
+ /**
1375
+ * Gets the value of the custom control.
1376
+ * @function
1377
+ * @name SchedulerFormBlock#get_value
1378
+ * @param {HTMLElement} node - HTML object related to HTML defined above.
1379
+ * @param {Event} ev - The event object.
1380
+ * @param {any} config - Section configuration object.
1381
+ * @returns {*} Returns the value of the custom lightbox control.
1382
+ */
1383
+ get_value: (node: HTMLElement, ev: Event, config: any) => any;
1384
+
1385
+ /**
1386
+ * Focuses on the custom lightbox control.
1387
+ * @function
1388
+ * @name SchedulerFormBlock#focus
1389
+ * @param {HTMLElement} node - HTML object related to HTML defined above.
1390
+ * @returns {void}
1391
+ */
1392
+ focus: (node: HTMLElement) => void;
1393
+ }
1394
+
1395
+ export interface SchedulerSizes {
1396
+
1397
+ /**
1398
+ * the height of day cells in the month view
1399
+ */
1400
+ bar_height: number;
1401
+
1402
+ /**
1403
+ * the width of the event text input 140 day
1404
+ */
1405
+ editor_width: number;
1406
+
1407
+ /**
1408
+ * increases the length of the lightbox
1409
+ */
1410
+ lightbox_additional_height: number;
1411
+
1412
+ /**
1413
+ * the width of the date column in the Map view
1414
+ */
1415
+ map_date_width: number;
1416
+
1417
+ /**
1418
+ * the width of the description column in the Map view
1419
+ */
1420
+ map_description_width: number;
1421
+
1422
+ /**
1423
+ * the left margin of the main scheduler area
1424
+ */
1425
+ margin_left: number;
1426
+
1427
+ /**
1428
+ * the bottom margin of the main scheduler area
1429
+ */
1430
+ margin_top: number;
1431
+
1432
+ /**
1433
+ * the width of the selection menu
1434
+ */
1435
+ menu_width: number;
1436
+
1437
+ /**
1438
+ * the minimal height of the event box
1439
+ */
1440
+ min_event_height: number;
1441
+
1442
+ /**
1443
+ * the top offset of an event in a cell in the month view
1444
+ */
1445
+ month_scale_height: number;
1446
+
1447
+ /**
1448
+ * the height of the navigation bar
1449
+ */
1450
+ nav_height: number;
1451
+
1452
+ /**
1453
+ * the height of the X-Axis
1454
+ */
1455
+ scale_height: number;
1456
+
1457
+ /**
1458
+ * the width of the Y-Axis
1459
+ */
1460
+ scale_width: number;
1461
+
1462
+ /**
1463
+ * the width of the scrollbar area
1464
+ */
1465
+ scroll_width: number;
1466
+ }
1467
+
1468
+ export interface SchedulerEnterprise {
1469
+ getSchedulerInstance(): SchedulerStatic;
1470
+ }
1471
+
1472
+ export interface SchedulerStatic {
1473
+
1474
+ /**
1475
+ * scheduler ajax module
1476
+ */
1477
+ ajax: any;
1478
+
1479
+ /**
1480
+ * defines configuration options for dates, scale, controls
1481
+ */
1482
+ config: SchedulerConfigOptions;
1483
+
1484
+ /**
1485
+ * a set of date formatting methods
1486
+ */
1487
+ date: SchedulerDateHelpers;
1488
+
1489
+ /**
1490
+ * a set of flags which describe current environment
1491
+ */
1492
+ env: any;
1493
+
1494
+ /**
1495
+ * a set of methods for Scheduler localization
1496
+ */
1497
+ i18n: any;
1498
+
1499
+ /**
1500
+ * specifies ICal serialization and parsing
1501
+ */
1502
+ ical: any;
1503
+
1504
+ /**
1505
+ * specifies JSON serialization and parsing
1506
+ */
1507
+ json: any;
1508
+
1509
+ /**
1510
+ * defines the hot keys for the scheduler
1511
+ */
1512
+ keys: SchedulerHotkeys;
1513
+
1514
+ /**
1515
+ * a locale object (region-specific labels) of the scheduler
1516
+ */
1517
+ locale: SchedulerLocale;
1518
+
1519
+ /**
1520
+ * stores the configuration objects of all timelines specified on the page
1521
+ */
1522
+ matrix: any;
1523
+
1524
+ /**
1525
+ * returns the current skin of the scheduler
1526
+ */
1527
+ skin: string;
1528
+
1529
+ /**
1530
+ * defines formatting of the templates for dates, titles and tooltips in the scheduler
1531
+ */
1532
+ templates: SchedulerTemplates;
1533
+
1534
+ /**
1535
+ * displays tooltips for events
1536
+ */
1537
+ tooltip: any;
1538
+
1539
+ /**
1540
+ * returns the version of dhtmlxScheduler
1541
+ */
1542
+ version: string;
1543
+
1544
+ /**
1545
+ * specifies sizes of the scheduler's elements
1546
+ */
1547
+ xy: SchedulerSizes;
1548
+
1549
+ /**
1550
+ * DataProcessor constructor
1551
+ * @param url url to the data feed
1552
+ */
1553
+ DataProcessor(url: string): void;
1554
+
1555
+ /**
1556
+ * Promise object constructor
1557
+ * @param executor a callback used to initialize the promise
1558
+ */
1559
+ Promise(executor: SchedulerCallback): any;
1560
+
1561
+ /**
1562
+ * adds a new event
1563
+ * @param event the event object
1564
+ */
1565
+ addEvent(event: any): string;
1566
+
1567
+ /**
1568
+ * adds a new event and opens the lightbox to confirm
1569
+ * @param event the event object
1570
+ */
1571
+ addEventNow(event: any): string;
1572
+
1573
+ /**
1574
+ * marks dates, but with certain settings makes blocking (allows setting custom styling for the limit)
1575
+ * @param config the configuration object of the timespan to mark/block
1576
+ */
1577
+ addMarkedTimespan(config: any): number;
1578
+
1579
+ /**
1580
+ * adds a section to the currently active view
1581
+ * @param section the object of the section to add
1582
+ * @param parent_id the id of the parent section. Pass 'null' if you are adding a section to the root
1583
+ */
1584
+ addSection(section: any, parent_id: string): boolean;
1585
+
1586
+ /**
1587
+ * adds a new keyboard shortcut
1588
+ * @param shortcut the key name or the name of keys combination for a shortcut (<a href="keyboard_navigation.md#shortcutsyntax">shortcut syntax</a>)
1589
+ * @param handler the handler of the shortcut call
1590
+ * @param scope optional, (optional) the name of the context element to attach the handler function to (<a href="keyboard_navigation.md#scopes">list of scopes</a>)
1591
+ */
1592
+ addShortcut(shortcut: string, handler: SchedulerCallback, scope?: string): void;
1593
+
1594
+ /**
1595
+ * calls an alert message box
1596
+ * @param config the alert box's configuration
1597
+ */
1598
+ alert(config: any): HTMLElement;
1599
+
1600
+ /**
1601
+ * if the specified expression is false, an errorMessage is shown in the red popup at the top right corner of the screen
1602
+ * @param expression true to assert the expression, false - if assertion fails
1603
+ * @param errorMessage an error message that will be shown in the red popup
1604
+ */
1605
+ assert(expression: boolean, errorMessage: string): void;
1606
+
1607
+ /**
1608
+ * attaches the handler to an inner event of dhtmlxScheduler
1609
+ * @param name the event's name, case-insensitive
1610
+ * @param handler the handler function
1611
+ * @param settings optional, optional, an <a href="#propertiesofsettingsobject">object with settings</a> for the event handler
1612
+ */
1613
+ attachEvent(name: SchedulerEventName, handler: SchedulerCallback, settings?: any): string;
1614
+
1615
+ /**
1616
+ * makes the scheduler reflect all data changes in the Backbone model and vice versa
1617
+ * @param events the Backbone data collection
1618
+ */
1619
+ backbone(events: any): void;
1620
+
1621
+ /**
1622
+ * creates a new function that, when called, has its <i>this</i> keyword set to the provided value
1623
+ * @param method the target function
1624
+ * @param thisArg the value to be passed as the <i>this</i> parameter to the target function when the bound function is called
1625
+ */
1626
+ bind(method: SchedulerCallback, thisArg: any): SchedulerCallback;
1627
+
1628
+ /**
1629
+ * blocks the specified date and applies the default 'dimmed' style to it.
1630
+ * @param date a date to block ( if a number is provided, the parameter will be treated as a week <br> day: '0' index refers to Sunday,'6' - to Saturday )
1631
+ * @param time_points an array <b>[start_minute,end_minute,..,start_minute_N,end_minute_N]</b>, <br> where each pair sets a certain limit range. The array can have any number of such pairs
1632
+ * @param items optional, defines specific items of view(s) to block
1633
+ */
1634
+ blockTime(date: Date|number, time_points: any[], items?: any): void;
1635
+
1636
+ /**
1637
+ * calls an inner event
1638
+ * @param name the event's name, case-insensitive
1639
+ * @param params an array of the event-related data
1640
+ */
1641
+ callEvent(name: string, params: any[]): boolean;
1642
+
1643
+ /**
1644
+ * changes the event's id
1645
+ * @param id the current event's id
1646
+ * @param new_id the new event's id
1647
+ */
1648
+ changeEventId(id: string, new_id: string): void;
1649
+
1650
+ /**
1651
+ * checks whether the specified event occurs at the time that has already been occupied by another event(s)
1652
+ * @param event the event object
1653
+ */
1654
+ checkCollision(event: any): boolean;
1655
+
1656
+ /**
1657
+ * checks whether an event has some handler(s) specified
1658
+ * @param name the event's name
1659
+ */
1660
+ checkEvent(name: SchedulerEventName): boolean;
1661
+
1662
+ /**
1663
+ * checks whether an event resides in a timespan of a specific type
1664
+ * @param event the event object
1665
+ * @param timespan the timespan's type
1666
+ */
1667
+ checkInMarkedTimespan(event: any, timespan: string): boolean;
1668
+
1669
+ /**
1670
+ * checks whether the specified event takes place at the blocked time period
1671
+ * @param event the event object
1672
+ */
1673
+ checkLimitViolation(event: any): boolean;
1674
+
1675
+ /**
1676
+ * removes all events from the scheduler
1677
+ */
1678
+ clearAll(): void;
1679
+
1680
+ /**
1681
+ * closes all sections in the currently active view
1682
+ */
1683
+ closeAllSections(): void;
1684
+
1685
+ /**
1686
+ * closes the specified section in the currently active view
1687
+ * @param section_id the section's id
1688
+ */
1689
+ closeSection(section_id: string): void;
1690
+
1691
+ /**
1692
+ * collapses the expanded scheduler back to the normal size
1693
+ */
1694
+ collapse(): void;
1695
+
1696
+ /**
1697
+ * calls a confirm message box
1698
+ * @param config the confirm box's configuration
1699
+ */
1700
+ confirm(config: any): HTMLElement;
1701
+
1702
+ /**
1703
+ * creates a deep copy of provided object
1704
+ * @param event the object that needs to be copied
1705
+ */
1706
+ copy(event: any): any;
1707
+
1708
+ /**
1709
+ * creates a new dataProcessor instance and attaches it to scheduler
1710
+ * @param config dataProcessor configuration object
1711
+ */
1712
+ createDataProcessor(config: any): any;
1713
+
1714
+ /**
1715
+ * creates the Grid view in the scheduler
1716
+ * @param config the configuration object of the Grid view
1717
+ */
1718
+ createGridView(config: any): void;
1719
+
1720
+ /**
1721
+ * creates the Timeline view in the scheduler
1722
+ * @param config the configuration object of the Timeline view
1723
+ */
1724
+ createTimelineView(config: any): void;
1725
+
1726
+ /**
1727
+ * creates the Units view in the scheduler
1728
+ * @param config the configuration object of the Units view
1729
+ */
1730
+ createUnitsView(config: any): void;
1731
+
1732
+ /**
1733
+ * returns false if the provided argument is undefined, otherwise true
1734
+ * @param event the object that should be checked
1735
+ */
1736
+ defined(event: any): boolean;
1737
+
1738
+ /**
1739
+ * deletes all sections from the currently active view
1740
+ */
1741
+ deleteAllSections(): void;
1742
+
1743
+ /**
1744
+ * deletes the specified event
1745
+ * @param id the event's id
1746
+ */
1747
+ deleteEvent(id: string|number): void;
1748
+
1749
+ /**
1750
+ * removes marking/blocking set by the addMarkedTimespan() method
1751
+ * @param config optional, the timespan's id or the timespan's configuration properties
1752
+ */
1753
+ deleteMarkedTimespan(config?: any): void;
1754
+
1755
+ /**
1756
+ * deletes a section from the currently active view
1757
+ * @param section_id the section's id
1758
+ */
1759
+ deleteSection(section_id: string): boolean;
1760
+
1761
+ /**
1762
+ * destroys previously created mini-calendar
1763
+ * @param name optional, the mini-calendar's object (if not specified, the scheduler attempts <br> to destroy the last created mini calendar)
1764
+ */
1765
+ destroyCalendar(name?: any): void;
1766
+
1767
+ /**
1768
+ * destroys the scheduler instance
1769
+ */
1770
+ destructor(): void;
1771
+
1772
+ /**
1773
+ * detaches a handler from an event (which was attached before by the attachEvent method)
1774
+ * @param id the event's id
1775
+ */
1776
+ detachEvent(id: string): void;
1777
+
1778
+ /**
1779
+ * opens the inline editor to alter the event's text (the editor in the event's box)
1780
+ * @param id the event's id
1781
+ */
1782
+ edit(id: string): void;
1783
+
1784
+ /**
1785
+ * closes the inline event editor, if it's currently open
1786
+ * @param id the event's id
1787
+ */
1788
+ editStop(id: string): void;
1789
+
1790
+ /**
1791
+ * closes the lightbox
1792
+ * @param mode if set to <i>true</i>, the changes, made in the lightbox, will be saved before closing. <br> If - <i>false</i>, the changes will be cancelled.
1793
+ * @param box optional, the HTML container for the lightbox
1794
+ */
1795
+ endLightbox(mode: boolean, box?: HTMLElement): void;
1796
+
1797
+ /**
1798
+ * attaches an event handler to an HTML element
1799
+ * @param node the HTML node or its id
1800
+ * @param event the name of an HTML event (without the 'on' prefix)
1801
+ * @param handler the event handler
1802
+ * @param master optional, an object that the <i>this</i> keyword refers to
1803
+ */
1804
+ event(node: HTMLElement|string, event: string, handler: SchedulerCallback, master?: any): string;
1805
+
1806
+ /**
1807
+ * removes an event handler from an HTML element
1808
+ * @param id the id of an event handler
1809
+ */
1810
+ eventRemove(id: string): void;
1811
+
1812
+ /**
1813
+ * expands the scheduler to the full screen view
1814
+ */
1815
+ expand(): void;
1816
+
1817
+ /**
1818
+ * exports a Scheduler into the PDF format
1819
+ * @param _export_ an object with export settings (see the details)
1820
+ */
1821
+ exportToPDF(_export_: any): void;
1822
+
1823
+ /**
1824
+ * exports a Scheduler into the PNG format
1825
+ * @param _export_ an object with export settings (see the details)
1826
+ */
1827
+ exportToPNG(_export_: any): void;
1828
+
1829
+ /**
1830
+ * sets focus on the scheduler
1831
+ */
1832
+ focus(): void;
1833
+
1834
+ /**
1835
+ * gives access to the objects of lightbox's sections
1836
+ * @param name the name of a lightbox section
1837
+ */
1838
+ formSection(name: string): any;
1839
+
1840
+ /**
1841
+ * returns the current cursor-pointed date and section (if defined)
1842
+ * @param e a native event object
1843
+ */
1844
+ getActionData(e: Event): any;
1845
+
1846
+ /**
1847
+ * returns the event object by its id
1848
+ * @param event_id the event's id
1849
+ */
1850
+ getEvent(event_id: string|number): any;
1851
+
1852
+ /**
1853
+ * gets the event's end date
1854
+ * @param id the event's id
1855
+ */
1856
+ getEventEndDate(id: string): Date;
1857
+
1858
+ /**
1859
+ * gets the event's start date
1860
+ * @param id the event's id
1861
+ */
1862
+ getEventStartDate(id: string): Date;
1863
+
1864
+ /**
1865
+ * gets the event's text
1866
+ * @param id the event's id
1867
+ */
1868
+ getEventText(id: string): string;
1869
+
1870
+ /**
1871
+ * returns a collection of events which occur during the specified period
1872
+ * @param from optional, the start date of the period
1873
+ * @param to optional, the end date of the period
1874
+ */
1875
+ getEvents(from?: Date, to?: Date): any[];
1876
+
1877
+ /**
1878
+ * gets the label of a select control in the lightbox
1879
+ * @param property the name of a data property that the control is mapped to
1880
+ * @param key the option's id. This parameter is compared with the event's data property <br> to assign the select's option to an event
1881
+ */
1882
+ getLabel(property: string, key: string|number): string;
1883
+
1884
+ /**
1885
+ * gets the lightbox's HTML object element
1886
+ */
1887
+ getLightbox(): HTMLElement;
1888
+
1889
+ /**
1890
+ * returns all occurrences of a recurring event
1891
+ * @param id the id of a recurring event
1892
+ * @param number the maximum number of occurrences to return (by default, 100)
1893
+ */
1894
+ getRecDates(id: string, number: number): any;
1895
+
1896
+ /**
1897
+ * gets the object of the currently displayed event
1898
+ * @param id the event's id
1899
+ */
1900
+ getRenderedEvent(id: string): HTMLElement;
1901
+
1902
+ /**
1903
+ * gets the object of the specified section in the currently active view
1904
+ * @param section_id the section's id
1905
+ */
1906
+ getSection(section_id: string): any;
1907
+
1908
+ /**
1909
+ * gets a key navigation shortcut handler
1910
+ * @param shortcut the key name or the name of keys combination for a shortcut (<a href="keyboard_navigation.md#shortcutsyntax">shortcut syntax</a>)
1911
+ * @param scope optional, (optional) the name of the context element to attach the handler function to (<a href="keyboard_navigation.md#scopes">list of scopes</a>)
1912
+ */
1913
+ getShortcutHandler(shortcut: string, scope?: string): SchedulerCallback;
1914
+
1915
+ /**
1916
+ * gets the current state of the scheduler
1917
+ */
1918
+ getState(): any;
1919
+
1920
+ /**
1921
+ * gets the user data associated with the specified event
1922
+ * @param id the event's id
1923
+ * @param name the user data name
1924
+ */
1925
+ getUserData(id: string, name: string): any;
1926
+
1927
+ /**
1928
+ * returns a view object by its name. If no name is specified, returns the current view
1929
+ * @param name optional, optional, the name of the view
1930
+ */
1931
+ getView(name?: string): any;
1932
+
1933
+ /**
1934
+ * hides the lightbox modal overlay that blocks interactions with the remaining screen
1935
+ * @param box optional, an element to hide
1936
+ */
1937
+ hideCover(box?: HTMLElement): void;
1938
+
1939
+ /**
1940
+ * hides the lightbox without saving it
1941
+ */
1942
+ hideLightbox(): void;
1943
+
1944
+ /**
1945
+ * hides the pop-up event form (if it's currently active)
1946
+ */
1947
+ hideQuickInfo(): void;
1948
+
1949
+ /**
1950
+ * highlights the event's duration on the time scale
1951
+ * @param event the event object
1952
+ */
1953
+ highlightEventPosition(event: any): void;
1954
+
1955
+ /**
1956
+ * a constructor of a dhtmlxScheduler object
1957
+ * @param container an HTML container (or its id) where a dhtmlxScheduler object will be initialized
1958
+ * @param date optional, the initial date of the scheduler (by default, the current date)
1959
+ * @param view optional, the name of the initial view (by default, "week")
1960
+ */
1961
+ init(container: string|HTMLElement, date?: Date, view?: string): void;
1962
+
1963
+ /**
1964
+ * inverts the specified time zones
1965
+ * @param zones an array **[start_minute,end_minute,..,start_minute_N,end_minute_N]** <br >where each pair sets a certain limit range (in minutes). The array can have any <br> number of such pairs
1966
+ */
1967
+ invertZones(zones: any[]): void;
1968
+
1969
+ /**
1970
+ * checks whether the calendar is currently opened in the scheduler
1971
+ */
1972
+ isCalendarVisible(): boolean|HTMLElement;
1973
+
1974
+ /**
1975
+ * checks whether the specified event one-day or multi-day
1976
+ * @param event the event object
1977
+ */
1978
+ isOneDayEvent(event: any): boolean;
1979
+
1980
+ /**
1981
+ * checks whether a view with the specified name exists
1982
+ * @param name the view name
1983
+ */
1984
+ isViewExists(name: string): boolean;
1985
+
1986
+ /**
1987
+ * 'says' to change the active date in the mini calendar each time, the active date in the scheduler is changed
1988
+ * @param calendar the mini calendar object
1989
+ * @param shift a function that defines the difference between active dates in the mini-calendar <br> and the scheduler. The function takes the scheduler's date as a parameter and <br> returns the date that should be displayed in the mini calendar
1990
+ */
1991
+ linkCalendar(calendar: any, shift: SchedulerCallback): void;
1992
+
1993
+ /**
1994
+ * loads data to the scheduler from an external data source
1995
+ * @param url the server-side URL (may be a static file or a server-side script which outputs data in one of the supported formats)
1996
+ * @param callback optional, the callback function
1997
+ */
1998
+ load(url: string, callback?: SchedulerCallback): void;
1999
+
2000
+ /**
2001
+ * applies a css class to the specified date
2002
+ * @param calendar the calendar object
2003
+ * @param date the date to mark
2004
+ * @param css the name of a css class
2005
+ */
2006
+ markCalendar(calendar: any, date: Date, css: string): void;
2007
+
2008
+ /**
2009
+ * marks and/or blocks date(s) by applying the default or a custom style to them. Marking is cancelled right after any internal update in the app. Can be used for highlighting
2010
+ * @param config the configuration object of the timespan to mark/block
2011
+ */
2012
+ markTimespan(config: any): any[];
2013
+
2014
+ /**
2015
+ * calls a message box of the specified type
2016
+ * @param config the message box's configuration
2017
+ */
2018
+ message(config: any): HTMLElement;
2019
+
2020
+ /**
2021
+ * adds properties of the 'source' object into the 'target' object
2022
+ * @param target the target object
2023
+ * @param source the source object
2024
+ * @param force if true, properties of the 'source' will overwrite matching properties of the 'target', if there are any. If false, properties that already exist in the 'target' will be omitted
2025
+ */
2026
+ mixin(target: any, source: any, force: boolean): void;
2027
+
2028
+ /**
2029
+ * calls a modalbox
2030
+ * @param config the modal box's configuration
2031
+ */
2032
+ modalbox(config: any): HTMLElement;
2033
+
2034
+ /**
2035
+ * opens all sections in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored)
2036
+ */
2037
+ openAllSections(): void;
2038
+
2039
+ /**
2040
+ * opens the specified section in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored)
2041
+ * @param section_id the section's id
2042
+ */
2043
+ openSection(section_id: string): void;
2044
+
2045
+ /**
2046
+ * loads data from a client-side resource
2047
+ * @param data a string or object which represents data
2048
+ */
2049
+ parse(data: any): void;
2050
+
2051
+ /**
2052
+ * activates specified extensions
2053
+ * @param ext extensions that need to be activated
2054
+ */
2055
+ plugins(ext: any): void;
2056
+
2057
+ /**
2058
+ * removes a keyboard shortcut
2059
+ * @param shortcut the key name or the name of keys combination for a shortcut (<a href="keyboard_navigation.md#shortcutsyntax">shortcut syntax</a>)
2060
+ * @param scope optional, (optional) the element to which the shortcut is attached (<a href="keyboard_navigation.md#scopes">list of scopes</a>)
2061
+ */
2062
+ removeShortcut(shortcut: string, scope?: any): void;
2063
+
2064
+ /**
2065
+ * repaints the scheduler
2066
+ * @param date optional, the date to display
2067
+ * @param view optional, the name of a view to display
2068
+ */
2069
+ render(date?: Date, view?: string): void;
2070
+
2071
+ /**
2072
+ * creates a mini calendar
2073
+ * @param config the calendar configuration object
2074
+ */
2075
+ renderCalendar(config: any): void;
2076
+
2077
+ /**
2078
+ * generates HTML content for a custom event's box
2079
+ * @param container the event container
2080
+ * @param event the event object
2081
+ */
2082
+ renderEvent(container: HTMLElement, event: any): boolean;
2083
+
2084
+ /**
2085
+ * removes the current lightbox's HTML object element
2086
+ */
2087
+ resetLightbox(): void;
2088
+
2089
+ /**
2090
+ * scrolls the specified number of units in the Units view
2091
+ * @param step the number of units to scroll (<i>set the positive value to scroll units to the right <br> side, the negative value - to the left side</i>).
2092
+ */
2093
+ scrollUnit(step: number): void;
2094
+
2095
+ /**
2096
+ * selects the specified event
2097
+ * @param id the event's id
2098
+ */
2099
+ select(id: string): void;
2100
+
2101
+ /**
2102
+ * serializes all events loaded into the scheduler
2103
+ */
2104
+ serialize(): void;
2105
+
2106
+ /**
2107
+ * defines a named collection that can be loaded into Units, Timeline views, or the Lightbox
2108
+ * @param list_name the name of a list
2109
+ * @param options optional, optional, an array of options
2110
+ */
2111
+ serverList(list_name: string, options?: any[]): any[];
2112
+
2113
+ /**
2114
+ * displays the specified view and date
2115
+ * @param date optional, the date to display
2116
+ * @param view optional, the name of a view to display
2117
+ */
2118
+ setCurrentView(date?: Date, view?: string): void;
2119
+
2120
+ /**
2121
+ * adds a new event to the scheduler's data pool
2122
+ * @param id the event's id
2123
+ * @param event the event object
2124
+ */
2125
+ setEvent(id: string|number, event: any): void;
2126
+
2127
+ /**
2128
+ * sets the event's end date
2129
+ * @param id the event's id
2130
+ * @param date the new end date of the event
2131
+ */
2132
+ setEventEndDate(id: string, date: Date): void;
2133
+
2134
+ /**
2135
+ * sets the event's start date
2136
+ * @param id the event's id
2137
+ * @param date the new start date of the event
2138
+ */
2139
+ setEventStartDate(id: string, date: Date): void;
2140
+
2141
+ /**
2142
+ * sets the event's text
2143
+ * @param id the event's id
2144
+ * @param text the new text of the event
2145
+ */
2146
+ setEventText(id: string, text: string): void;
2147
+
2148
+ /**
2149
+ * forces the lightbox to resize
2150
+ */
2151
+ setLightboxSize(): void;
2152
+
2153
+ /**
2154
+ * sets the mode that allows loading data by parts (enables the dynamic loading)
2155
+ * @param mode the loading mode
2156
+ */
2157
+ setLoadMode(mode: string): void;
2158
+
2159
+ /**
2160
+ * sets the active skin
2161
+ * @param skin name of the skin. Allowed values: "terrace", "dark", "material", "flat", "contrast-white", "contrast-black"
2162
+ */
2163
+ setSkin(skin: string): void;
2164
+
2165
+ /**
2166
+ * sets the user data associated with the specified event
2167
+ * @param id the event's id
2168
+ * @param name the user data name
2169
+ * @param value the user data value
2170
+ */
2171
+ setUserData(id: string, name: string, value: any): void;
2172
+
2173
+ /**
2174
+ * shows the lightbox modal overlay that blocks interactions with the remaining screen
2175
+ * @param box optional, an element to hide
2176
+ */
2177
+ showCover(box?: HTMLElement): void;
2178
+
2179
+ /**
2180
+ * shows and highlights the specified event in the current or specified view
2181
+ * @param id the event's id
2182
+ * @param view optional, the view name
2183
+ */
2184
+ showEvent(id: string, view?: string): void;
2185
+
2186
+ /**
2187
+ * opens the lightbox for the specified event
2188
+ * @param id the event's id
2189
+ */
2190
+ showLightbox(id: string): void;
2191
+
2192
+ /**
2193
+ * displays the pop-up event form for the specified event
2194
+ * @param id the event's id
2195
+ */
2196
+ showQuickInfo(id: string): void;
2197
+
2198
+ /**
2199
+ * shows a custom lightbox in the specified HTML container centered on the screen
2200
+ * @param id the event's id
2201
+ * @param box the lightbox's HTML container
2202
+ */
2203
+ startLightbox(id: string, box: HTMLElement): void;
2204
+
2205
+ /**
2206
+ * converts scheduler's data to the ICal format
2207
+ * @param header optional, sets the value for the content's header field
2208
+ */
2209
+ toICal(header?: string): string;
2210
+
2211
+ /**
2212
+ * converts scheduler's data into the JSON format
2213
+ */
2214
+ toJSON(): string;
2215
+
2216
+ /**
2217
+ * exports the current view to a PDF document (can be used for printing)
2218
+ * @param url the path to the server-side PDF converter
2219
+ * @param mode optional, the color map of the resulting PDF document
2220
+ */
2221
+ toPDF(url: string, mode?: string): void;
2222
+
2223
+ /**
2224
+ * exports several scheduler's views to a PDF document (can be used for printing)
2225
+ * @param from the date to start export events from
2226
+ * @param to the date to export events until
2227
+ * @param view the name of a view that the export should be applied to
2228
+ * @param path the path to the php file which generates a PDF file (<a href="pdf.md#configuringservice">details</a>)
2229
+ * @param color the color map in use
2230
+ */
2231
+ toPDFRange(from: Date, to: Date, view: string, path: string, color: string): void;
2232
+
2233
+ /**
2234
+ * converts scheduler's data into the XML format
2235
+ */
2236
+ toXML(): string;
2237
+
2238
+ /**
2239
+ * generates a unique ID (unique inside the current scheduler, not GUID)
2240
+ */
2241
+ uid(): number;
2242
+
2243
+ /**
2244
+ * removes blocking set by the blockTime() method
2245
+ * @param days (<i>Date, number,array, string</i>) days that should be limited
2246
+ * @param zones optional, the period in minutes that should be limited. Can be set to 'fullday' value <br> to limit the entire day
2247
+ * @param sections optional, allows blocking date(s) just for specific items of specific views. BTW, the specified date(s) will be blocked just in the related view(s)
2248
+ */
2249
+ unblockTime(days: any, zones?: any[], sections?: any): void;
2250
+
2251
+ /**
2252
+ * removes a css class from the specified date
2253
+ * @param calendar the mini calendar object
2254
+ * @param date the date to unmark
2255
+ * @param css the name of a css class to remove
2256
+ */
2257
+ unmarkCalendar(calendar: any, date: Date, css: string): void;
2258
+
2259
+ /**
2260
+ * removes marking/blocking set by the markTimespan() method
2261
+ * @param divs a timespan to remove marking/blocking from (or an array of timespans)
2262
+ */
2263
+ unmarkTimespan(divs: HTMLElement|any[]): void;
2264
+
2265
+ /**
2266
+ * unselects the specified event
2267
+ * @param id optional, the event's id (if not specified, the currently selected event will be unselected)
2268
+ */
2269
+ unselect(id?: string): void;
2270
+
2271
+ /**
2272
+ * displays the specified date in the mini calendar
2273
+ * @param calendar the mini calendar object
2274
+ * @param new_date a new date to display in the mini calendar
2275
+ */
2276
+ updateCalendar(calendar: any, new_date: Date): void;
2277
+
2278
+ /**
2279
+ * updates the specified collection with new options
2280
+ * @param collection the name of the collection to update
2281
+ * @param options the new values of the collection
2282
+ */
2283
+ updateCollection(collection: string, options: any[]): boolean;
2284
+
2285
+ /**
2286
+ * updates the specified event
2287
+ * @param id the event's id
2288
+ */
2289
+ updateEvent(id: string): void;
2290
+
2291
+ /**
2292
+ * displays the specified view and date (doesn't invoke any events)
2293
+ * @param date optional, (optional) the date to set
2294
+ * @param view optional, (optional) the view name
2295
+ */
2296
+ updateView(date?: Date, view?: string): void;
2297
+
2298
+ // /**
2299
+ // * A key-value mapping of string keys to Scheduler form blocks.
2300
+ // * The keys represent the names of the custom lightbox controls.
2301
+ // * The values are objects that implement the SchedulerFormBlock interface.
2302
+ // */
2303
+ form_blocks: { [key: string]: SchedulerFormBlock };
2304
+
2305
+ [customMethod: string]: any;
2306
+ }
2307
+
2308
+ export declare var scheduler: SchedulerStatic;
2309
+
2310
+ export declare var Scheduler: SchedulerEnterprise;