Skip to main content

Events overview

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)
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.