Перейти к основному содержимому

API overview

Scheduler methods

NameDescription
DataProcessorКонструктор DataProcessor
PromiseКонструктор для создания объекта Promise
addEventДобавляет новое событие
addEventNowСоздаёт новое событие и открывает лайтбокс для подтверждения
addMarkedTimespanОтмечает даты, а с определёнными настройками может блокировать их (позволяет применять кастомные стили к границам)
addSectionДобавляет новый section в текущий активный view
addShortcutСоздаёт новую клавиатурную комбинацию (shortcut)
alertОтображает alert message box
assertЕсли заданное выражение ложно, в красном всплывающем окне в правом верхнем углу экрана появится сообщение об ошибке
attachEventПривязывает обработчик к внутреннему событию dhtmlxScheduler
backboneПоддерживает синхронизацию планировщика с обновлениями в Backbone модели и наоборот
batchUpdateОбновляет несколько событий одновременно
bindСоздаёт новую функцию, которая при вызове имеет ключевое слово this, установленное в указанное значение
blockTimeБлокирует указанную дату и применяет к ней стиль по умолчанию 'dimmed'.
callEventТриггерит внутреннее событие
changeEventIdОбновляет id события
checkCollisionПроверяет, пересекается ли заданное событие с каким-либо существующим событием(ями) в тот же временной промежуток
checkEventПроверяет, назначены ли обработчики для конкретного события
checkInMarkedTimespanОпределяет, попадает ли событие в интервал времени заданного типа
checkLimitViolationОпределяет, пересекается ли заданное событие с заблокированным периодом времени
clearAllУдаляет все события из планировщика
closeAllSectionsЗакрывает все секции в текущем активном вью
closeSectionЗакрывает конкретный section внутри текущего активного view.
collapseВозвращает scheduler из расширенного состояния обратно к обычному размеру
confirmОткрывает confirm message box
copyСоздаёт глубокую копию заданного объекта
createDataProcessorСоздает новый экземпляр dataProcessor и связывает его с scheduler
createGridViewНастраивает Grid view внутри планировщика
createTimelineViewНастраивает Timeline view в планировщике
createUnitsViewНастраивает Units view внутри scheduler
definedВозвращает false, если аргумент равен undefined; возвращает true в остальных случаях
deleteAllSectionsУдаляет все секции из активного вида
deleteEventУдаляет указанное событие
deleteMarkedTimespanУдаляет маркировку или блокировку, созданную с помощью метода addMarkedTimespan()
deleteSectionУдаляет секцию из текущего активного вида
destroyCalendarУдаляет ранее созданный мини-календарь
destructorУдаляет экземпляр планировщика
detachEventУдаляет ранее добавленный обработчик события (тот, который был добавлен с помощью метода attachEvent)
editОткрывает inline редактор для изменения текста события непосредственно в его блоке
editStopЗавершает работу встроенного редактора событий, когда он открыт
endLightboxИспользуется для закрытия lightbox
eventУстанавливает обработчик event на HTML элемент
eventRemoveУдаляет обработчик события с HTML-элемента
expandОткрывает scheduler на весь экран для лучшей видимости
exportToPDFЭкспортирует Scheduler в формат PDF
exportToPNGПозволяет экспортировать Scheduler в виде PNG-изображения
focusАктивирует focus на scheduler
formSectionПредоставляет доступ к объектам секций лайтбокса
getActionDataВозвращает дату и секцию, находящиеся в данный момент под курсором, если таковые имеются
getEventПредоставляет объект события, соответствующий заданному id
getEventEndDateПолучает дату окончания события
getEventStartDateПолучает дату начала события
getEventTextПолучает текст, связанный с событием
getEventsВозвращает коллекцию событий, которые происходят в указанном временном интервале
getLabelПолучает label (метку) элемента управления select в lightbox
getLightboxПолучает HTML-элемент лайтбокса
getRecDatesПолучает все повторяющиеся вхождения события
getRenderedEventВозвращает HTML-элемент события, который в данный момент отображается
getSectionПолучает объект для конкретного section внутри текущего активного view
getShortcutHandlerПолучает обработчик для сочетания клавиш навигации
getStateПолучает текущее состояние scheduler'а
getUserDataПолучает пользовательские данные, связанные с конкретным событием
getViewВозвращает объект view по его имени. Если имя не указано, возвращается текущий view
hideCoverУдаляет модальное оверлейное окно lightbox, которое блокирует взаимодействие с остальной частью экрана
hideLightboxЗакрывает лайтбокс без сохранения изменений
hideQuickInfoСкрывает всплывающую форму события, если она в данный момент открыта.
highlightEventPositionОтмечает длительность события на timeline
initЭто конструктор для создания экземпляра dhtmlxScheduler.
invertZonesИнвертирует заданные часовые пояса
isCalendarVisibleОпределяет, отображается ли в данный момент календарь в scheduler
isOneDayEventОпределяет, длится ли заданное событие всего один день или охватывает несколько дней
isViewExistsПроверяет, существует ли view с заданным именем
linkCalendarЭтот метод обновляет активную дату в мини-календаре каждый раз, когда активная дата в планировщике изменяется.
loadЗагружает данные в scheduler из внешнего источника
markCalendarДобавляет CSS класс к конкретной дате
markTimespanПодсвечивает или блокирует определённые дату(ы), применяя либо стиль по умолчанию, либо кастомный стиль. Подсветка снимается сразу после любого внутреннего обновления в приложении. Это может быть полезно для выделения определённых дат.
messageОткрывает message box выбранного типа
mixinСливает свойства из объекта 'source' в объект 'target'
modalboxОткрывает modalbox
openAllSectionsОткрывает все секции в текущем активном представлении (работает только если представление - Timeline в режиме 'Tree'; в противном случае метод игнорируется)
openSectionОткрывает определённый section внутри текущего активного view (работает только если активный view - Timeline в режиме 'Tree'; в противном случае метод игнорируется)
parseОбрабатывает загрузку данных из клиентского ресурса
pluginsВключает выбранные расширения
removeShortcutУдаляет клавиатурный shortcut
renderОбновляет отображение scheduler-а
renderCalendarГенерирует компактный календарь
renderEventСоздает HTML-контент для кастомного блока события
resetLightboxУдаляет текущий HTML-элемент lightbox'а
scrollUnitПрокручивает указанное количество единиц в представлении Units
selectВыбирает указанный вами event
serializeСериализует все события, которые в данный момент загружены в scheduler
serverListОпределяет именованную коллекцию, которую можно загрузить в Units, Timeline views или Lightbox
setCurrentViewПоказывает выбранный view и дату
setEventДобавляет новое событие в пул данных планировщика
setEventEndDateОбновляет дату окончания события
setEventStartDateОбновляет дату начала события
setEventTextОбновляет текст конкретного события
setLightboxSizeОбновляет размер lightbox
setLoadModeУстанавливает режим загрузки данных по частям, позволяя динамическую подгрузку
setSkinИзменяет текущую активную skin
setUserDataНазначает пользовательские данные для конкретного события
showCoverОтображает модальное оверлейное окно (lightbox), которое блокирует взаимодействие с остальной частью экрана
showEventОтображает и выделяет указанный ивент в текущем или выбранном виде
showLightboxОткрывает лайтбокс для заданного события
showQuickInfoОткрывает всплывающую форму события для заданного события
startLightboxОтображает кастомный лайтбокс внутри указанного HTML контейнера, центрированного на экране
toICalПреобразует данные планировщика в формат ICal
toJSONПреобразует данные планировщика в строку в формате JSON
toPDFЭкспортирует текущий вид в PDF-документ, что удобно для печати.
toPDFRangeЭкспортирует несколько видов расписания в PDF-документ (полезно для печати)
toXMLПреобразует данные планировщика в формат XML
uidСоздаёт уникальный ID, который гарантированно уникален в пределах текущего экземпляра scheduler (не глобальный GUID)
unblockTimeУдаляет блокировку, установленную ранее методом blockTime()
unmarkCalendarУдаляет CSS класс с указанной даты
unmarkTimespanОчищает разметку или блокировку, применённую методом markTimespan()
unselectУдаляет выделение с указанного события
updateCalendarОтображает выбранную дату в мини-календаре
updateCollectionОбновляет указанную коллекцию новыми опциями
updateEventИзменяет указанное событие
updateViewОтображает указанное представление и дату без вызова каких-либо событий

