API overview
Scheduler methods
| 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) |
Scheduler properties
| Name | Description |
|---|---|
| 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_end | Sets the date to display events until |
| agenda_start | Sets the date to start displaying events from |
| ajax_error | Specifies 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_date | Defines the date format for the api_date template |
| auto_end_date | Enables automatic changing of the end event date after changing the start date |
| buttons_left | Stores a collection of buttons resided in the left bottom corner of the lightbox |
| buttons_right | Stores a collection of buttons resided in the right bottom corner of the lightbox |
| cascade_event_count | Sets the maximum number of events in a cascade |
| cascade_event_display | Sets the 'cascade' display mode |
| cascade_event_margin | Sets the left margin for a cascade of events |
| check_limits | Activates/disables checking of limits |
| collision_limit | Sets the maximum allowable number of events per time slot |
| container_autoresize | Forces the scheduler container to automatically change its size to show the whole content without scrolling |
| csp | Defines internal implementation of the code of date formatting methods |
| date_format | Sets the date format that is used to parse data from a data set and to send dates back to the server |
| day_column_padding | Adds padding to a view column |
| day_date | Sets the date format for the X-Axis of the Week and Units views |
| dblclick_create | Enables the possibility to create events by double click |
| default_date | Sets the date format used by the templates 'day_date', 'week_date', 'day_scale_date' for setting date in the views' headers |
| delay_render | Sets 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_timespans | Defines whether the marked(blocked) time spans should be highlighted in the scheduler |
| displayed_event_color | Sets the default background color for the events retrieved by the showEvent() method |
| displayed_event_text_color | Sets the default font color for the events retrieved by the showEvent() method |
| drag_create | Enables the possibility to create new events by drag-and-drop |
| drag_event_body | Allows dragging scheduler events by any part of the body |
| drag_highlight | Highlights the event's initial position and duration on the time scale when you are dragging an event over the scheduler |
| drag_in | Restrict dragging events to the calling scheduler from any other scheduler(s) |
| drag_lightbox | Enables the possibility to drag the lightbox by the header |
| drag_move | Enables the possibility to move events by drag-and-drop |
| drag_out | Restrict dragging events from the calling scheduler to any other scheduler(s) |
| drag_resize | Enables the possibility to resize events by drag-and-drop |
| edit_on_create | 'says' to open the lightbox while creating new events |
| event_attribute | Sets the name of the attribute that will specify the id of the event's HTML element |
| event_duration | Sets the initial duration of events in minutes |
| first_hour | Sets the minimum value for the hour scale (Y-Axis) |
| fix_tab_position | Moves views' tabs from the left to the right side |
| full_day | Enables setting of the event's duration to the full day |
| header | Provides a layout-like configuration for the scheduler header (navigation panel) |
| highlight_displayed_event | Specifies whether events retrieved by the showEvent method should be highlighted while displaying |
| hour_date | Sets the time format of Y-Axis. Also used in the default event and lighbox templates for setting the time part. |
| hour_size_px | Sets the height of an hour unit in pixels |
| icons_edit | Stores a collection of icons visible in the side edit menu of the event's box |
| icons_select | Stores a collection of icons visible in the side selection menu of the event's box |
| include_end_by | Defines whether the date specified in the 'End by' field should be exclusive or inclusive |
| key_nav | Enables the keyboard navigation in the scheduler |
| key_nav_step | Defines the minimal step (in minutes) for navigating events |
| last_hour | Sets the maximum value of the hour scale (Y-Axis) |
| left_border | Adds the dotted left border to the scheduler |
| lightbox | Specifies the lightbox object |
| lightbox_recurring | Defines the lightbox's behavior, when the user opens the lightbox to edit a recurring event |
| limit_drag_out | Denies to drag events out of the visible area of the scheduler |
| limit_end | Sets the end limit of the allowable date range |
| limit_start | Sets the start limit of the allowable date range |
| limit_time_select | Sets max and min values of time selector in the lightbox to the values of the 'last_hour' and 'first_hour' options |
| limit_view | Limits the date period during which the user can view the events |
| load_date | Sets the format of server request parameters 'from', 'to' in case of dynamic loading |
| map_end | Sets the date to display events until |
| map_error_position | Sets the position that will be displayed on the map in case the event's location can't be identified |
| map_infowindow_max_width | The maximum width of the map's popup marker in the Map view |
| map_initial_position | Sets the initial position of the map |
| map_initial_zoom | Sets the initial zoom of the map in the Map view |
| map_resolve_event_location | Activates attempts to resolve the event's location, if the database doesn't have the event's coordinates stored |
| map_resolve_user_location | Enables/disables prompts asking the user to share his location for displaying on the map |
| map_settings | Provides map-related configuration settings |
| map_start | Sets the date to start displaying events from |
| map_type | Sets the type of Google Maps |
| map_view_provider | Specifies the map provider |
| map_zoom_after_resolve | 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 |
| mark_now | Enables/disables the marker displaying the current time |
| max_month_events | Sets the maximum number of events displayable in a cell |
| min_grid_size | Defines the minimal possible size of the Grid view during autoresize |
| min_map_size | Defines the minimal possible size of the Map view during autoresize |
| minicalendar | Specifies the mini calendar object |
| month_date | Sets the format for the header of the Month view |
| month_day | Sets the format for the day in the cells of the Month and Year views |
| month_day_min_height | Sets the minimum height of cells in the Month view |
| multi_day | Enables rendering of multi-day events |
| multi_day_height_limit | Sets the height of the area that displays multi-day events |
| multisection | Enables the possibility to render the same events in several sections of the Timeline or Units view |
| multisection_shift_all | 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') |
| now_date | Sets the date for the current-time marker in the Limit extension (enabled by the configuration - mark_now) |
| occurrence_timestamp_in_utc | Allows working with recurring events independently of time zones |
| overwrite_marked_timespans | Enables blocking priority for marked timespans |
| parse_exact_format | Defines whether scheduler automatically identifies the format of data |
| positive_closing | Defines the 'saving' behaviour for the case, when the user edits the event's text directly in the event's box |
| preserve_length | Preserves the visible length of an event while dragging along a non-linear time scale |
| preserve_scroll | Cancels preserving of the current scroll position while navigating between dates of the same view |
| prevent_cache | Enables/disables caching of GET requests in the browser |
| quick_info_detached | Defines whether the event form will appear from the left/right side of the screen or near the selected event |
| readonly | Activates the read-only mode for the scheduler |
| readonly_form | Activates the read-only mode for the lightbox |
| recurring_overflow_instances | Defines the behavior of the recurrences that transfer to the next month |
| recurring_workdays | Specifies working days that will affect the recurring event when the user selects the ""Every workday" option in the lightbox |
| repeat_date | Sets the date format of the 'End by' field in the 'recurring' lightbox |
| repeat_precise | Prevents including past days to events with the 'weekly' recurrence |
| resize_month_events | Enables the possibility to resize multi-day events in the Month view by drag-and-drop |
| resize_month_timed | Enables the possibility to resize single-day events in the Month view by drag-n-drop |
| responsive_lightbox | Makes lightbox responsive on small screens |
| rtl | Enables RTL (right-to-left) mode for the scheduler |
| scroll_hour | Sets the initial position of the vertical scroll in the scheduler (an hour in the 24-hour clock format) |
| section_delimiter | Specifies the delimeter that will be used to separate several sections/units in the related data property of the event |
| select | Shows/hides the select bar in the event's box |
| separate_short_events | Allows preventing short events from overlapping |
| server_utc | Enables converting server-side dates from UTC to a local time zone (and backward) while sending data to the server |
| show_errors | Enables showing error alerts in case of unexpected behavior |
| show_loading | Enables showing a progress/spinner while data is loading (useful for dynamic loading) |
| show_quick_info | Activates/disables the 'quick_info' extension (pop-up task's details form) |
| start_on_monday | Sets the start day of weeks |
| time_step | Sets the minimum step (in minutes) for event's time values |
| timeline_swap_resize | 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) |
| tooltip_hide_timeout | Sets the length of time in milliseconds before the tooltip hides |
| tooltip_offset_x | Sets the right (if positive) offset of the tooltip's position |
| tooltip_offset_y | Sets the top (if positive) offset of the tooltip's position |
| tooltip_timeout | Sets the timeout in milliseconds before the tooltip is displayed for a task |
| touch | Enables/disables the touch support in the scheduler |
| touch_drag | Defines the time period in milliseconds that is used to differ the long touch gesture from the scroll gesture |
| touch_swipe_dates | Enables/disables switching active dates using the horizontal swipe gesture on mobiles |
| touch_tip | Enables/disables prompting messages in the right top corner of the screen |
| touch_tooltip | Allows displaying dhtmxlScheduler's tooltips on the touch devices |
| undo_deleted | Provides the Undo popup when you delete an event |
| update_render | Updates the mode when the scheduler fully repaints itself on any action |
| use_select_menu_space | Defines that events occupy the whole width of the cell |
| wai_aria_application_role | Defines whether role="application" will be used for the main scheduler container and minicalendar elements |
| wai_aria_attributes | Enables WAI-ARIA support to make the component recognizable for screen readers |
| week_agenda_select | Highlights the selected event in the Week Agenda view |
| week_date | Sets the format of the date in the sub-header of the Month view |
| wide_form | Enables/disables displaying of the standard (wide) lightbox instead of the short one |
| xml_date | defines date formats that are used to parse data from a data set and to send data to a server |
| year_x | Sets the number of rows in the Year view |
| year_y | Sets the number of columns in the Year view |
Scheduler events
| Name | Description |
|---|---|
| onAfterBatchUpdate | Fires after the batchUpdate method has been called |
| onAfterEventDisplay | Fires when the scheduler switches views, days, time etc. to show the event specified by the 'showEvent' method and fires AFTER the event is displayed |
| onAfterFolderToggle | Fires after a tree branch was opened or closed (the Timeline view, 'tree' mode only) |
| onAfterLightbox | Fires after the user has closed the lightbox (edit form) |
| onAfterQuickInfo | Fires after the pop-up event form is closed |
| onAfterSchedulerResize | Fires after the scheduler has changed its size and data area was repainted |
| onBeforeBatchUpdate | Fires before the batchUpdate method is called |
| onBeforeCollapse | Fires when a user clicks on the expand icon to change the scheduler's size from 'full screen' to original. |
| onBeforeDrag | Fires when the user starts the drag/resize operation (version 2.1+) |
| onBeforeEventChanged | Fires when the event has been changed by drag-n-drop, but the changes aren't saved yet. |
| onBeforeEventCreated | Fires when the user creates a new event by dragging the cursor over the scheduler |
| onBeforeEventDelete | Fires after the user clicks on the delete button (in the event bar or details window) |
| onBeforeEventDisplay | Fires when the 'showEvent' method is called to show a specific event and fires BEFORE the event is displayed |
| onBeforeEventDragIn | Fires before a dragged event is moved over the scheduler |
| onBeforeEventDragOut | Fires before the dragged event is moved out of the scheduler |
| onBeforeEventPasted | Fires before the user presses the 'CTRL+V' keyboard command |
| onBeforeExpand | Fires when a user clicks on the expand icon to change the scheduler's size from original to 'full screen'. |
| onBeforeExternalDragIn | Fires before some element starts to be dragged into the scheduler from an outside DHTMLX component (only with dnd extension enabled) |
| onBeforeFolderToggle | Fires before a tree branch will be opened or closed (the Timeline view, 'tree' mode only) |
| onBeforeLightbox | Fires immediately before the user opens the lightbox (edit form) |
| onBeforeParse | Fires before data started to be parsed |
| onBeforeQuickInfo | Fires immediately before the Quick Info popup is displayed for an event |
| onBeforeSectionRender | Fires before a single Timeline section was configured, but not rendered yet (the Timeline view only) |
| onBeforeTodayDisplayed | Fires when the user clicks on the 'Today' button in the scheduler |
| onBeforeTooltip | Fires before the tooltip is displayed for a data item (only with the 'tooltip' extension enabled) |
| onBeforeViewChange | Fires before the user changes the current view to some other one |
| onCellClick | Fires when the user makes a single click on a cell (the Timeline view only) |
| onCellDblClick | Fires when the user makes a double click on a cell (the Timeline view only) |
| onClearAll | Fires after data in the scheduler was cleared |
| onClick | Fires when the user clicks the left mouse button on an event |
| onCollapse | Fires when a user clicks on the expand icon to change the scheduler's size from 'full screen' to original. |
| onConfirmedBeforeEventDelete | Fires after the user clicks on the delete button and confirms the deletion (in the event's bar or details window) |
| onContextMenu | Fires when the user calls the context menu by clicking the right mouse button inside the scheduler |
| onDataRender | Fires after data has been rendered on the page |
| onDblClick | Fires when the user double clicks on an event |
| onDestroy | Fires after scheduler has been cleared by the destructor method |
| onDragEnd | Fires when the drag/resize operation is finished |
| onEmptyClick | Fires when the user clicks on an empty space in the scheduler (not on events) |
| onError | Fires when assert receives the 'false' value, i.e. when assertion fails |
| onEventAdded | Fires when the user adds a new event to the scheduler |
| onEventCancel | Fires when the user clicks on the 'Cancel' button in the lightbox (edit form) |
| onEventChanged | Occurs 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) |
| onEventCollision | Fires when the user tries to create a new event (or modify some existing one) inside of some already occupied time slot |
| onEventCopied | Fires when the user presses the 'CTRL+C' keyboard command (only with the 'keyboard navigation' extension enabled) |
| onEventCreated | Fires when the user starts to create a new event (by double click or dragging) |
| onEventCut | Fires when the user presses the 'CTRL+X' keyboard command (only with the 'keyboard navigation' extension enabled) |
| onEventDeleted | Fires after the specified event was deleted (version 3.0+) |
| onEventDrag | Fires when the user drags/resizes events in the scheduler |
| onEventDragIn | Fires when a dragged event is moved into the scheduler |
| onEventDragOut | Fires when a dragged event is moved out of the scheduler |
| onEventDropOut | Fires when a dragged event is dropped onto the area out of the scheduler |
| onEventIdChange | Fires when the id of an event is changed |
| onEventLoading | Fires when an event is being loaded from the data source |
| onEventPasted | Fires when the user presses the 'CTRL+V' keyboard command |
| onEventSave | Fires when the user clicks on the 'save' button in the lightbox (edit form) |
| onEventSelected | Fires when the user selects an event in the scheduler |
| onEventUnselected | Fires when the user unselects an event by selecting some other event |
| onExpand | Fires when a user clicks on the expand icon to change the scheduler's size from original to 'full screen'. |
| onExternalDragIn | Fires when some data is being dragged into the scheduler from an outside DHTMLX component (only with dnd extension enabled) |
| onLightbox | Fires after the user has opened the lightbox (edit form) |
| onLightboxButton | Fires when the user clicks a custom button in the lightbox |
| onLimitViolation | Fires when the user tries to set for an event the time that is currently limited/blocked |
| onLoadEnd | Fires after loading data from the data source has been completed |
| onLoadError | Fires if the scheduler has failed to parse data, or if the server has returned 4xx or 5xx response status |
| onLoadStart | Fires immediately before loading data from the data source has been started |
| onLocationError | Fires when the event location can't be found on the map (the Map view only) |
| onMouseDown | Fires when the user clicks on a scheduler's element that doesn't have the predefined 'onlick' handler |
| onMouseMove | Fires when the mouse cursor is moved over the scheduler |
| onOptionsLoad | Fires after sections of the Timeline/Units view have been updated |
| onOptionsLoadFinal | Fires after loading of an options(sections) collection is complete (the Timeline view only) |
| onOptionsLoadStart | Fires before a collection of options or sections starts to be loaded from the server (the Timeline view only) |
| onParse | Fires after data was parsed (became available for API) but before it was rendered in the Scheduler |
| onQuickInfo | Fires when the pop-up edit form appears |
| onSaveError | Fires when some error has happened during data updating |
| onScaleAdd | Fires after a single view unit (column, section, day cell etc.) has been rendered in the scheduler |
| onScaleDblClick | Fires when the user double clicks on the time scale |
| onSchedulerReady | Fires after scheduler initialization is complete, but the scheduler is not rendered on the page yet. |
| onSchedulerResize | Fires before the scheduler changes its size |
| onTemplatesReady | Fires when the scheduler templates are initialized |
| onTimelineCreated | Fires after the Timeline view has been initialized, but is not rendered on the page yet (the Timeline view only) |
| onViewChange | Fires after the current view has been changed to some other one |
| onViewMoreClick | Fires when the user clicks on the 'View more' link in the Month view (the Month view only) |
| onXLE | Fires after loading data from the data source is complete |
| onXLS | Fires immediately before loading data from the data source has been started |
| onXScaleClick | Fires when the user makes a single click on a cell on the x-axis (the Timeline view only) |
| onXScaleDblClick | Fires when the user makes a double click on a cell on the x-axis (the Timeline view only) |
| onYScaleClick | Fires when the user makes a single click on a cell on the y-axis (the Timeline view only) |
| onYScaleDblClick | Fires when the user makes a double click on a cell on the y-axis (the Timeline view only) |
Scheduler templates
| Name | Description |
|---|---|
| agenda_date | Specifies the date in the header of the view |
| agenda_day | Specifies the content of the day cell of the Agenda view |
| agenda_text | Specifies the text in the second column of the Agenda view |
| agenda_time | Specifies the date in the first column of the Agenda view |
| api_date | Specifies the format of dates that are set by means of API methods. Used to parse incoming dates |
| calendar_date | Specifies the content of day-cells in the Mini-Calendar (date picker) |
| calendar_month | Specifies the date in the header of the Mini-Calendar (date picker) |
| calendar_scale_date | Specifies the format of week-days in the header of the Mini-Calendar (date picker) |
| calendar_time | Specifies the date format of the lightbox's start and end date inputs |
| day_date | Specifies the date in the header of the Day and Units views |
| day_scale_date | Specifies the date in the sub-header of the Day view |
| drag_marker_class | Specifies the CSS class that will be applied to the highlighted event's duration on the time scale |
| drag_marker_content | Specifies the content of the highlighted block on the time scale |
| event_bar_date | Specifies the date of an event. Applied to one-day events only |
| event_bar_text | Specifies the event's text. Applied to multi-day events only |
| event_class | Specifies the CSS class that will be applied to the event's container |
| event_date | Specifies the time part of the start and end dates of the event. Mostly used by other templates for presenting time periods |
| event_header | Specifies the event's header |
| event_text | Specifies the event's text |
| format_date | Сonverts date object to a date string. Used to send data back to the server |
| GRID_date | Specifies the date in the header of the view |
| GRID_full_date | Specifies the format of dates in columns with id='date' |
| GRID_single_date | Specifies the format of dates in columns with id='start_date' or id='end_date' |
| GRID_field | Specifies the text in the columns |
| hour_scale | Specifies the items of the Y-Axis |
| load_format | Specifies the format of requests in the dynamic loading mode |
| map_date | Specifies the date in the header of the view |
| map_info_content | Specifies the content of the info window in the Map View |
| map_text | Specifies the text in the second column of the view |
| map_time | Specifies the date in the first column of the view |
| month_date | Specifies the date in the header of the view |
| month_date_class | Specifies the CSS class that will be applied to a day cell |
| month_day | Specifies the format of the day in a cell |
| month_events_link | Specifies the presentation of the 'View more' link in a cell of the Month view |
| month_scale_date | Specifies the date format of the X-Axis of the view |
| parse_date | Converts date string into a Date object |
| quick_info_content | Specifies the content of the pop-up edit form |
| quick_info_date | Specifies the date of the pop-up edit form |
| quick_info_title | Specifies the title of the pop-up edit form |
| time_picker | Specifies the drop-down time selector in the lightbox |
| time_slot_class | Specifies the CSS class of the background cell in the Day/Week views |
| time_slot_text | Specifies the content of the background cell in the Day/Week views |
| tooltip_date_format | Specifies the format of start and end dates displayed in the tooltip |
| tooltip_text | Specifies the text of tooltips |
| week_agenda_date | Specifies the date in the header of the Week Agenda view |
| week_agenda_event_text | Specifies the event's text |
| week_agenda_scale_date | The date of a day cell of the view |
| week_date | Specifies the date in the header of the view |
| week_date_class | Specifies the CSS class that will be applied to a day cell |
| week_scale_date | Specifies the date in the sub-header of the view |
| year_date | Specifies the date in the header of the view |
| year_month | Specifies the month's name in the header of a month block of the view. |
| year_scale_date | Specifies the day's name in the sub-header of a month block of the view |
| year_tooltip | Specifies the tooltip over a day cell containing some scheduled event(s) |
| lightbox_header | Specifies the lightbox's header |
| TIMELINE_cell_value | Specifies the number of scheduled events in a cell of the view |
| TIMELINE_cell_class | Specifies the CSS class that will be applied to a cell of the view |
| TIMELINE_scalex_class | Specifies the name of a CSS class that will be applied to items of the X-Axis |
| TIMELINE_second_scalex_class | Specifies the name of a CSS class that will be applied to items of the second X-Axis |
| TIMELINE_scaley_class | Specifies the name of a CSS class that will be applied to items of the Y-Axis |
| TIMELINE_scale_label | Specifies items of the Y-Axis |
| TIMELINE_tooltip | Specifies the tooltip over a day cell containing some scheduled event(s) |
| TIMELINE_date | Specifies the date in the header of the view |
| TIMELINE_scale_date | Specifies items of the X-Axis |
| TIMELINE_second_scale_date | Specifies items of the second X-Axis |
| TIMELINE_row_class | Specifies the CSS class that will be applied to a row of the Timeline view |
| UNITS_date | Specifies the date in the header of the view |
| UNITS_scale_text | Specifies items of the X-Axis |
| xml_date | A string from an XML file is converted into a date object in conformity with this template |
| xml_format | A date object is converted into a string in conformity with this template. Used to send data back to the server |
Scheduler others
| Name | Description |
|---|---|
| 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.