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