Scheduler properties

NameDescription
active_link_viewПозволяет отображать номера дней в Month view в виде кликабельных ссылок, которые открывают соответствующий день в выбранном представлении.
agenda_endОпределяет дату, до которой отображаются события
agenda_startЗадает дату, с которой начнется отображение событий
ajax_errorОпределяет, как отображается стандартное уведомление об ошибке при сбое загрузки XML данных
all_timed'говорит', как отображать многодневные события в привычном формате (аналогично тому, как отображаются однодневные события)
api_dateЗадаёт формат даты, используемый в шаблоне api_date
auto_end_dateАвтоматически обновляет дату окончания события при изменении даты начала
buttons_leftСодержит набор кнопок, расположенных в левом нижнем углу лайтбокса
buttons_rightСодержит набор кнопок, расположенных в правом нижнем углу лайтбокса
cascade_event_countОпределяет максимальное количество событий, отображаемых в каскаде
cascade_event_displayВключает режим отображения 'cascade'
cascade_event_marginОпределяет левый отступ для серии каскадных событий
check_limitsВключает или отключает проверку ограничений
collision_limitОпределяет максимальное количество событий, разрешенных в одном временном слоте
container_autoresizeПозволяет контейнеру scheduler автоматически подстраивать свой размер под весь контент без необходимости прокрутки
cspОпределяет, как внутренне реализованы методы форматирования даты
date_formatОпределяет формат даты, используемый для парсинга данных из набора данных и для отправки дат обратно на сервер
day_column_paddingДобавляет padding к колонке представления
day_dateЗадаёт формат даты, используемый на оси X в представлениях Week и Units
dblclick_createПозволяет пользователям создавать события двойным щелчком мыши
default_dateОпределяет формат даты, используемый в шаблонах 'day_date', 'week_date', 'day_scale_date' для отображения дат в заголовках представлений
delay_renderУстанавливает таймаут (в миллисекундах), который оборачивает вызовы updateView и setCurrentView (которые запускают перерисовку scheduler)
details_on_createПозволяет использовать расширенную форму при создании новых событий путем перетаскивания или двойного клика.
details_on_dblclickПозволяет открывать лайтбокс двойным кликом по событию
display_marked_timespansУправляет подсветкой отмеченных (заблокированных) временных интервалов в scheduler
displayed_event_colorОпределяет цвет фона по умолчанию для событий, отображаемых методом showEvent()
displayed_event_text_colorОпределяет цвет шрифта по умолчанию для событий, отображаемых методом showEvent()
drag_createПозволяет создавать новые события с помощью drag and drop
drag_event_bodyПозволяет перетаскивать события планировщика, захватывая любую часть тела события
drag_highlightЭта опция выделяет начальную точку события и его длительность на шкале времени при перетаскивании события в scheduler.
drag_inОграничивает перетаскивание событий так, чтобы их можно было перемещать только внутри того scheduler, который инициализировал drag, предотвращая переносы между разными schedulers.
drag_lightboxПозволяет перетаскивать lightbox за его заголовок
drag_moveПозволяет изменять позицию событий с помощью drag-and-drop
drag_outЗапретить перетаскивание событий из этого scheduler в другие
drag_resizeПозволяет изменять размер событий с помощью drag-and-drop
edit_on_createВключает открытие лайтбокса при создании новых событий
event_attributeОпределяет имя атрибута, используемого для идентификации HTML-элемента события по его id
event_durationЗадаёт начальную длительность событий в минутах
first_hourОпределяет начальный час для часовой шкалы (ось Y)
fix_tab_positionСдвигает вкладки видов с левой стороны на правую сторону
full_dayПозволяет установить событие на весь день
headerНастраивает layout для header планировщика (панели навигации)
highlight_displayed_eventОпределяет, будут ли события, полученные с помощью метода showEvent, подсвечиваться при отображении
hour_dateОпределяет формат времени, отображаемый на оси Y. Также применяется в стандартных шаблонах событий и lightbox для форматирования временной части.
hour_size_pxОпределяет высоту блока часа в пикселях
icons_editСодержит набор иконок, которые отображаются в боковом меню редактирования внутри блока события
icons_selectСодержит набор иконок, которые отображаются в боковом меню выбора в блоке события
include_end_byУстанавливает, считается ли дата, введённая в поле 'End by', исключающей или включающей
key_navВключает клавиатурную навигацию в scheduler
key_nav_stepУстанавливает минимальный размер шага (в минутах), используемый при навигации по событиям
last_hourОпределяет верхний предел для часовой шкалы на оси Y.
left_borderВключает пунктирную левую границу в scheduler
lightboxОпределяет объект lightbox
lightbox_recurringУправляет поведением lightbox при редактировании повторяющегося события
limit_drag_outПредотвращает перетаскивание событий за пределы видимой области планировщика
limit_endОпределяет конечную границу допустимого диапазона дат
limit_startЗадаёт начальную границу допустимого диапазона дат
limit_time_selectОграничивает селектор времени в лайтбоксе, устанавливая максимальные и минимальные значения в соответствии с опциями 'last_hour' и 'first_hour'.
limit_viewОграничивает диапазон дат, в пределах которого пользователи могут просматривать события
load_dateОпределяет формат параметров запроса 'from' и 'to' на сервер при использовании динамической загрузки
map_endОпределяет дату, до которой отображаются события
map_error_positionОпределяет позицию, отображаемую на карте, когда местоположение события не может быть определено
map_infowindow_max_widthУстанавливает максимальную ширину всплывающего окна маркера на карте в Map view.
map_initial_positionЗадаёт начальное положение карты
map_initial_zoomЗадаёт начальный уровень зума для карты в Map view
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 view при автоизменении размера
min_map_sizeОпределяет минимальный размер, до которого может сжиматься вид Map при автоподстройке размера
minicalendarОпределяет объект миникалендаря
month_dateОпределяет формат заголовка вида Month
month_dayОпределяет формат отображения дня в ячейках видов Month и Year
month_day_min_heightЗадаёт минимальную высоту ячеек в Month view
multi_dayПозволяет отображать события, продолжающиеся несколько дней
multi_day_height_limitУправляет высотой секции, показывающей события, длящихся несколько дней
multisectionПозволяет отображать одни и те же события в нескольких секциях в представлениях Timeline или Units
multisection_shift_allУправляет тем, перемещаются ли при перетаскивании событий, назначенных нескольким секциям в Timeline или Units view, все экземпляры одновременно ('true') или только выбранный ('false')
now_dateУстанавливает дату для маркера текущего времени в расширении Limit (активируется через конфигурацию - mark_now)
occurrence_timestamp_in_utcПозволяет работать с повторяющимися событиями без необходимости учитывать часовые пояса
overwrite_marked_timespansУправляет приоритетом блокировки для отмеченных временных интервалов
parse_exact_formatУправляет строгим соответствием формата даты при разборе в scheduler
positive_closingУправляет поведением сохранения при прямом редактировании текста события внутри его блока
preserve_lengthСохраняет видимую длину события неизменной при его перетаскивании по нелинейной временной шкале
preserve_scrollОтключает сохранение текущей позиции скролла при переключении между датами в одном и том же вью
prevent_cacheУправляет включением или отключением кеширования GET-запросов в браузере
quick_info_detachedУправляет тем, будет ли форма события появляться с левой/правой стороны экрана или непосредственно рядом с выбранным событием
readonlyВключает режим только для чтения в scheduler
readonly_formВключает режим только для чтения для лайтбокса
recurring_overflow_instancesУправляет обработкой повторений, выходящих за пределы текущего месяца
recurring_workdaysОпределяет, какие дни считаются рабочими для повторяющихся событий при выборе опции "Every workday" в lightbox.
repeat_dateЗадаёт формат даты, используемый в поле 'End by' внутри лайтбокса 'recurring'
repeat_preciseПрекращает включать прошедшие дни в события с повторением 'weekly'
resize_month_eventsПозволяет изменять размер событий, продолжающихся несколько дней, в представлении Месяц с помощью drag-and-drop
resize_month_timedПозволяет изменять размер событий, продолжающихся один день, в Month view с помощью drag-and-drop
responsive_lightboxПозволяет lightbox плавно адаптироваться под меньшие экраны
rtlВключает режим RTL (right-to-left) для scheduler
scroll_hourОпределяет начальную вертикальную позицию прокрутки в scheduler, основанную на часе в 24-часовом формате.
section_delimiterОпределяет разделитель, используемый для разделения нескольких секций или единиц внутри связанного свойства данных события
selectПереключает видимость select-бара внутри блока события
separate_short_eventsПомогает избежать наложения коротких событий
server_utcПозволяет конвертировать серверные даты между UTC и локальными часовыми поясами при обмене данными с сервером
show_errorsВключает всплывающие окна с предупреждениями об ошибках при возникновении проблем
show_loadingОтображает индикатор прогресса или спиннер во время загрузки данных, что удобно для сценариев динамической загрузки.
show_quick_infoВключает или отключает расширение 'quick_info' (всплывающее окно, показывающее детали задачи)
start_on_mondayУстанавливает первый день недели
time_stepЗадает минимальный шаг (в минутах) для значений времени событий
timeline_swap_resizeПозволяет при изменении размера события менять местами дату окончания и дату начала, если дата окончания перемещается до даты начала
tooltip_hide_timeoutУстанавливает, как долго tooltip остаётся видимым перед тем, как исчезнуть, измеряется в миллисекундах
tooltip_offset_xРегулирует горизонтальное смещение позиции tooltip вправо при установке положительного значения
tooltip_offset_yРегулирует вертикальное положение tooltip, задавая верхний отступ при положительном значении
tooltip_timeoutОпределяет, сколько времени в миллисекундах должно пройти, прежде чем появится tooltip для задачи
touchВключает или отключает поддержку touch в планировщике
touch_dragУстанавливает длительность в миллисекундах, которая отличает жест долгого касания от жеста прокрутки
touch_swipe_datesПозволяет включить или отключить возможность переключения активных дат с помощью горизонтального жеста swipe на мобильных устройствах
touch_tipУправляет отображением всплывающих подсказок в правом верхнем углу экрана
touch_tooltipВключает отображение тултипов dhtmlxScheduler на устройствах с сенсорным экраном
undo_deletedВключает появление всплывающего окна Undo после удаления события
update_renderУправляет тем, будет ли scheduler полностью перерисовываться после каждого действия
use_select_menu_spaceОпределяет, занимают ли события всю ширину ячейки
wai_aria_application_roleУстанавливает, должен ли атрибут role="application" быть назначен основному контейнеру scheduler и элементам minicalendar
wai_aria_attributesВключает поддержку WAI-ARIA, чтобы компонент мог распознаваться скринридерами
week_agenda_selectВыделяет выбранное событие в представлении Week Agenda
week_dateОпределяет формат даты, отображаемый в подзаголовке вида Month.
wide_formУправляет отображением стандартного (широкого) lightbox вместо короткой версии
xml_dateОпределяет формат даты, используемый для интерпретации данных из набора данных
year_xОпределяет, сколько строк отображается в Year view
year_yЗадаёт количество колонок, отображаемых в Year view

