Skip to main content

API overview

Scheduler methods

NameDescription
DataProcessorDataProcessor constructor
PromisePromise object constructor
addEventAdds a new event
addEventNowAdds a new event and opens the lightbox to confirm
addMarkedTimespanMarks dates, but with certain settings makes blocking (allows setting custom styling for the limit)
addSectionAdds a section to the currently active view
addShortcutAdds a new keyboard shortcut
alertCalls an alert message box
assertIf the specified expression is false, an errorMessage is shown in a red popup at the top right corner of the screen
attachEventAttaches the handler to an inner event of dhtmlxScheduler
backboneMakes the scheduler reflect all data changes in the Backbone model and vice versa
batchUpdateUpdates multiple events at once
bindCreates a new function that when called has its this keyword set to the provided value
blockTimeBlocks the specified date and applies the default 'dimmed' style to it.
callEventCalls an inner event
changeEventIdChanges the event's id
checkCollisionChecks whether the specified event occurs at the time that has already been occupied by another event(s)
checkEventChecks whether an event has some handler(s) specified
checkInMarkedTimespanChecks whether an event resides in a timespan of a specific type
checkLimitViolationChecks whether the specified event takes place at the blocked time period
clearAllRemoves all events from the scheduler
closeAllSectionsCloses all sections in the currently active view
closeSectionCloses the specified section in the currently active view
collapseCollapses the expanded scheduler back to the normal size
confirmCalls a confirm message box
copyCreates a deep copy of the provided object
createDataProcessorCreates a new dataProcessor instance and attaches it to scheduler
createGridViewCreates the Grid view in the scheduler
createTimelineViewCreates the Timeline view in the scheduler
createUnitsViewCreates the Units view in the scheduler
definedReturns false if the provided argument is undefined, otherwise true
deleteAllSectionsDeletes all sections from the currently active view
deleteEventDeletes the specified event
deleteMarkedTimespanRemoves marking/blocking set by the addMarkedTimespan() method
deleteSectionDeletes a section from the currently active view
destroyCalendarDestroys previously created mini-calendar
destructorDestroys a scheduler instance
detachEventDetaches a handler from an event (which was attached before by the attachEvent method)
editOpens the inline editor to alter the event's text (the editor in the event's box)
editStopCloses the inline event editor, if it's currently open
endLightboxCloses the lightbox
eventAttaches an event handler to an HTML element
eventRemoveRemoves an event handler from an HTML element
expandExpands the scheduler to the full screen view
exportToPDFExports a Scheduler into the PDF format
exportToPNGExports a Scheduler into the PNG format
focusSets focus on the scheduler
formSectionGives access to the objects of lightbox's sections
getActionDataReturns the current cursor-pointed date and section (if defined)
getEventReturns the event object by its id
getEventEndDateGets the event's end date
getEventStartDateGets the event's start date
getEventTextGets the event's text
getEventsReturns a collection of events which occur during the specified period
getLabelGets the label of a select control in the lightbox
getLightboxGets the lightbox's HTML object element
getRecDatesReturns all occurrences of a recurring event
getRenderedEventGets the object of the currently displayed event
getSectionGets the object of the specified section in the currently active view
getShortcutHandlerGets a key navigation shortcut handler
getStateGets the current state of the scheduler
getUserDataGets the user data associated with the specified event
getViewReturns a view object by its name. If no name is specified, returns the current view
hideCoverHides the lightbox modal overlay that blocks interactions with the remaining screen
hideLightboxHides the lightbox without saving it
hideQuickInfoHides the pop-up event form (if it's currently active)
highlightEventPositionHighlights the event's duration on the time scale
initA constructor of a dhtmlxScheduler object
invertZonesInverts the specified time zones
isCalendarVisibleChecks whether the calendar is currently opened in the scheduler
isOneDayEventChecks whether the specified event one-day or multi-day
isViewExistsChecks whether a view with the specified name exists
linkCalendar'says' to change the active date in the mini calendar each time, the active date in the scheduler is changed
loadLoads data to the scheduler from an external data source
markCalendarApplies a css class to the specified date
markTimespanMarks 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
messageCalls a message box of the specified type
mixinAdds properties of the 'source' object into the 'target' object
modalboxCalls a modalbox
openAllSectionsOpens all sections in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored)
openSectionOpens the specified section in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored)
parseLoads data from a client-side resource
pluginsActivates the specified extensions
removeShortcutRemoves a keyboard shortcut
renderRepaints the scheduler
renderCalendarCreates a mini calendar
renderEventGenerates HTML content for a custom event's box
resetLightboxRemoves the current lightbox's HTML object element
scrollUnitScrolls the specified number of units in the Units view
selectSelects the specified event
serializeSerializes all events loaded into the scheduler
serverListDefines a named collection that can be loaded into Units, Timeline views, or the Lightbox
setCurrentViewDisplays the specified view and date
setEventAdds a new event to the scheduler's data pool
setEventEndDateSets the event's end date
setEventStartDateSets the event's start date
setEventTextSets the event's text
setLightboxSizeForces the lightbox to resize
setLoadModeSets the mode that allows loading data by parts (enables the dynamic loading)
setSkinSets the active skin
setUserDataSets the user data associated with the specified event
showCoverShows the lightbox modal overlay that blocks interactions with the remaining screen
showEventShows and highlights the specified event in the current or specified view
showLightboxOpens the lightbox for the specified event
showQuickInfoDisplays the pop-up event form for the specified event
startLightboxShows a custom lightbox in the specified HTML container centered on the screen
toICalConverts scheduler's data to the ICal format
toJSONConverts scheduler's data into the JSON format
toPDFExports the current view to a PDF document (can be used for printing)
toPDFRangeExports several scheduler's views to a PDF document (can be used for printing)
toXMLConverts scheduler's data into the XML format
uidGenerates a unique ID (unique inside the current scheduler, not GUID)
unblockTimeRemoves blocking set by the blockTime() method
unmarkCalendarRemoves a css class from the specified date
unmarkTimespanRemoves marking/blocking set by the markTimespan() method
unselectUnselects the specified event
updateCalendarDisplays the specified date in the mini calendar
updateCollectionUpdates the specified collection with new options
updateEventUpdates the specified event
updateViewDisplays the specified view and date (doesn't invoke any events)

Scheduler properties

NameDescription
active_link_view'says' to present the numbers of days in the Month view as clickable links that open the related day in the specified view
agenda_endSets the date to display events until
agenda_startSets the date to start displaying events from
ajax_errorSpecifies how to display the default error notification in case the XML data loading failed
all_timed'says' to show multi-day events in the regular way (as one-day events are displayed)
api_dateDefines the date format for the api_date template
auto_end_dateEnables automatic changing of the end event date after changing the start date
buttons_leftStores a collection of buttons resided in the left bottom corner of the lightbox
buttons_rightStores a collection of buttons resided in the right bottom corner of the lightbox
cascade_event_countSets the maximum number of events in a cascade
cascade_event_displaySets the 'cascade' display mode
cascade_event_marginSets the left margin for a cascade of events
check_limitsActivates/disables checking of limits
collision_limitSets the maximum allowable number of events per time slot
container_autoresizeForces the scheduler container to automatically change its size to show the whole content without scrolling
cspDefines internal implementation of the code of date formatting methods
date_formatSets the date format that is used to parse data from a data set and to send dates back to the server
day_column_paddingAdds padding to a view column
day_dateSets the date format for the X-Axis of the Week and Units views
dblclick_createEnables the possibility to create events by double click
default_dateSets the date format used by the templates 'day_date', 'week_date', 'day_scale_date' for setting date in the views' headers
delay_renderSets a timeout (in milliseconds) that wraps the updateView and setCurrentView calls (that cause re-drawing of the scheduler)
details_on_create'says' to use the extended form while creating new events by drag or double click
details_on_dblclick'says' to open the lightbox after double clicking on an event
display_marked_timespansDefines whether the marked(blocked) time spans should be highlighted in the scheduler
displayed_event_colorSets the default background color for the events retrieved by the showEvent() method
displayed_event_text_colorSets the default font color for the events retrieved by the showEvent() method
drag_createEnables the possibility to create new events by drag-and-drop
drag_event_bodyAllows dragging scheduler events by any part of the body
drag_highlightHighlights the event's initial position and duration on the time scale when you are dragging an event over the scheduler
drag_inRestrict dragging events to the calling scheduler from any other scheduler(s)
drag_lightboxEnables the possibility to drag the lightbox by the header
drag_moveEnables the possibility to move events by drag-and-drop
drag_outRestrict dragging events from the calling scheduler to any other scheduler(s)
drag_resizeEnables the possibility to resize events by drag-and-drop
edit_on_create'says' to open the lightbox while creating new events
event_attributeSets the name of the attribute that will specify the id of the event's HTML element
event_durationSets the initial duration of events in minutes
first_hourSets the minimum value for the hour scale (Y-Axis)
fix_tab_positionMoves views' tabs from the left to the right side
full_dayEnables setting of the event's duration to the full day
headerProvides a layout-like configuration for the scheduler header (navigation panel)
highlight_displayed_eventSpecifies whether events retrieved by the showEvent method should be highlighted while displaying
hour_dateSets the time format of Y-Axis. Also used in the default event and lighbox templates for setting the time part.
hour_size_pxSets the height of an hour unit in pixels
icons_editStores a collection of icons visible in the side edit menu of the event's box
icons_selectStores a collection of icons visible in the side selection menu of the event's box
include_end_byDefines whether the date specified in the 'End by' field should be exclusive or inclusive
key_navEnables the keyboard navigation in the scheduler
key_nav_stepDefines the minimal step (in minutes) for navigating events
last_hourSets the maximum value of the hour scale (Y-Axis)
left_borderAdds the dotted left border to the scheduler
lightboxSpecifies the lightbox object
lightbox_recurringDefines the lightbox's behavior, when the user opens the lightbox to edit a recurring event
limit_drag_outDenies to drag events out of the visible area of the scheduler
limit_endSets the end limit of the allowable date range
limit_startSets the start limit of the allowable date range
limit_time_selectSets max and min values of time selector in the lightbox to the values of the 'last_hour' and 'first_hour' options
limit_viewLimits the date period during which the user can view the events
load_dateSets the format of server request parameters 'from', 'to' in case of dynamic loading
map_endSets the date to display events until
map_error_positionSets the position that will be displayed on the map in case the event's location can't be identified
map_infowindow_max_widthThe maximum width of the map's popup marker in the Map view
map_initial_positionSets the initial position of the map
map_initial_zoomSets the initial zoom of the map in the Map view
map_resolve_event_locationActivates attempts to resolve the event's location, if the database doesn't have the event's coordinates stored
map_resolve_user_locationEnables/disables prompts asking the user to share his location for displaying on the map
map_settingsProvides map-related configuration settings
map_startSets the date to start displaying events from
map_typeSets the type of Google Maps
map_view_providerSpecifies the map provider
map_zoom_after_resolveSets the zoom that will be used to show the user's location, if the user agrees to the browser's offer to show it
mark_nowEnables/disables the marker displaying the current time
max_month_eventsSets the maximum number of events displayable in a cell
min_grid_sizeDefines the minimal possible size of the Grid view during autoresize
min_map_sizeDefines the minimal possible size of the Map view during autoresize
minicalendarSpecifies the mini calendar object
month_dateSets the format for the header of the Month view
month_daySets the format for the day in the cells of the Month and Year views
month_day_min_heightSets the minimum height of cells in the Month view
multi_dayEnables rendering of multi-day events
multi_day_height_limitSets the height of the area that displays multi-day events
multisectionEnables the possibility to render the same events in several sections of the Timeline or Units view
multisection_shift_allSpecifies 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')
now_dateSets the date for the current-time marker in the Limit extension (enabled by the configuration - mark_now)
occurrence_timestamp_in_utcAllows working with recurring events independently of time zones
overwrite_marked_timespansEnables blocking priority for marked timespans
parse_exact_formatDefines whether scheduler automatically identifies the format of data
positive_closingDefines the 'saving' behaviour for the case, when the user edits the event's text directly in the event's box
preserve_lengthPreserves the visible length of an event while dragging along a non-linear time scale
preserve_scrollCancels preserving of the current scroll position while navigating between dates of the same view
prevent_cacheEnables/disables caching of GET requests in the browser
quick_info_detachedDefines whether the event form will appear from the left/right side of the screen or near the selected event
readonlyActivates the read-only mode for the scheduler
readonly_formActivates the read-only mode for the lightbox
recurring_overflow_instancesDefines the behavior of the recurrences that transfer to the next month
recurring_workdaysSpecifies working days that will affect the recurring event when the user selects the ""Every workday" option in the lightbox
repeat_dateSets the date format of the 'End by' field in the 'recurring' lightbox
repeat_precisePrevents including past days to events with the 'weekly' recurrence
resize_month_eventsEnables the possibility to resize multi-day events in the Month view by drag-and-drop
resize_month_timedEnables the possibility to resize single-day events in the Month view by drag-n-drop
responsive_lightboxMakes lightbox responsive on small screens
rtlEnables RTL (right-to-left) mode for the scheduler
scroll_hourSets the initial position of the vertical scroll in the scheduler (an hour in the 24-hour clock format)
section_delimiterSpecifies the delimeter that will be used to separate several sections/units in the related data property of the event
selectShows/hides the select bar in the event's box
separate_short_eventsAllows preventing short events from overlapping
server_utcEnables converting server-side dates from UTC to a local time zone (and backward) while sending data to the server
show_errorsEnables showing error alerts in case of unexpected behavior
show_loadingEnables showing a progress/spinner while data is loading (useful for dynamic loading)
show_quick_infoActivates/disables the 'quick_info' extension (pop-up task's details form)
start_on_mondaySets the start day of weeks
time_stepSets the minimum step (in minutes) for event's time values
timeline_swap_resizeDefines 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)
tooltip_hide_timeoutSets the length of time in milliseconds before the tooltip hides
tooltip_offset_xSets the right (if positive) offset of the tooltip's position
tooltip_offset_ySets the top (if positive) offset of the tooltip's position
tooltip_timeoutSets the timeout in milliseconds before the tooltip is displayed for a task
touchEnables/disables the touch support in the scheduler
touch_dragDefines the time period in milliseconds that is used to differ the long touch gesture from the scroll gesture
touch_swipe_datesEnables/disables switching active dates using the horizontal swipe gesture on mobiles
touch_tipEnables/disables prompting messages in the right top corner of the screen
touch_tooltipAllows displaying dhtmxlScheduler's tooltips on the touch devices
undo_deletedProvides the Undo popup when you delete an event
update_renderUpdates the mode when the scheduler fully repaints itself on any action
use_select_menu_spaceDefines that events occupy the whole width of the cell
wai_aria_application_roleDefines whether role="application" will be used for the main scheduler container and minicalendar elements
wai_aria_attributesEnables WAI-ARIA support to make the component recognizable for screen readers
week_agenda_selectHighlights the selected event in the Week Agenda view
week_dateSets the format of the date in the sub-header of the Month view
wide_formEnables/disables displaying of the standard (wide) lightbox instead of the short one
xml_datedefines date formats that are used to parse data from a data set and to send data to a server
year_xSets the number of rows in the Year view
year_ySets the number of columns in the Year view

Scheduler events

NameDescription
onAfterBatchUpdateFires after the batchUpdate method has been called
onAfterEventDisplayFires when the scheduler switches views, days, time etc. to show the event specified by the 'showEvent' method and fires AFTER the event is displayed
onAfterFolderToggleFires after a tree branch was opened or closed (the Timeline view, 'tree' mode only)
onAfterLightboxFires after the user has closed the lightbox (edit form)
onAfterQuickInfoFires after the pop-up event form is closed
onAfterSchedulerResizeFires after the scheduler has changed its size and data area was repainted
onBeforeBatchUpdateFires before the batchUpdate method is called
onBeforeCollapseFires when a user clicks on the expand icon to change the scheduler's size from 'full screen' to original.
onBeforeDragFires when the user starts the drag/resize operation (version 2.1+)
onBeforeEventChangedFires when the event has been changed by drag-n-drop, but the changes aren't saved yet.
onBeforeEventCreatedFires when the user creates a new event by dragging the cursor over the scheduler
onBeforeEventDeleteFires after the user clicks on the delete button (in the event bar or details window)
onBeforeEventDisplayFires when the 'showEvent' method is called to show a specific event and fires BEFORE the event is displayed
onBeforeEventDragInFires before a dragged event is moved over the scheduler
onBeforeEventDragOutFires before the dragged event is moved out of the scheduler
onBeforeEventPastedFires before the user presses the 'CTRL+V' keyboard command
onBeforeExpandFires when a user clicks on the expand icon to change the scheduler's size from original to 'full screen'.
onBeforeExternalDragInFires before some element starts to be dragged into the scheduler from an outside DHTMLX component (only with dnd extension enabled)
onBeforeFolderToggleFires before a tree branch will be opened or closed (the Timeline view, 'tree' mode only)
onBeforeLightboxFires immediately before the user opens the lightbox (edit form)
onBeforeParseFires before data started to be parsed
onBeforeQuickInfoFires immediately before the Quick Info popup is displayed for an event
onBeforeSectionRenderFires before a single Timeline section was configured, but not rendered yet (the Timeline view only)
onBeforeTodayDisplayedFires when the user clicks on the 'Today' button in the scheduler
onBeforeTooltipFires before the tooltip is displayed for a data item (only with the 'tooltip' extension enabled)
onBeforeViewChangeFires before the user changes the current view to some other one
onCellClickFires when the user makes a single click on a cell (the Timeline view only)
onCellDblClickFires when the user makes a double click on a cell (the Timeline view only)
onClearAllFires after data in the scheduler was cleared
onClickFires when the user clicks the left mouse button on an event
onCollapseFires when a user clicks on the expand icon to change the scheduler's size from 'full screen' to original.
onConfirmedBeforeEventDeleteFires after the user clicks on the delete button and confirms the deletion (in the event's bar or details window)
onContextMenuFires when the user calls the context menu by clicking the right mouse button inside the scheduler
onDataRenderFires after data has been rendered on the page
onDblClickFires when the user double clicks on an event
onDestroyFires after scheduler has been cleared by the destructor method
onDragEndFires when the drag/resize operation is finished
onEmptyClickFires when the user clicks on an empty space in the scheduler (not on events)
onErrorFires when assert receives the 'false' value, i.e. when assertion fails
onEventAddedFires when the user adds a new event to the scheduler
onEventCancelFires when the user clicks on the 'Cancel' button in the lightbox (edit form)
onEventChangedOccurs after the user has edited an event and saved the changes (after clicking on the edit and save buttons in the event's bar or in the details window)
onEventCollisionFires when the user tries to create a new event (or modify some existing one) inside of some already occupied time slot
onEventCopiedFires when the user presses the 'CTRL+C' keyboard command (only with the 'keyboard navigation' extension enabled)
onEventCreatedFires when the user starts to create a new event (by double click or dragging)
onEventCutFires when the user presses the 'CTRL+X' keyboard command (only with the 'keyboard navigation' extension enabled)
onEventDeletedFires after the specified event was deleted (version 3.0+)
onEventDragFires when the user drags/resizes events in the scheduler
onEventDragInFires when a dragged event is moved into the scheduler
onEventDragOutFires when a dragged event is moved out of the scheduler
onEventDropOutFires when a dragged event is dropped onto the area out of the scheduler
onEventIdChangeFires when the id of an event is changed
onEventLoadingFires when an event is being loaded from the data source
onEventPastedFires when the user presses the 'CTRL+V' keyboard command
onEventSaveFires when the user clicks on the 'save' button in the lightbox (edit form)
onEventSelectedFires when the user selects an event in the scheduler
onEventUnselectedFires when the user unselects an event by selecting some other event
onExpandFires when a user clicks on the expand icon to change the scheduler's size from original to 'full screen'.
onExternalDragInFires when some data is being dragged into the scheduler from an outside DHTMLX component (only with dnd extension enabled)
onLightboxFires after the user has opened the lightbox (edit form)
onLightboxButtonFires when the user clicks a custom button in the lightbox
onLimitViolationFires when the user tries to set for an event the time that is currently limited/blocked
onLoadEndFires after loading data from the data source has been completed
onLoadErrorFires if the scheduler has failed to parse data, or if the server has returned 4xx or 5xx response status
onLoadStartFires immediately before loading data from the data source has been started
onLocationErrorFires when the event location can't be found on the map (the Map view only)
onMouseDownFires when the user clicks on a scheduler's element that doesn't have the predefined 'onlick' handler
onMouseMoveFires when the mouse cursor is moved over the scheduler
onOptionsLoadFires after sections of the Timeline/Units view have been updated
onOptionsLoadFinalFires after loading of an options(sections) collection is complete (the Timeline view only)
onOptionsLoadStartFires before a collection of options or sections starts to be loaded from the server (the Timeline view only)
onParseFires after data was parsed (became available for API) but before it was rendered in the Scheduler
onQuickInfoFires when the pop-up edit form appears
onSaveErrorFires when some error has happened during data updating
onScaleAddFires after a single view unit (column, section, day cell etc.) has been rendered in the scheduler
onScaleDblClickFires when the user double clicks on the time scale
onSchedulerReadyFires after scheduler initialization is complete, but the scheduler is not rendered on the page yet.
onSchedulerResizeFires before the scheduler changes its size
onTemplatesReadyFires when the scheduler templates are initialized
onTimelineCreatedFires after the Timeline view has been initialized, but is not rendered on the page yet (the Timeline view only)
onViewChangeFires after the current view has been changed to some other one
onViewMoreClickFires when the user clicks on the 'View more' link in the Month view (the Month view only)
onXLEFires after loading data from the data source is complete
onXLSFires immediately before loading data from the data source has been started
onXScaleClickFires when the user makes a single click on a cell on the x-axis (the Timeline view only)
onXScaleDblClickFires when the user makes a double click on a cell on the x-axis (the Timeline view only)
onYScaleClickFires when the user makes a single click on a cell on the y-axis (the Timeline view only)
onYScaleDblClickFires when the user makes a double click on a cell on the y-axis (the Timeline view only)

Scheduler templates

NameDescription
agenda_dateSpecifies the date in the header of the view
agenda_daySpecifies the content of the day cell of the Agenda view
agenda_textSpecifies the text in the second column of the Agenda view
agenda_timeSpecifies the date in the first column of the Agenda view
api_dateSpecifies the format of dates that are set by means of API methods. Used to parse incoming dates
calendar_dateSpecifies the content of day-cells in the Mini-Calendar (date picker)
calendar_monthSpecifies the date in the header of the Mini-Calendar (date picker)
calendar_scale_dateSpecifies the format of week-days in the header of the Mini-Calendar (date picker)
calendar_timeSpecifies the date format of the lightbox's start and end date inputs
day_dateSpecifies the date in the header of the Day and Units views
day_scale_dateSpecifies the date in the sub-header of the Day view
drag_marker_classSpecifies the CSS class that will be applied to the highlighted event's duration on the time scale
drag_marker_contentSpecifies the content of the highlighted block on the time scale
event_bar_dateSpecifies the date of an event. Applied to one-day events only
event_bar_textSpecifies the event's text. Applied to multi-day events only
event_classSpecifies the CSS class that will be applied to the event's container
event_dateSpecifies the time part of the start and end dates of the event. Mostly used by other templates for presenting time periods
event_headerSpecifies the event's header
event_textSpecifies the event's text
format_dateСonverts date object to a date string. Used to send data back to the server
GRID_dateSpecifies the date in the header of the view
GRID_full_dateSpecifies the format of dates in columns with id='date'
GRID_single_dateSpecifies the format of dates in columns with id='start_date' or id='end_date'
GRID_fieldSpecifies the text in the columns
hour_scaleSpecifies the items of the Y-Axis
load_formatSpecifies the format of requests in the dynamic loading mode
map_dateSpecifies the date in the header of the view
map_info_contentSpecifies the content of the info window in the Map View
map_textSpecifies the text in the second column of the view
map_timeSpecifies the date in the first column of the view
month_dateSpecifies the date in the header of the view
month_date_classSpecifies the CSS class that will be applied to a day cell
month_daySpecifies the format of the day in a cell
month_events_linkSpecifies the presentation of the 'View more' link in a cell of the Month view
month_scale_dateSpecifies the date format of the X-Axis of the view
parse_dateConverts date string into a Date object
quick_info_contentSpecifies the content of the pop-up edit form
quick_info_dateSpecifies the date of the pop-up edit form
quick_info_titleSpecifies the title of the pop-up edit form
time_pickerSpecifies the drop-down time selector in the lightbox
time_slot_classSpecifies the CSS class of the background cell in the Day/Week views
time_slot_textSpecifies the content of the background cell in the Day/Week views
tooltip_date_formatSpecifies the format of start and end dates displayed in the tooltip
tooltip_textSpecifies the text of tooltips
week_agenda_dateSpecifies the date in the header of the Week Agenda view
week_agenda_event_textSpecifies the event's text
week_agenda_scale_dateThe date of a day cell of the view
week_dateSpecifies the date in the header of the view
week_date_classSpecifies the CSS class that will be applied to a day cell
week_scale_dateSpecifies the date in the sub-header of the view
year_dateSpecifies the date in the header of the view
year_monthSpecifies the month's name in the header of a month block of the view.
year_scale_dateSpecifies the day's name in the sub-header of a month block of the view
year_tooltipSpecifies the tooltip over a day cell containing some scheduled event(s)
lightbox_headerSpecifies the lightbox's header
TIMELINE_cell_valueSpecifies the number of scheduled events in a cell of the view
TIMELINE_cell_classSpecifies the CSS class that will be applied to a cell of the view
TIMELINE_scalex_classSpecifies the name of a CSS class that will be applied to items of the X-Axis
TIMELINE_second_scalex_classSpecifies the name of a CSS class that will be applied to items of the second X-Axis
TIMELINE_scaley_classSpecifies the name of a CSS class that will be applied to items of the Y-Axis
TIMELINE_scale_labelSpecifies items of the Y-Axis
TIMELINE_tooltipSpecifies the tooltip over a day cell containing some scheduled event(s)
TIMELINE_dateSpecifies the date in the header of the view
TIMELINE_scale_dateSpecifies items of the X-Axis
TIMELINE_second_scale_dateSpecifies items of the second X-Axis
TIMELINE_row_classSpecifies the CSS class that will be applied to a row of the Timeline view
UNITS_dateSpecifies the date in the header of the view
UNITS_scale_textSpecifies items of the X-Axis
xml_dateA string from an XML file is converted into a date object in conformity with this template
xml_formatA date object is converted into a string in conformity with this template. Used to send data back to the server

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.