Methods overview

Name	Description
DataProcessor	DataProcessor constructor
Promise	Promise object constructor
addEvent	Adds a new event
addEventNow	Adds a new event and opens the lightbox to confirm
addMarkedTimespan	Marks dates, but with certain settings makes blocking (allows setting custom styling for the limit)
addSection	Adds a section to the currently active view
addShortcut	Adds a new keyboard shortcut
alert	Calls an alert message box
assert	If the specified expression is false, an errorMessage is shown in a red popup at the top right corner of the screen
attachEvent	Attaches the handler to an inner event of dhtmlxScheduler
backbone	Makes the scheduler reflect all data changes in the Backbone model and vice versa
batchUpdate	Updates multiple events at once
bind	Creates a new function that when called has its this keyword set to the provided value
blockTime	Blocks the specified date and applies the default 'dimmed' style to it.
callEvent	Calls an inner event
changeEventId	Changes the event's id
checkCollision	Checks whether the specified event occurs at the time that has already been occupied by another event(s)
checkEvent	Checks whether an event has some handler(s) specified
checkInMarkedTimespan	Checks whether an event resides in a timespan of a specific type
checkLimitViolation	Checks whether the specified event takes place at the blocked time period
clearAll	Removes all events from the scheduler
closeAllSections	Closes all sections in the currently active view
closeSection	Closes the specified section in the currently active view
collapse	Collapses the expanded scheduler back to the normal size
confirm	Calls a confirm message box
copy	Creates a deep copy of the provided object
createDataProcessor	Creates a new dataProcessor instance and attaches it to scheduler
createGridView	Creates the Grid view in the scheduler
createTimelineView	Creates the Timeline view in the scheduler.
createUnitsView	Creates the Units view in the scheduler
defined	Returns false if the provided argument is undefined, otherwise true
deleteAllSections	Deletes all sections from the currently active view
deleteEvent	Deletes the specified event
deleteMarkedTimespan	Removes marking/blocking set by the addMarkedTimespan() method
deleteSection	Deletes a section from the currently active view
destroyCalendar	Destroys previously created mini-calendar
destructor	Destroys a scheduler instance
detachEvent	Detaches a handler from an event (which was attached before by the attachEvent method)
edit	Opens the inline editor to alter the event's text (the editor in the event's box)
editStop	Closes the inline event editor, if it's currently open
endLightbox	Closes the lightbox
event	Attaches an event handler to an HTML element
eventRemove	Removes an event handler from an HTML element
expand	Expands the scheduler to the full screen view
exportToPDF	Exports a Scheduler into the PDF format
exportToPNG	Exports a Scheduler into the PNG format
focus	Sets focus on the scheduler
formSection	Gives access to the objects of lightbox's sections
getActionData	Returns the current cursor-pointed date and section (if defined)
getEvent	Returns the event object by its id
getEventEndDate	Gets the event's end date
getEventStartDate	Gets the event's start date
getEventText	Gets the event's text
getEvents	Returns a collection of events which occur during the specified period
getLabel	Gets the label of a select control in the lightbox
getLightbox	Gets the lightbox's HTML object element
getRecDates	Returns all occurrences of a recurring event
getRenderedEvent	Gets the object of the currently displayed event
getSection	Gets the object of the specified section in the currently active view
getShortcutHandler	Gets a key navigation shortcut handler
getState	Gets the current state of the scheduler
getUserData	Gets the user data associated with the specified event
getView	Returns a view object by its name. If no name is specified, returns the current view
hideCover	Hides the lightbox modal overlay that blocks interactions with the remaining screen
hideLightbox	Hides the lightbox without saving it
hideQuickInfo	Hides the pop-up event form (if it's currently active)
highlightEventPosition	Highlights the event's duration on the time scale
init	A constructor of a dhtmlxScheduler object
invertZones	Inverts the specified time zones
isCalendarVisible	Checks whether the calendar is currently opened in the scheduler
isOneDayEvent	Checks whether the specified event one-day or multi-day
isViewExists	Checks 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
load	Loads data to the scheduler from an external data source
markCalendar	Applies a css class to the specified date
markTimespan	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
message	Calls a message box of the specified type
mixin	Adds properties of the 'source' object into the 'target' object
modalbox	Calls a modalbox
openAllSections	Opens all sections in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored)
openSection	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)
parse	Loads data from a client-side resource
plugins	Activates the specified extensions
removeShortcut	Removes a keyboard shortcut
render	Repaints the scheduler
renderCalendar	Creates a mini calendar
renderEvent	Generates HTML content for a custom event's box
resetLightbox	Removes the current lightbox's HTML object element
scrollUnit	Scrolls the specified number of units in the Units view
select	Selects the specified event
serialize	Serializes all events loaded into the scheduler
serverList	Defines a named collection that can be loaded into Units, Timeline views, or the Lightbox
setCurrentView	Displays the specified view and date
setEvent	Adds a new event to the scheduler's data pool
setEventEndDate	Sets the event's end date
setEventStartDate	Sets the event's start date
setEventText	Sets the event's text
setLightboxSize	Forces the lightbox to resize
setLoadMode	Sets the mode that allows loading data by parts (enables the dynamic loading)
setSkin	Sets the active skin
setUserData	Sets the user data associated with the specified event
showCover	Shows the lightbox modal overlay that blocks interactions with the remaining screen
showEvent	Shows and highlights the specified event in the current or specified view
showLightbox	Opens the lightbox for the specified event
showQuickInfo	Displays the pop-up event form for the specified event
startLightbox	Shows a custom lightbox in the specified HTML container centered on the screen
toICal	Converts scheduler's data to the ICal format
toJSON	Converts scheduler's data into the JSON format
toPDF	Exports the current view to a PDF document (can be used for printing)
toPDFRange	Exports several scheduler's views to a PDF document (can be used for printing)
toXML	Converts scheduler's data into the XML format
uid	Generates a unique ID (unique inside the current scheduler, not GUID)
unblockTime	Removes blocking set by the blockTime() method
unmarkCalendar	Removes a css class from the specified date
unmarkTimespan	Removes marking/blocking set by the markTimespan() method
unselect	Unselects the specified event
updateCalendar	Displays the specified date in the mini calendar
updateCollection	Updates the specified collection with new options
updateEvent	Updates the specified event
updateView	Displays the specified view and date (doesn't invoke any events)