Scheduler events

NameDescription
onAfterBatchUpdateСрабатывает сразу после завершения выполнения метода batchUpdate
onAfterEventDisplayСрабатывает, когда scheduler меняет вид, дни, время и т.д., чтобы отобразить событие, указанное методом 'showEvent', и происходит ПОСЛЕ отображения события.
onAfterFolderToggleСрабатывает сразу после того, как ветка дерева была открыта или закрыта (применимо только в режиме Timeline, 'tree')
onAfterLightboxСрабатывает сразу после того, как пользователь закрывает lightbox (форму редактирования)
onAfterQuickInfoСрабатывает сразу после закрытия формы всплывающего окна.
onAfterSchedulerResizeСрабатывает после того, как размер scheduler был обновлен и область с данными перерисована
onBeforeBatchUpdateВызывается непосредственно перед выполнением метода batchUpdate
onBeforeCollapseСрабатывает, когда пользователь нажимает на иконку сворачивания, чтобы переключить размер scheduler с «полного экрана» обратно к исходному размеру.
onBeforeDragСрабатывает, когда пользователь начинает действие перетаскивания или изменения размера (доступно с версии 2.1+)
onBeforeEventChangedСрабатывает при изменении события через drag-and-drop, но изменения ещё не сохранены.
onBeforeEventCreatedСрабатывает, когда пользователь создает новое событие, перетаскивая курсор по scheduler
onBeforeEventDeleteСрабатывает сразу после того, как пользователь нажимает кнопку удаления (либо в event bar, либо в окне деталей)
onBeforeEventDisplayСрабатывает непосредственно перед тем, как метод 'showEvent' отображает конкретное событие, позволяя выполнить код до появления события.
onBeforeEventDragInСрабатывает непосредственно перед тем, как перетаскиваемое событие входит в область scheduler
onBeforeEventDragOutСрабатывает непосредственно перед тем, как событие будет перетащено за пределы scheduler-а
onBeforeEventPastedСрабатывает непосредственно перед тем, как пользователь нажимает сочетание клавиш 'CTRL+V'
onBeforeExpandСрабатывает, когда пользователь нажимает на иконку расширения, чтобы переключить scheduler из исходного размера в режим "полного экрана".
onBeforeExternalDragInСрабатывает непосредственно перед тем, как элемент начнёт перетаскиваться в scheduler из внешнего компонента DHTMLX (требуется включённое расширение dnd)
onBeforeFolderToggleСрабатывает непосредственно перед открытием или закрытием ветки дерева (применимо только в режиме Timeline, "tree")
onBeforeLightboxСрабатывает непосредственно перед тем, как пользователь откроет lightbox (форму редактирования)
onBeforeParseСрабатывает непосредственно перед началом парсинга данных
onBeforeQuickInfoСрабатывает непосредственно перед появлением всплывающей подсказки Quick Info для события
onBeforeSectionRenderСрабатывает непосредственно перед установкой отдельного раздела Timeline, но до его рендеринга (применимо только к виду Timeline)
onBeforeTodayDisplayedСрабатывает при нажатии кнопки «Today» в scheduler
onBeforeTooltipСрабатывает непосредственно перед появлением tooltip для элемента данных (только когда активировано расширение 'tooltip')
onBeforeViewChangeСрабатывает непосредственно перед переключением пользователя с текущего вида на другой
onCellClickСрабатывает при однократном клике пользователя по ячейке (применимо только в Timeline view)
onCellDblClickСрабатывает при двойном клике пользователя по ячейке (только в Timeline view)
onClearAllСрабатывает один раз после очистки данных планировщика
onClickСрабатывает, когда пользователь кликает левой кнопкой мыши по событию
onCollapseСрабатывает, когда пользователь нажимает на иконку разворачивания, чтобы переключить scheduler из режима "полного экрана" обратно к исходному размеру.
onConfirmedBeforeEventDeleteСрабатывает сразу после того, как пользователь нажимает кнопку удаления и подтверждает удаление (либо в панели события, либо в окне деталей)
onContextMenuСрабатывает, когда пользователь открывает контекстное меню, кликая правой кнопкой мыши внутри scheduler
onDataRenderСрабатывает после того, как данные полностью отрисованы на странице
onDblClickСрабатывает, когда пользователь делает двойной клик по событию
onDestroyСрабатывает один раз после очистки планировщика с помощью метода destructor
onDragEndСрабатывает, когда действие перетаскивания или изменения размера завершено
onEmptyClickСрабатывает, когда пользователь кликает по пустой области внутри scheduler (не по событиям)
onErrorСрабатывает, когда assert получает значение 'false', что означает, что утверждение (assertion) не выполнено.
onEventAddedСрабатывает при добавлении нового события в scheduler
onEventCancelСрабатывает, когда пользователь нажимает кнопку 'Cancel' в лайтбоксе (форме редактирования)
onEventChangedСрабатывает один раз, когда пользователь заканчивает редактирование события и сохраняет изменения (после нажатия кнопок редактирования и сохранения в панели события или окне деталей)
onEventCollisionСрабатывает, когда пользователь пытается создать новое событие или изменить существующее в уже занятый временной интервал
onEventCopiedСрабатывает, когда пользователь нажимает сочетание клавиш 'CTRL+C' (работает только если включено расширение 'keyboard navigation')
onEventCreatedСрабатывает, когда пользователь начинает создание нового события (либо двойным кликом, либо перетаскиванием)
onEventCutСрабатывает, когда пользователь нажимает сочетание клавиш 'CTRL+X' (работает только если включено расширение 'keyboard navigation')
onEventDeletedСрабатывает сразу после удаления события (доступно с версии 3.0+)
onEventDragСрабатывает при перетаскивании или изменении размера события внутри scheduler
onEventDragInСрабатывает, когда перетаскиваемое событие входит в scheduler
onEventDragOutСрабатывает, когда перетаскиваемое событие покидает область планировщика
onEventDropOutСрабатывает, когда перетаскиваемое событие отпущено за пределами области scheduler
onEventIdChangeСрабатывает при обновлении id события
onEventLoadingСрабатывает при загрузке события из источника данных
onEventPastedВызывается, когда пользователь нажимает сочетание клавиш 'CTRL+V'
onEventSaveСрабатывает, когда пользователь нажимает кнопку «сохранить» в лайтбоксе (форме редактирования)
onEventSelectedСрабатывает, когда пользователь выбирает событие в планировщике
onEventUnselectedСрабатывает, когда пользователь отменяет выбор события, выбрав другое
onExpandСрабатывает, когда пользователь нажимает на иконку разворачивания, чтобы изменить размер планировщика с исходного состояния на «полный экран».
onExternalDragInСрабатывает, когда данные перетаскиваются в scheduler из внешнего компонента DHTMLX (требуется включение расширения dnd)
onLightboxСрабатывает сразу после того, как пользователь открывает lightbox (форму редактирования)
onLightboxButtonСрабатывает, когда пользователь нажимает на кастомную кнопку внутри lightbox
onLimitViolationСрабатывает, когда пользователь пытается назначить время событию, которое в данный момент ограничено или заблокировано
onLoadEndСрабатывает один раз после завершения загрузки данных из источника данных
onLoadErrorВызывается, когда scheduler не может распарсить данные или когда сервер возвращает статус 4xx или 5xx
onLoadStartСрабатывает непосредственно перед началом процесса загрузки данных из источника данных
onLocationErrorСрабатывает, когда местоположение события не может быть найдено на карте (только для Map view)
onMouseDownСрабатывает, когда пользователь кликает по элементу планировщика, у которого нет предопределенного обработчика 'onclick'
onMouseMoveСрабатывает при перемещении курсора мыши над scheduler
onOptionsLoadСрабатывает после обновления частей представления Timeline/Units
onOptionsLoadFinalСрабатывает один раз после завершения загрузки коллекции опций (секций) (применимо только к Timeline view)
onOptionsLoadStartСрабатывает непосредственно перед началом загрузки набора опций или секций с сервера (применимо только к Timeline view)
onParseСрабатывает сразу после того, как данные были распарсены и готовы для API, но до того, как они отображаются в Scheduler
onQuickInfoСрабатывает при появлении всплывающей формы редактирования
onSaveErrorСрабатывает при возникновении ошибки во время обновления данных
onScaleAddСрабатывает сразу после того, как единица представления (например, колонка, секция или ячейка дня) отрисовывается в scheduler-е
onScaleDblClickСрабатывает при двойном клике пользователя по временной шкале
onSchedulerReadyСрабатывает после завершения инициализации scheduler, хотя он ещё не отображён на странице.
onSchedulerResizeСрабатывает непосредственно перед изменением размера scheduler-а
onTemplatesReadyСрабатывает, когда шаблоны scheduler'а инициализированы
onTimelineCreatedСрабатывает один раз после настройки вида Timeline, но до его отображения на странице (применимо только к виду Timeline)
onViewChangeСрабатывает после переключения текущего вида на другой
onViewMoreClickВызывается, когда пользователь кликает по ссылке 'View more' в Month view (применимо только для Month view)
onXLEСрабатывает один раз после завершения загрузки данных из источника данных
onXLSСрабатывает непосредственно перед началом загрузки источника данных
onXScaleClickСрабатывает при одиночном клике пользователя по ячейке на оси x (применимо только в режиме Timeline)
onXScaleDblClickСрабатывает, когда пользователь двойным кликом нажимает на ячейку по оси X (применимо только в режиме Timeline)
onYScaleClickСрабатывает при одиночном клике пользователя на ячейку по оси Y (применимо только в режиме Timeline)
onYScaleDblClickВызывается, когда пользователь двойным щелчком кликает по ячейке на оси Y (применимо только в представлении Timeline)

