Skip to main content

Properties overview

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