Scheduler templates

NameDescription
agenda_dateОпределяет дату, отображаемую в заголовке представления
agenda_dayОпределяет, что отображается внутри ячейки дня в представлении Agenda
agenda_textОпределяет текст, отображаемый во втором столбце вида Agenda
agenda_timeОпределяет дату, отображаемую в первом столбце вида Agenda
api_dateЗадаёт формат даты, используемый методами API для обработки дат. Это помогает корректно интерпретировать входящие значения дат.
calendar_dateОпределяет, что отображается внутри ячеек дней Мини-Календаря (date picker)
calendar_monthЗадаёт дату, отображаемую в заголовке Мини-Календаря (date picker)
calendar_scale_dateЗадаёт формат для меток дней недели в заголовке Мини-Календаря (date picker)
calendar_timeОпределяет формат даты, используемый для полей даты начала и окончания в lightbox
day_dateОпределяет дату, отображаемую в заголовке для представлений Day и Units
day_scale_dateУстанавливает дату, отображаемую в подзаголовке вида Day
drag_marker_classОпределяет CSS класс, применяемый к выделенной длительности события на временной шкале
drag_marker_contentОпределяет содержимое, отображаемое в выделенном блоке на временной шкале
event_bar_dateИспользуется для установки даты события. Применяется только к событиям, которые длятся один день
event_bar_textЗадаёт текст, отображаемый на событиях, охватывающих несколько дней.
event_classОпределяет CSS класс, который будет добавлен к контейнеру события
event_dateОпределяет временную часть даты начала и окончания события. В основном используется другими шаблонами для отображения временных интервалов.
event_headerОпределяет содержимое заголовка для события
event_textОпределяет текст, отображаемый для события
format_dateПреобразует объект даты в форматированную строку даты. Это полезно для отправки данных даты обратно на сервер.
GRID_dateУстанавливает дату, отображаемую в заголовке представления
GRID_full_dateОпределяет, как отображаются даты в колонках с id='date'
GRID_single_dateОпределяет, как отображаются даты в колонках с id='start_date' или id='end_date'
GRID_fieldОпределяет текст, отображаемый в колонках
hour_scaleОпределяет элементы, отображаемые на оси Y
load_formatОпределяет формат запроса, используемый в режиме динамической загрузки
map_dateУстанавливает дату, отображаемую в заголовке представления
map_info_contentОпределяет, что отображается внутри окна информации в Map View
map_textОпределяет текст, отображаемый во втором столбце представления
map_timeЗадаёт дату, отображаемую в первом столбце представления
month_dateЗадаёт дату, отображаемую в заголовке вида
month_date_classОпределяет CSS класс, назначаемый ячейке дня
month_dayОпределяет, как день отображается в ячейке
month_events_linkУправляет отображением ссылки «View more» внутри ячейки просмотра месяца
month_scale_dateОпределяет формат даты, используемый на оси X в месячном представлении
parse_dateПреобразует строку с датой в объект Date
quick_info_contentОпределяет, что отображается внутри всплывающей формы редактирования
quick_info_dateОпределяет дату, отображаемую в всплывающей форме редактирования
quick_info_titleЗадаёт заголовок для всплывающей формы редактирования
time_pickerПредоставляет выпадающий селектор времени внутри lightbox
time_slot_classОпределяет CSS класс для фоновых ячеек в представлениях Day и Week
time_slot_textОпределяет содержимое, отображаемое внутри фоновых ячеек в представлениях Day/Week
tooltip_date_formatОпределяет, как отображаются даты начала и окончания в tooltip
tooltip_textЗадаёт текст, отображаемый в тултипах
week_agenda_dateОпределяет дату, отображаемую в заголовке представления Week Agenda
week_agenda_event_textОпределяет текст, отображаемый для события
week_agenda_scale_dateДата, отображаемая в ячейке дня в представлении
week_dateЗадаёт дату, отображаемую в заголовке представления
week_date_classОпределяет CSS класс, назначаемый ячейке дня
week_scale_dateОпределяет дату, отображаемую в подзаголовке представления
year_dateЗадаёт дату, отображаемую в заголовке вида
year_monthОпределяет название месяца, отображаемое в заголовке блока месяца в представлении.
year_scale_dateОпределяет название дня, отображаемое в подзаголовке внутри блока месяца в представлении
year_tooltipОпределяет tooltip, который отображается над ячейкой дня с запланированным событием(ями)
lightbox_headerОпределяет секцию заголовка lightbox
TIMELINE_cell_valueПоказывает, сколько событий запланировано в ячейке представления
TIMELINE_cell_classЗадаёт CSS класс, который будет присвоен ячейке в представлении
TIMELINE_scalex_classОпределяет имя CSS-класса, который будет назначен элементам на оси X
TIMELINE_second_scalex_classУстанавливает имя CSS-класса, который будет добавлен к элементам на второй оси X.
TIMELINE_scaley_classОпределяет имя CSS-класса, который будет присвоен элементам на оси Y
TIMELINE_scale_labelУказывает элементы оси Y
TIMELINE_tooltipПредоставляет текст тултипа для ячейки дня, которая содержит запланированное событие(я)
TIMELINE_dateОпределяет дату, отображаемую в заголовке вида
TIMELINE_scale_dateОпределяет элементы, отображаемые на оси X
TIMELINE_second_scale_dateОпределяет элементы, отображаемые на вторичной оси X
TIMELINE_row_classОпределяет CSS класс, который будет присвоен строке в представлении Timeline
UNITS_dateУстанавливает дату, отображаемую в заголовке вида
UNITS_scale_textОпределяет элементы, отображаемые на оси X
xml_dateЭтот шаблон преобразует строку из XML файла в объект даты на основе указанного формата.
xml_formatОбъект даты преобразуется в строку согласно этому конкретному шаблону. В основном используется при отправке данных обратно на сервер.

Scheduler others

NameDescription
ajax@getshort(api/method/ajax_other.md)
config@getshort(api/method/config_other.md)
date@getshort(api/method/date_other.md)
env@getshort(api/method/env_other.md)
i18n@getshort(api/method/i18n_other.md)
ical@getshort(api/method/ical_other.md)
json@getshort(api/method/json_other.md)
keys@getshort(api/method/keys_other.md)
locale@getshort(api/method/locale_other.md)
matrix@getshort(api/method/matrix_other.md)
skin@getshort(api/method/skin_other.md)
templates@getshort(api/method/templates_other.md)
tooltip@getshort(api/method/tooltip_other.md)
version@getshort(api/method/version_other.md)
xy@getshort(api/method/xy_other.md)
Need help?
Got a question about the documentation? Reach out to our technical support team for help and guidance. For custom component solutions, visit the Services page.